プロジェクトREADMEの初稿作成

README作成プロンプトが必要な理由は、開発者が「自分のPCで動いている前提」で書いてしまうからです。すでにインストール済みのツール、作成済みの環境変数ファイル、起動済みのデータベースは意識から抜け落ちがちです。その結果、他の人がクローンして動かそうとすると、2つ目のコマンドでエラーになります。

文脈の指定によって、目線を強制的に相手側に合わせます。「今日初めてクローンして自分のPCで動かそうとしているエンジニア」「社内システムは知らない」と明確に制約をかけることで、AIは省略された手順を質問したり空欄として残したりするようになります。

形式で指定した小見出しの順番は、実際に人がリポジトリを開いたときの認知の順序です。何であるかを知り、画面イメージを見て、必要なものを揃え、インストールし、起動します。環境変数やトラブルシューティングを後ろに配置しているのは、初回起動時よりも2回目以降に必要となる情報だからです。各コマンドに説明を付けさせることで、内容を理解せずにコピー＆ペーストして実行してしまうリスクを減らせます。

最後の段落では、目次（構成案）を先に提示させてから本文に進むよう制御しています。一度に完成版を出力させると、見栄えだけのバッジや存在しない機能説明が混ざった長文が生成され、修正するよりも削除する方が手間になります。目次の段階で不要なセクションを削ってからブラッシュアップすることで、実際のリポジトリに即したドキュメントに仕上がります。

「不明な箇所は(要記入)として残す」という指示も重要な工夫です。空欄を許可しないと、AIはその部分をもっともらしい架空の記述で埋めてしまいます。空欄として可視化されることで、自分が何を追加で書くべきかが明確になり、嘘のないドキュメントを維持できます。

一見それらしいドキュメントが一発で生成されますが、半分は創作された内容になります。存在しないnpmスクリプト、使っていない環境変数、どこにもリンクしていないバッジやライセンスが勝手に追加されます。一方で、本当に必要な「ローカルデータベースの立ち上げ」といった実際の手順は、プロンプトで伝えていないため抜け落ちてしまいます。不要な部分を削除して修正する作業は、最初から書き直すよりも時間がかかります。