ドキュメンテーションを寄与します。

自由なマニュアルの基準は、フリー・ソフトに関してはかなり同じです:それはユーザすべてにある自由を与える問題です。 再配送(商用再配送を含んで)は許されるに違いない、その結果、マニュアルは、プログラムのすべてのコピーに伴うことができます、オン・ライン、あるいは紙上で。 修正のための許可はまた重大です。

ドキュメント調査プロセス

寄稿家がドキュメントを加えることができ、仲間評価を得ることができ、組織することができ、ドキュメントを維持することができるところで、私たちは、ドキュメンテーション用のフレームワークを作成したい。 何人かの寄稿家は第1にそれらが働くコードをドキュメント化している開発者になるでしょう。 他のものは第1に文筆家になるでしょう。 私たちは、これらの人々をともに働くとすることを望みます。 あなたのinitalなドキュメントが粗野な場合、技術的な詳細に書き入れるかあるいは、言語を磨くヘルプを求めます。

私たちは、さらにドキュメント・ステータスの跡を追いたい。 ドキュメントは完全ですか。それとも、それは、書き入れられたいくつかの穴を必要としますか。 それはありますか、完成する、しかし編集を必要として? それは終了されまた、つやが出ましたか。 その部分をコードの変化のために更新する必要がありますか。 それが記述するコードが退かせられたので、ドキュメントが退かせられるべきですか。

調査プロセスを促進するために、私たちは Bugzilla の中でドキュメンテーション製品を作成しました。 ドキュメントに関する問題の跡を追い、かつレビューのための新しいドキュメントを提出するためにこれを使用してください。 Bugzillaは私たちのドキュメンテーションを3つのカテゴリーに分類します。

1. Mozilla開発者-これらのドキュメントは、mozillaをコンパイルする人々に恐らく単に役立ちます。 javadocを備えたドキュメント化するAPIおよび LXRがLXRを作るべきコメントするMozilla (Commenting Mozilla)と同様に 完全なnsCOMPtrユーザマニュアル (User's Manual)もが、そのファイル・リスト中の記述を印刷するように、それは、コード・モジュール用のユーザ・マニュアルを含んでいます。 私たちは、特に初めてのMozillaハッカーのためのコードの鳥瞰的な概観を必要とします。

2. ウェブ・ディベロッパー(Web Developers)-このカテゴリーは他の2つのカテゴリーをオーバーラップさせるが、アプリケーション開発プラットフォームとしてMozillaを使用する創造者、ウェブ・サイト管理者、システム管理者および人々を満足させるのに有用な情報を一般に含んでいるべきです。 たとえMozilla開発者によって必要でもそれが他のものにとって同様に有用なので、XULドキュメンテーションはここに行きます。

3. ユーザ-Mozillaから到達可能なドキュメンテーションはヘルプ・メニューです。

含まれていること

ここに、支援するいくつかの方法があります。

• Mozillaの一部がどう働くか考えようとして、いつかちょうど費やしたならば、あなたが解いたものを書き留めてください。 他のものは恐らく行ったのと同じ疑問を持つでしょう。 それは装飾的である必要がありません。 ニュースグループへのあなたの発見物を記入して、あるフィードバックを得てください。 誰かがしていない場合、既に前に来る、ドキュメンテーション・ニュースグループへのポスト、また尋ねる、のために、htmlifyingしつやが出ることを支援します。
• コードを寄付する場合、それをドキュメント化してください。 完全に磨き上げた何かを生成する時間がなくても、為替手形を提出して、それを磨くことを支援するためにドキュメンテーション・ニュースグループ中のボランティアを捜してください。
• ヘルプ(ドキュメンテーション・ニュースグループへのポスト)を得ること。 誰もすぐに支援することを申し出ない場合、ドキュメンテーション増強を作成する、bugzillaおよびマークの中で要求する、それ、HELP WANTED。
• 賢明な忠告を求めてニュースグループを探索してください。 時々、既存のドキュメントあるいは 専門用語リスト に加えられるべき説明を見つけるかもしれません。 同じ質問が繰り返して尋ねられることに気づいていれば、 FAQ にそれらを加算してください。 しばしば、人々が記入しましたが、ウェブ・サイトへの彼らの道を作らなかった為替手形を見つけるでしょう。 著者が任命を磨き、ウェブ・サイトへそれを中へチェックするのを助けることを申し出てください。
• ドキュメンテーション・バグ用の探索Bugzilla(Search Bugzilla)は、ステータス・ホワイトボード(Status Whiteboard)分野でのHELP WANTEDをマークしました。

スタイル・ガイド

私たちのサイトのための内容の作成上でガイダンスのために私たちの スタイル・ガイド (Style Guide)を使用してください。 私たちのゴールはブラウザーの広い種類、古く不完全なものさえで働く内容を作成することです。 私たちは、私たちのウェブ・サイトを読むために人々がMozillaを使用していると仮定することができません。 実際、それらがまだMozillaを使用することができないので、多くの人々は私たちのサイトを正確に読みます。 あなたのドキュメントのフォーマットを維持する、可能なものとしてバニラとして。 Mozillaのwhizzy特徴を例証するデモ・ファイルを自由に書いてください。ただし、あなたのドキュメントの主要な内容が皆によって判読可能であることを確かめてください。 特にPNGの代わりにGIFイメージを使用してください。 XMLではなくHTMLを使用してください。 多くのハッカーがジャバスクリプトを切っておくので、デモを除いてジャバスクリプトの使用を要求しないでください。

ドキュメント中でチェックすること

私たちは著作権のある政策を研究しています。 私たちは、恐らく オープン出版ライセンス (Open Publication Licence)あるいは全面的な再生および分配特権(ある条件に従う)を拡張する間に、著者が自分の著作権を保持する Linuxドキュメンテーション・プロジェクト (Linux Documentation Project)のように、情報共有を促進する著作権のある政策を設立することを今後望みます。 私たちはこの問題に関するあなたの見解を聞くことに興味を持っています。 私たちの ドキュメンテーション ・ニュースグループにそれらを記入してください。

私たちは、ウェブ・サイト上のドキュメントを管理し、かつソース木に関してドキュメント木へのアクセスを与えるために同じメカニズムを使用するためにCVSを使用します。 現在のドキュメントに変更を提出していれば、匿名のcvsによってドキュメントをチェックしてください。 (まだセット・アップされていなかった。 バグ 20962 を参照してください。)パッチ・ファイルを作り、かつドキュメントの所有者にファイルを提出するためにcvs違い-uを使用してください。 ドキュメントがその所有者をリストしない場合、誰が最近ページを更新したか確かめて、かつそれらに尋ねる、ページの底の最後の修正済の(Last Modified)リンクをクリックしてください。 他のすべてが失敗する場合、 ウェブマスター@mozilla.org を郵送してください。

ソース・コードでのように、よい仕事の実績を確立する場合、その後、特にドキュメントを寄付し、彼らの公式所有者および保持者になれば、容器へのアクセスを与えられるかもしれません。 アクセスするために、 CVS寄稿家形式 (CVS Contributor Form)を提出する必要があるでしょう。 私たちの医者木に特有のCVS情報のために mozilla.orgコンテンツおよびCVS を読んでください。 CVSによるドキュメント・ソース・コード は、あなたのプラットフォーム用にどこでCVSクライアントを得るべきであるか説明し、CVSドキュメンテーションに対してポインターを持っています。