【結論】解決策 / 実行コマンド
Claude CodeはREADME、設計書、ADR、API仕様、変更履歴などのMarkdownを生成・更新できます。
コードから文書を作る場合は、推測と確認済み事実を分け、参照ファイルを明記させます。
Mermaid図やコマンド例はレンダリングと実行で検証します。
# ターミナルで実行：既存ドキュメントを確認
find . -maxdepth 2 -name '*.md' -print
# ターミナルで実行：Planモードで起動
claude --permission-mode plan
# ターミナルで実行：生成後のMarkdownをLint
npx markdownlint-cli2 '/*.md'具体的な手順・設定方法
READMEの対象読者、目的、必要な章を決めます。
package.json、CI、設定ファイルから実在するコマンドだけを抽出させます。
生成後にリンク、コードブロック、見出し階層、Mermaidを確認します。
実践プロンプト / 活用テクニック
# 起動後のセッション内で入力
README.mdを更新してください。
対象読者は初参加の開発者です。
実在するセットアップ、テスト、Lintコマンドだけを記載し、参照したファイルを末尾に列挙してください。
推測が必要な項目は未確認として残してください。注意点・よくあるエラーと対処法
コード全体を無差別に読み込ませず、文書化対象を限定してください。
API例に秘密情報や実データを含めないでください。
生成文書はコード変更後に古くなるため、CIやレビューで更新漏れを確認してください。