【結論】根拠付きで技術文書を執筆する
Claude CodeはREADME、技術ブログ、ADR、運用手順をコードとテストに基づいて執筆できます。
全ファイルを無差別に読ませず、根拠ファイル、読者、公開範囲、検証済みコマンドを指定します。
存在しない機能、性能値、費用効果、開発背景を推測で補わず、未確認事項として残します。
# ターミナルで実行:文書用ブランチを作成
git switch -c docs/article-draft
# ターミナルで実行:根拠ファイルを確認
git ls-files 'README*' 'docs/' 'package.json' 'tests/'
# ターミナルで実行:Planモードで起動
claude --permission-mode plan
# ターミナルで実行:文書差分を確認
git diff -- '*.md'具体的な手順・設定方法
対象読者、課題、根拠、検証環境、公開禁止情報を定義します。
構成案と各主張の根拠ファイルを先に提示させます。
執筆後にコマンド、リンク、Mermaid、コード例、バージョンを再検証します。
実践プロンプト / 活用テクニック
# 起動後のセッション内で入力
README、src/api、tests/apiだけを根拠に技術記事の構成案を作成してください。
実装背景、セットアップ、失敗例、テスト結果、制限を含めてください。
確認できない機能や性能値は書かず、まず構成案だけを返してください。注意点・よくあるエラーと対処法
社内URL、顧客名、APIキー、未公開機能を文書へ含めないでください。
他者の文章やコードを転載する場合は、ライセンスと引用条件を確認してください。
AI生成文をそのまま公開せず、実行結果と人間の経験で補正してください。