プロンプト集に戻る

ドキュメントがコードと合っているか確かめる

ドキュメントの内容が、コードの実際の動作と違っている。

使う場面 ドキュメントをしばらく更新していないとき

完了すると得られるもの

根拠付きで優先度順に並べた、ドキュメントとのズレのレポート。

始める前に

  • コードとドキュメントが同じワークスペースにある

手順

  1. インストール、アーキテクチャ、設定、リリース、トラブルシューティングのドキュメントを選ぶ
  2. 各記述をコードやスクリプトに対応付ける
  3. 誤り、欠落、表現が古いだけのものを分ける
  4. ユーザーへの影響順に並べる

成果物

  • ズレのレポート
  • 根拠へのリンク
  • 修正計画

完了条件

  • 各結論がドキュメントと実装の両方を引用している
  • コードの動作を推測で埋めていない

Agent に渡すプロンプト

プロジェクトのドキュメントと実装を読み取り専用で照合してください。インストール、アーキテクチャ、公開されている動作、設定、デプロイ、トラブルシューティングを重点的に確認してください。差異ごとにドキュメントの場所と実装の根拠を引用し、影響を説明し、最小限の修正案を出してください。ファイルは編集しないでください。上記を出力したら止まり、ほかの作業には進まないでください。