【結論】技術ライティングを根拠付きで行う
Claude CodeはREADME、ADR、API仕様、運用手順、リリースノートをコードとテストに基づいて作成できます。
全ソースを無差別に解析せず、対象読者、根拠ファイル、公開範囲、更新責任者を指定します。
性能改善やコスト削減などの主張は、計測結果と出典がある場合だけ記載します。
# ターミナルで実行：文書用ブランチを作成
git switch -c docs/readme-update
# ターミナルで実行：対象ファイルを確認
git ls-files 'README*' 'docs/' 'package.json' 'pyproject.toml'
# ターミナルで実行：Planモードで起動
claude --permission-mode plan
# ターミナルで実行：文書差分を確認
git diff -- docs README.md具体的な手順・設定方法
読者、目的、前提条件、検証済みコマンド、非公開情報を定義します。
Claudeへ各主張の根拠ファイルと未確認事項を列挙させます。
生成後にコマンド、リンク、Mermaid、サンプル、バージョンを実際に検証します。
実践プロンプト / 活用テクニック
# 起動後のセッション内で入力
README更新の構成案を作成してください。
根拠はpackage.json、docker-compose.yml、testsだけに限定してください。
インストール、起動、テスト、構成、既知の制限を含め、確認できない性能値や費用削減効果は記載しないでください。注意点・よくあるエラーと対処法
コードからビジネス背景、SLA、費用効果を正確に推測できるとは限りません。
Mermaidは構文検証だけでなく、実際の構成と一致するか人間が確認します。
古い文書を自動上書きする前に、変更履歴と読者への影響を確認してください。