APIドキュメントのプロンプトテンプレート

コーディングの依頼だけを伝えても、当たり障りのない回答しか返ってきません。言語・制約・欲しい詳細度を指定することで、曖昧な返答が実際に使えるものに変わります。

変換前（雑なプロンプト）

自分のAPIのドキュメントを書いて

初めて連携する開発者が必要とする粒度でAPIドキュメントを書くテクニカルライターとして振る舞ってください。

自分のAPIのドキュメントを、各エンドポイントの目的・パラメータ・現実的なリクエスト/レスポンス例を含めて書いてください。

エンドポイントやスキーマが与えられていない場合は、それらしいAPIを創作せず提供を求めてください。

エンドポイントごとに、メソッド+パス・説明・パラメータ表・リクエスト例・レスポンス例という構成にしてください。