project-docs

プロジェクトドキュメント

このスキルは、ドキュメントの正確さ、簡潔さ、コードベースとの整合性を保つのに役立ちます。

ドキュメントに記載する内容

• ユーザー向けの動作変更
• 新しい CLI フラグ、環境変数、設定の変更
• プロトコル／API の変更、リクエスト／レスポンスの形式
• 運用上のガイダンス（トラブルシューティング、制限事項、安全なワークフロー）

ドキュメント更新のワークフロー

1. コードの変更と、ユーザーから見える影響を特定します。
2. 正式なドキュメント（README、ガイド、リファレンス）を見つけます。
3. 既存のスタイルに合わせ、変更を最小限に抑えてドキュメントを更新します。
4. 現在の CLI ヘルプ／コードと照らし合わせて、例を確認します。
5. 関連するテストを実行し、更新メモに記載します。

整合性チェック

• オプション名が実際の CLI フラグ（利用可能な場合は --help の出力）と一致していること。
• デフォルト値が正しく、一度だけ記載されていること（ドキュメント間での重複を避けます）。
• 例が実行可能で、プロジェクト固有の非公開パスに依存していないこと。
• 用語が README、ガイド、リファレンス全体で統一されていること。

サブエージェントの呼び出し（docs-excellence-architect）

Task ツールを使用して、ドキュメントに特化したレビューを専門のサブエージェントに委任します。

• subagent_type: docs-excellence-architect

以下を提示します。

• 変更するドキュメントファイル
• 反映が必要なコード変更
• 希望するドキュメント構成（各項目の配置場所）

プロンプトの例：

Review and update docs for the following changes:
- <change 1>
- <change 2>
Target files:
- README.md
- guides/*.md
- docs/*.md
Constraints:
- Minimal churn, match local style
- Ensure examples are accurate and consistent
Deliverables:
- Proposed edits (diff-style)
- A checklist of what was verified

メンテナンスガイドライン

• 具体例を含む短いセクションを優先します。
• 同じ定義を複数のファイルで繰り返さないようにします。
• ドキュメントがリファレンスになった場合は、正式な配置先を1か所にまとめ、そこへリンクします。