MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/d6d7ff2e2f9c

MDN の文書に関連して行われる、意味をなす規模での貢献の大部分は、いかにMDN コミュニティの一員として作業するかを知ることだといえます。この記事ではあなたが行う他の文書作成者、開発チームとのやりとりの多くで役に立つコツを紹介します。

一般的なエチケットのガイドライン

Mozilla コミュニティで作業する際の品行に関する、一般的なガイドラインを紹介します。

  • 礼儀正しく! 意見が衝突する場面でも、私たちは同じ使命を持っているのです: ウェブをより良いものにすること。
  • 頼むこと、要求するのではなく。要求するのではなく丁寧に支援を依頼すると、人々が助けてくれたり反応してくれたりする可能性がはるかに高まります。文書化の作業は重要であり、また開発コミュニティもそれを理解していますが、敬意を払わずにチームを扱うと、人間の本能として人々は不快で気難しい状態になる傾向があります。
  • 文書化の緊急性の情報の必要性と、議論の参加者があなたを助けるために費やさなければならない時間の情報の必要性のバランスをとってください。必ずしもすぐに必要ないのであれば、会話に参加するほかの人たちを熱中させるほど詳しく押し通してはいけません。
  • あなたの要望によって接触した人々から貴重な時間をとることを意識して、時間を有効活用するようにしてください。
  • 文化の違いに配慮してください。Mozilla は多国籍かつ多文化なチームでですので、あなたとは文化が異なる (と思われる) 人と対話するときは、コミュニケーション中にそのことを意識するようにしてください。
  • 既存の会話を乗っ取るのではなく、新しい会話を始めてください。あなたが話す必要がある人々がそれに留意していても、無関係の会話に質問を挟み込まないでください。あなたには便利でも、あなたが話そうとしている人々を怒らせてしまい、理想に満たない結果になってしまうかもしれません
  • bikeshedding 【訳注: パーキンソンの凡俗法則】 を避けてください。あなたの熱意が、いらだたせる学者まがいの行動にならないようにしてください。会話が厄介ではっきりした目的がないものになります。

機転を利かせること

他者とのコミュニケーションでは、常に機転を利かせて敬意を表してください。

礼儀正しくミスを指摘する

誰かに連絡を取る目的が、その人たちに何か別のことをするように頼むことである場合、あるいはその人たちが行った誤り (特に、何度も行っている場合) を指摘することである場合は、メッセージを肯定的なコメントで始めてください。これはいわば打撃を和らげて、相手を悪者扱いするのではなく助けようとしていることを示します。

例えば新しい貢献者がタグをつけずに多くのページを作成しており、あなたがその問題を指摘したい場合は、相手へのメッセージを以下のようにするとよいでしょう (それぞれのケースで変更しなければならない箇所に下線をつけています):

Hi, MrBigglesworth, I've been noticing your contributions to the Wormhole API documentation, and it's fantastic to have your help! I particularly like the way you balanced your level of detail with readability. That said, though, you could make these articles even better and more helpful if you added the correct tags to the pages as you go.

See the MDN tagging guide (https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Tag) for details.

Thanks again, and I look forward to your future contributions!

知識を共有する

MDN プロジェクトに参加していると、何が行われているかや、コミュニティの他のメンバーが何に関わっているかを知ると役に立ちます。コミュニティ内で他者と対話することで、アイデア、更新状況などを得る (そして共有する) ことができます。また、誰が何を行ったかを知るのに役立つツールや情報リソースもあります。

対話の経路

コミュニティのメンバー (開発者と文書作成者のどちらも) と交流できる手段がいくつかあり、それぞれに固有のエチケットに関する決まりがいくらかあります。

IRC

これは多くの場合、もっとも早くかつ直接的に誰かへ連絡する手段です。IRC でメッセージを送ってください。あなたが記述するトピック領域に関連するチャンネルを見つけて、メンバーと話してください。IRC 特有のエチケットや TIPS について、Mozilla Support の記事 "Getting Started with IRC" をご覧ください。開発者向けドキュメントに関する議論は、#mdn チャンネルを使用します。

Bugzilla

Bugzilla のバグの結果として実装された変更点を扱う文書を作成するとき、そのバグに関係する人々と交流することになるでしょう。Bugzilla Etiquette ガイドを常に念頭に置くようにしましょう!

Email

電子メールアドレスを持っている場合は、他の人々とプライベートなメール交換をすることもあります。

注記: 一般的に、あなたが文書化している技術に関する文書に誰かが電子メールアドレスを投稿した場合、個人的に電子メールアドレスを示された場合、あるいは広く知られた電子メールである場合は、受け入れ可能な "最初の連絡手段" が電子メールになります。あなたがそれを探し出さなければならない場合は、他に試みる連絡手段がまったくない場合を除いて、始めに IRC やメーリングリストを使用する許可を得ることを試みましょう。

コンテンツの状態を示すツール

文書化の状態に関する情報を提供する、役に立つツールがいくつかあります。

リビジョンダッシュボード
リビジョンダッシュボードは、MDN のコンテンツの変更点を確認するためのすばらしいツールです。最近の履歴を見る、確認する期間を選択する、あるいはロケールや貢献者名やトピックでフィルタリングすることができます。リビジョンのセットを見ると、それぞれのリビジョンの変更点を調べる、ページをすばやく開く、全体の履歴を調べる、あるいは変更を取り消す (権限がある場合) ことができます。
文書化状態の概観
文書化状態の概観 ページは、状態を追跡するために設定された MDN の全領域のリストを、そこにさまざまな作業が必要なページがいくつあるかという情報とともに提供します。特定のトピック領域をクリックすると、タグがないページや特定の作業が必要であることを示すタグがついたページなど、作業が必要なコンテンツの詳しい一覧を確認できます。また、長期間更新されていないページや陳腐化したと思われるページ、その領域の文書に影響があると位置づけられているバグの一覧を見ることもできます。
文書化プロジェクトの計画
私たちは計画段階の、あるいは大規模で進行中の文書作成プロジェクトをいくつか抱えており、何を行う必要があるかを追跡し続けることを支援する計画文書を作成しました。
MDN Taiga
MDN のスタッフである執筆者は、現在および将来の文書化プロジェクトを管理するために Taiga と呼ばれるツールを使用します。私たちが何をしており、またどのように進めているかを見ることができます。さらに、すぐに起こしたプロジェクトが何であるかを見ることもできます。それらのいくつかはスタッフの執筆者が引き受けますが、希望であればあなたが引き受けることも自由です! MDN チームが従っているアジャイルプロセスについて、詳しくは Mozilla wiki のプロセスのページ をご覧ください。

開発コミュニティ

MDN 文書作成コミュニティのメンバーとして、開発者と管理者の関係でもっとも重要であると思われることは、開発者とともに開発および維持することです。開発者は私たちが開発するソフトウェアを作成しますが、もっとも役に立つ情報源でもあります。開発者とよい関係を維持することはとても重要です。彼らに好かれていれば、質問に早く、正確に、また徹底的に答える可能性が高まります!

また、あなたは MDN の文書作成コミュニティを代表しています。文書作成チームとのすべての交流を良好にすることで、開発チームとのすばらしい作業場の関係を維持するようにしてください。

関連して、適切な話し相手を見つけるための手段が、モジュールオーナーの一覧 を見ることです。

文書作成者たちのコミュニティ

文書作成やのコミュニティは大規模です。きわめて頻繁に、あるいは大規模に貢献する方は比較的少数ですが、ときどき貢献する人々は数十人から数百人います。幸い、この方々は全体的にウェブ、Mozilla、文書化が純粋に好きなすばらしい人たちであり、交流することはほぼ容易です。

MDN コミュニティについて詳しくは、MDN コミュニティに参加する の記事をご覧ください。

他の執筆者ともっとも頻繁に直接交流できる場所が、IRC の #mdn チャンネルです。このチャンネルは特に、文書化について議論するために予約されています。IRC 特有のエチケットや TIPS について、Mozilla Support の記事 "Getting Started with IRC" をご覧ください。また、MDN ディスカッションフォーラム でも議論できます。通常、IRC はすばやい議論や直接会う形に近い議論のために使用する傾向があり、一方ディスカッションフォーラムは長期に渡る会話のために使用することが一般的です。

一般的なエチケットのガイドライン を覚えておくことで、たいていの物事がとてもスムーズに進むことがわかるでしょう。

関連項目

ドキュメントのタグと貢献者

 このページの貢献者: yyss, hamasaki
 最終更新者: yyss,