技術ドキュメントの下書きを作るには — Claudeへの任せ方
「あとで書く」と言われ続けたドキュメントを、実装メモから起こす。成果物は技術ドキュメントの下書き（概要・構成・使い方）。目安20分、使うものはローカルフォルダ、難易度はふつうです。
やり方（4ステップ）
- 1. 実装メモやコメントを渡す
実装時に書いたメモ、設計時のチャット履歴、コード内のコメントなどを渡します。散らかった一次情報のままで構いません。 - 2. 読者と目的を伝える
「他チームのエンジニアが初めて触るときに読むもの」など、読者と目的を伝えます。目的が違えば、書くべき前提知識の量が変わります。 - 3. 構成を先に決めさせる
「概要→前提条件→使い方→注意点」のような構成をまず提示させ、抜け漏れがないか確認してから本文を書かせます。 - 4. コード例は動作未検証と明記させる
ドキュメント内にコード例を含める場合、それが実際に動作確認されたものかどうか区別できるよう明記させます。最終的に開発者自身が動作確認する前提を崩さないためです。
そのまま使えるプロンプト
「この実装メモをもとに、他チームのエンジニア向け技術ドキュメントの下書きを作ってください。概要→前提条件→使い方→注意点の構成にし、専門用語は最小限の説明を添え、コード例を含める場合は動作未検証であることを明記してください。」
つまずきポイント
- コード例は必ず開発者自身が動作確認してから公開する
- 社内システムの内部構成など機密性のある情報の記載範囲を事前に決めておく
まずは無料で試す
このレシピはブラウザ上の仮想デスクトップで実際に体験できます。