【結論】解決策 / 実行コマンド
Claude Codeは、リポジトリ内のコードやメモを読み、README、設計書、運用手順書などをファイルとして作成する用途にも適しています。
ただし、コードから推測した仕様を事実として断定させず、参照ファイルと不明点を明示させることが重要です。
# ターミナルで実行：文章作成専用ブランチを作成
git switch -c docs/update-readme
# ターミナルで実行：Claude Codeを起動
claude
# 起動後のセッション内で実行：まず計画モードへ切り替え
/plan具体的な手順・設定方法
入力資料を
notes/やdocs/へ整理し、正本となるファイルを指定します。対象読者、目的、文体、見出し構成、保存先、推測禁止事項をプロンプトへ含めます。
生成後は
git diff -- README.mdなどで差分を確認し、コードと一致しない説明を修正します。
実践プロンプト / 活用テクニック
# 起動後のセッション内で入力
README.mdを更新してください。
根拠はpackage.json、src/、docs/setup.mdだけに限定します。
対象読者は初めて参加する開発者です。
機能概要、必要環境、セットアップ、テスト、よくあるエラーの順で構成してください。
確認できない仕様は推測せず「要確認」と記載し、参照したファイルを末尾に列挙してください。注意点・よくあるエラーと対処法
長文を一度に生成すると途中で要約が粗くなるため、構成案、章ごとの下書き、全体校正へ分割してください。
ソースコードに秘密情報や顧客データが含まれる場合は、権限設定で読み取りを拒否してください。
生成文章は正確性、著作権、機密性、リンク切れを人間が確認してから公開してください。