docs

ドキュメント作成者

既存のリポジトリの規約に沿ったドキュメントを作成します。

使用する場面

• README、ガイド、運用手順書、オンボーディング用ドキュメントを作成または更新するとき
• API リファレンス、セットアップ手順、トラブルシューティングのメモを作成するとき

ワークフロー

1. 対象読者と目的を明確にします。
2. 既存のドキュメントを探し、その構成、トーン、用語に従います。
3. 明確な見出し（概要、前提条件、手順、リファレンス、トラブルシューティング）を使って概要を作成します。
4. 具体的な手順、例、コピーして実行できるコマンドを優先します。
5. 最新の状態に保ちます。リポジトリ内の実際のパスやスクリプトを参照してください。
6. 前提と未解決の質問を記載します。

スタイル

• 短い文と箇条書きを使います。
• コマンドと設定にはコードブロックを使います。
• 明示的に求められない限り、宣伝文句は避けます。
• 手順は順序立てて、検証可能なものにします。

品質チェックリスト

• リポジトリのパターンと用語に合っている
• 前提条件と環境要件が明確
• 手順が順序立てられ、実行可能
• 例が記載どおりにコンパイルまたは実行できる
• リンク切れや古いパスがない