ガイドライン
もしあなたがこのマニュアルに対して貢献したいのなら、現在、働きかける事ができる幾つかのタスクがあります：
- HTMLコードを清書してください。
- 失われたドキュメントを発見、及び作成してください。
- 不安定もしくは推奨されないmachineについてのドキュメントは除去してください。
- 取り去られたmachineについての記録を行なってください。
- それぞれのマシンのために、共通のドキュメント構造があるようにすべてのテキストを再編成してください。
ドキュメンテーションのためのガイドライン
ほとんど全てのドキュメントは違って見えるでしょうが、しかし私たちは首尾一貫したユーザーエクスペリエンスを望んでいます。既に存在するドキュメントを翻案する場合、どうかこれらのガイドラインの一貫性を守ってください。
- <font>タグを使わず、また不必要なスタイリングを行なわず、基本的なタグ（p,b,i,u,a,img,等）を注意と共に使ってください。
- HTMLは閉じることができるタグによって書いてください。（例えば、<li>このような</li>、またはシングルタグの為にはこのように：<hr />
- h1、h2などを、見出しのために使ってください。
典型的な見出し：h1 =Machineの名前、
h2 =説明、そのものについて、機能、パラメーター、コンタクトなど
h3 =小さな見出し
- 必ず全てのパラメーターの一覧表をテーブル上に作ってください、もしくは・・・
- あなたのテーブルは普通でないか、一様の列の分類を除いて体裁を整えないで下さい。
- あなたが使うことができるスタイルシートをチェックしてください。他に適切なスタイルがない場合を除いて、新しいスタイルは付け加えないで下さい。
- もしあなたが貧弱な英語の例を見つけた場合、それを思うように正してください。
- HTML、ヘッド、タイトル、メタ、およびボディタグを置いてください、それか、いつもh1タグでマシン名を囲むことから始めてください。スクリプトは自動的にヘッダー、フッター、およびメタデータを挿入するでしょう。
- 首尾一貫して下さい！ ・・・既に存在するドキュメントの範囲内なら、あなたは新しい事を付け加えてください。
このガイドラインについて
- machineのアーカイブから展開されたヘルプファイルは、改名するか妥当なHTMLに変換してください。
- 全てのヘルプファイル（またはそうだろうものは）ガイドラインに合うように改めてください。
- ヘルプファイルはGenerator/<ファイルネーム>.htmlか、Effects/<ファイルネーム>.htmlのようにmachineのDLL名と同じようなフォーマットに従って名前を付けてください。
最終更新：2008年10月19日 01:41
