Diosix のドキュメント作成
docs/ および README.md のすべてのドキュメントページは、
hypervisor/、tools/、scripts/ の実装と 100% 同期し、
docs/style-guide.md に準拠しなければなりません。これにより、
ドキュメントが初回パスで reviewing-diosix に合格します。
中核となる義務
- 明確で正確な英語の散文 (基本要件): すべてのドキュメントは アメリカ英語で記述され、スペルチェック済みで、文法が正確であり、 技術的な明瞭性や正確性を損なわない簡潔な表現を使用しなければなりません。
- ドキュメントの真実性:
docs/に、古い CLI フラグ、SBI 関数 ID、 ioctl 番号、C 構造体レイアウト（uint64_tとunsigned longの違い）、 ファイルパス、または設定キーを残してはいけません。動作、CLI オプション、 モジュールファイルパス、または設定スキーマを変更するすべてのコード変更は、 同じ変更内でdocs/を更新しなければなりません。 - 二重対象読者設計: 明確に二つの異なる対象読者に合わせて設計します:
- ユーザー（初心者とエキスパート）: Diosix を起動し、ガイドツアーを
実行し、
dsxでゲスト VM を起動し、宣言型システム/チャーターマニフェスト を設定するオペレーター。 - 開発者とメンテナー: M モードハイパーバイザー、S モード
dynarec、 U モードツールを構築、テスト、デバッグ、拡張するエンジニア。
- ユーザー（初心者とエキスパート）: Diosix を起動し、ガイドツアーを
実行し、
- 厳格なスタイル準拠 (
docs/style-guide.md):- 散文、リスト項目、コードブロックは 1行あたり 80 文字以下 で折り返します
（マークダウンテーブルの行と長い URL は除く）。マークダウンリンクテキスト
にはファイルベース名を使用します
（
[S50dropbear](../tools/.../S50dropbear)）。これにより、リンク行が 80 列以内で適切に折り返されます。 - 能動態 と 現在形 を使用します （「ハイパーバイザーは GPA を検証します」とし、「GPA はハイパーバイザー によって検証されます」としてはなりません）。
- 見出しには 文頭のみ大文字 を使用します
（
## 階層型ゲストモデルとし、## 階層型ゲストモデルとしてはなりません）。 - 略語は 各ページで最初に使用するときに 完全な形で書き出します
（
Supervisor Binary Interface (SBI)）、その後は略語のみ使用します （SBI）。 - 番号付きリストは 厳密に 連続した複数ステップの手順にのみ使用し、 箇条書きは連続性のない項目に使用します。
- 散文、リスト項目、コードブロックは 1行あたり 80 文字以下 で折り返します
（マークダウンテーブルの行と長い URL は除く）。マークダウンリンクテキスト
にはファイルベース名を使用します
（
- 不明な場合は停止し、リードメンテナーに確認する: 意図された動作、 用語、または対象読者の範囲が不明瞭な場合は、推測したり詳細を捏造したり せずに、リードメンテナーに確認してください。
関連リファレンスガイド
ドキュメントを作成または編集する前に、関連するリファレンスファイルを 読んでください。
- スタイルと正規用語:
英文法/スペル基準、80 カラム折り返し、略語展開ルール、および正規の
ハードウェア/仮想化定義
（
ホストビルドマシン、ホストハードウェア、ターゲットプラットフォーム、HPA、GPA、GVA、CID）。 - 二重対象読者とドキュメントマップ:
初心者/エキスパートユーザーとメンテナー向けにコンテンツを調整する方法、
コード変更を特定の
docs/*.mdファイルにマッピングする方法、 テスト規約の文書化について。