現在必要なドキュメントに貢献する方法

この記事は翻訳作業中です。

MDN に協力することに興味があり、新しいコンテンツを書くためのトピックを探しているのであれば、この記事を参考になるでしょう。これはどちらかというとオープンエンドなプロセスで、いくつかの段階があります。

  1. 必要とされているトピックや興味のあるトピックを見つける
  2. MDN のライターに話をして、そのトピックに興味があることを知らせる。トピックに取り組むために彼らの承認は必要ありませんが、関連するトピックに取り組んでいる他の人たちと調整するのは良い考えです。
  3. 必要に応じて、技術的な内容を教えてくれる技術的な専門家と連絡を取りましょう
  4. 記事を執筆する
  5. 技術レビューを依頼する
  6. 編集レビューを依頼する

これらのフェーズの中には反復的なものもあります。例えば、あるトピックについて1つ以上の記事を書いたりレビューしたりする過程の様々なポイントで、 MDN のスタッフライターや技術専門家と何度か会話をすることがあります。

トピックを見つける

取り組むべきトピックが見つけられる場所はいくつかあります。

文書化リクエスト

誰かが MDN 上で文書の新規作成または更新のリクエストを提出すると、スタッフチームはそれを確認し、その作業が新規投稿者が行うのに適しているかどうかを判断し、支援のためのメンターを割り当てます。これらの要求の 1 つを見つけて追求する方法の詳細については、メンターによるドキュメント要求を解決する方法を参照してください。

優先度の高い文書トピック

The MDN staff writers organize their work in agile sprints. You can view the team's Kanban board to see the user stories that are currently prioritized. The items in the Ready column are fully fleshed out with tasks and acceptance criteria. The items in the New column are less fleshed-out, but are still considered important in the near future. If you're interested in contributing to any of these items, see the Talk to MDN writers section to start a conversation about it.

dev-doc-needed bugs

Some Mozilla code changes are flagged in Bugzilla as needing developer documentation, using the "dev-doc-needed" keyword. These issues are usually specific to Mozilla product code, and require some familiarity with the codebase to address. See How to resolve a dev-doc-needed bug for details.

MDN 執筆者と話す

The main channel for discussion of MDN content is the MDN discussion forum. Even if you know the name of an individual who is concerned with the topic you're interested in, it's a good idea to post any discussions on the forum, so that they can be shared by the rest of the community. If you don't know the name of an individual to ask, posting an inquiry on the forum is a good way to find out who to talk to.

If you're working on a mentored documentation request, you can interact with the mentor via comments in the bug record; in this case, Bugzilla is the preferred communication channel, so that all activity around the request is captured in one place.

テクニカルエキスパートと話す

In order to start documenting a topic, you may need to find some technical experts on that topic. (If you are a technical expert on the topic you're documenting, either this step does not apply, or you probably already know who else to talk to.) As part of your conversations with other MDN writers, be sure to ask for pointers or introductions to technical experts.

When approaching technical experts for information, try to make it easy and efficient for them to help you. Ask if there is existing information in Bugzilla records, mailing list archives, standards specifications, test cases, and so on, if you weren't able to get these leads from MDN writers. After you have done your best to make sense of the existing information, bring specific questions to the expert. Questions like "The spec talks about X, but doesn't seem to address Y" are easier for an expert to respond to than "I'm documenting the FooBar API. Can you tell me about it?"

記事を書く

記事を作成する仕組みについては、ページを作成および編集する方法をご覧ください。 記事の種類によってはより具体的なガイダンスを提供する場合があります:

技術的レビューを依頼する

If you haven't found a technical expert yet (or even if you have), see How to recruit a technical reviewer.

Be sure that the Technical review flag is ticked. In the MDN Editor UI, it appears near the bottom under Review needed?

編集レビューを依頼する

You can ask for an editorial review by posting on the MDN discussion forum. Be sure that the Editorial review flag is ticked. In the MDN Editor UI, it appears near the bottom under Review needed?