ドキュメントブートストラップ
これは不定期に行う一括タスクです。この後の変更には engineering:documentation-sync を使用してください。
1. インベントリを取得する
存在するドキュメントを一覧表示し、それぞれを 存在、薄い（存在するがほとんど空か古い）、または 欠落 とマークします。少なくとも以下を確認してください:
README.md, CONTRIBUTING.md, CHANGELOG.md, ARCHITECTURE.md または docs/architecture/、決定記録、CLAUDE.md, SECURITY.md, LICENSE、APIリファレンス、設定リファレンス、ランブック。
git ls-files '*.md' | grep -v node_modules
2. ユーザーに選択させる
resources/doc-catalog.md のメニューを表示します。各タイプを存在、薄い、または欠落としてマークします。この種のプロジェクトに推奨するタイプをマークします。
- 存在するドキュメントは書き換えません。ユーザーは薄いものに対して「改訂」を選択できます。
- ユーザーが選択します。ユーザーが選択しなかったタイプは書きません。
3. ファクトシートを作成する
誰かが書き始める前に、複数のドキュメントで使用される事実を収集します。コードとgitから取得し、記憶からは取得しません。それらをスクラッチファイルに書き込みます。
| 事実 | ソース |
|---|---|
| プロジェクト名と一文の目的 | README、マニフェスト、ユーザー |
| 現在のバージョン | マニフェスト、最新タグ（git describe --tags --abbrev=0） |
| 言語、フレームワークとそのバージョン | マニフェストとロックファイル |
| インストール、テスト、リンター、ビルド、実行コマンド | engineering:development-commands |
| コンポーネントとその名前 | ディレクトリ構造、エントリポイント、Composeファイル |
| 環境変数と設定 | .env.example、および設定を読み取るコード（process.env、os.environ、getenv を検索） |
| 重要な日付 | 最初のコミット（git log --reverse）、タグ |
| 今日動作しているもの、動作していないもの | ユーザー、オープンなIssue |
2つのソースが矛盾する場合は、ユーザーに尋ねてください。黙って一方を選ばないでください。すべての執筆者はファクトシートとコードのみを使用します。
4. 執筆
- 3文書以下: 自分で順番に書きます。
- 4文書以上: 各文書または小さなグループに対して1つのサブエージェントを起動し、最大同時に4つとします。各サブエージェントに以下を渡します:
- それが担当する正確なファイルと、他のファイルを変更してはならないというルール;
- ファクトシート;
resources/doc-catalog.mdにあるそのタイプのセクション概要;- Simplified Technical English で書くという指示（
simple-englishスキルがインストールされている場合）; - 必要だが発見できなかった事実を、捏造する代わりに報告するという指示。
履歴、数値、ユーザー、機能を捏造しないでください。「TBD」と書き、それをユーザーにリストアップしてください。
5. セットをチェックする
resources/consistency-check.md に従ってください。続行する前にすべての問題を修正してください。
6. コミット
ドキュメントをブランチに配置し（engineering:git-branching）、PRを開きます（engineering:github-pr-merge）。PR本文に、新しい各ドキュメントと、ユーザーからの回答が必要な各「TBD」をリストアップしてください。
関連スキル
engineering:documentation-sync: この後、これらのドキュメントを正しく保ちます。gener8v:brownfield: 既存のコードベースを gener8v パイプラインにオンボーディングします。これは.gener8v/コンテキストを書き、これらのプロジェクトドキュメントは書きません。