【結論】根拠付きWikiを作成する
Claude CodeはREADME、GitHub Wiki、社内Runbookをコードとテストに基づいて作成できます。
全リポジトリを無差別に解析せず、根拠ファイル、読者、公開範囲、更新責任者を指定します。
Git履歴から障害原因を推測する場合は、確認できるIssue、テスト、ログと照合します。
# ターミナルで実行:Wiki用worktreeを作成
git worktree add ../wiki-draft -b docs/wiki
# ターミナルで実行:根拠ファイルを確認
git ls-files 'README*' 'docs/' 'package.json' 'tests/'
# ターミナルで実行:Planモードで開始
claude --permission-mode plan
# ターミナルで実行:Markdown差分を確認
git diff -- '*.md'具体的な手順・設定方法
読者、目的、根拠、公開禁止情報、更新頻度を定義します。
各見出しの根拠ファイルと未確認事項を先に列挙させます。
生成後にコマンド、リンク、Mermaid、コード例を実行・表示確認します。
実践プロンプト / 活用テクニック
# 起動後のセッション内で入力
README、docs、package.json、testsだけを根拠にWiki構成案を作成してください。
セットアップ、構成、運用、FAQ、既知の制限を含めてください。
確認できない障害原因や性能値は書かず、まだファイルを作成しないでください。注意点・よくあるエラーと対処法
コミット履歴だけから障害や意思決定を正確に復元できるとは限りません。
社内URL、顧客名、Secrets、個人情報をWikiへ含めないでください。
Mermaidは構文だけでなく実際の構成との一致を人間が確認します。