repo-doku

Repo-Doku：ソースリポジトリでドキュメントを作成する

目的

このスキルは、ドキュメントをソースリポジトリ内に直接作成または更新します。ドキュメントは信頼できる唯一の情報源となり、後続のドキュメントシステム（ドキュメントポータル、ウェブサイト）で利用できます。 README.mdに記述し、大規模なプロジェクトではさらにDEVELOPMENT.mdにも記述します。

• 出力はリポジトリ内に残します：常にREADME.mdを更新し、大規模なプロジェクトの場合のみDEVELOPMENT.mdも更新します。
• 自動コミットはしません：自動でコミットやプッシュを行うことはありません。Conventional Commitの提案のみ行います。

ワークフロー

1. ドキュメントの対象を決める

• プロジェクトの種類と規模を見積もります（ライブラリ／クライアント、大規模アプリケーション、CLIなど）。
• ドキュメントの対象を決めます：README.mdのみ、またはREADME.mdとDEVELOPMENT.md。
• → 詳細はreferences/doku-ziel.mdを参照してください。

2. 最新のドキュメントの状態を確認する（Git）

最後にドキュメント化された箇所を特定し、未記載の部分だけを補います：

git log -1 --format='%H %ci' -- README.md   # letzte Änderung am README
git log --oneline <letzter-stand>..HEAD      # Commits seitdem

• Conventional Commitsを種類別に分類します（feat、fix、BREAKING CHANGEなど）。
• feat／BREAKING CHANGEはドキュメントに関係しますが、chore／ci／testのみの変更は通常関係しません。

3. 情報源を集める（次の順序で）

1. 既存のドキュメント（README.md、必要に応じてDEVELOPMENT.md）を土台にします。ゼロから書き直すのではなく、既存の内容を更新します。
2. 変更履歴ファイルを新機能の構造化された情報源として使います（リポジトリ内の正確な表記に注意します。例：Changelog.mdとCHANGELOG.md）。
3. Gitコミットで、最新のドキュメントの状態（手順2）以降のうち、変更履歴に記載されていない変更を確認します。
4. ソースコードで詳細を確認します：公開API、オプション、シグネチャ、現実的な例。

4. ドキュメントを作成／更新する

• 規約に従います → references/konventionen.md （言語、コード／コメントの言語、変更履歴、図、プロジェクト固有のルール）。
• 変更は最小限にします：新しいコミットや機能に関係する箇所のみ追加または修正します。
• 実際のコードをもとに例を作成し、存在しないAPIを作り出さないでください。

5. 完了

ドキュメントを変更した場合：

• プロジェクトで通常行っている場合は、タスクリスト（例：todos/<thema>/todo.md）で作業を追跡します。
• Conventional Commitを提案します（例：docs: README um Feature X ergänzen）。ただし、コミットは行いません。
• 変更内容を簡潔にまとめます。

「差分なし」も有効な結論です。 評価の結果、既存のドキュメントがすでに最新かつ完全である場合（例：最新のドキュメントの状態以降の変更が、内部的なバグ修正／テスト／リリースのみの場合）は、無理に変更を加えないでください。内容を捏造せず、タスクリストも作成せず、コミットも提案しません。代わりに、確認した情報源と判断結果を簡潔に報告します。必要に応じて、ユーザーの判断に委ねる個別の境界事例も含めます。

参考資料

• references/doku-ziel.md — ドキュメントの対象を選ぶ（READMEとREADME+DEVELOPMENT）、範囲、および含める内容／含めない内容。
• references/konventionen.md — 執筆、変更履歴、図に関するルール、およびプロジェクト固有の規約。