05_プログラマーのAPIドキュメントを作成するプロンプト

#前提条件:
- タイトル: プログラマー向けAPIドキュメント作成プロンプト
- 依頼者条件: プログラムやAPI開発に関わるプロフェッショナルであり、APIドキュメントの重要性を理解していること。
- 制作者条件: API設計とプログラミングに精通しており、技術的なドキュメントを作成するスキルを持っていること。
- 目的と目標: API利用者がAPIの機能や使用方法を迅速に理解できるように、詳細かつ分かりやすいAPIドキュメントを作成する。
- 必要リソース: APIの仕様書、サンプルコード、利用ガイドライン、および関連する技術情報。
- 評価基準: APIドキュメントが包括的であり、利用者からのフィードバックが良好であること。
- 明確化の要件:
- APIの概要と目的を明確に説明する。
- 各エンドポイントの詳細な説明を提供する。
- サンプルリクエストとレスポンスを含める。
- エラーメッセージとその対処方法を記載する。
- 認証および認可の手順を説明する。
- バージョン管理と変更履歴を明示する。
- よくある質問（FAQ）セクションを設ける。

# 実行指示:

{プログラマー}の情報を基に、
{APIの名前}に関する、
{APIの目的}を詳細に説明する、
{リクエストパラメータ}を提供し、
{レスポンスフィールド}を明確にする、
迅速に{エラーメッセージの種類}を理解できる、
包括的なAPIドキュメントを{プログラマー}向けに作成する。
{依存関係や前提条件}を追記する。
箇条書きで段落名をつけて専門的なトーンで作成してください。

参考フォーマット="
了解しました。以下に、プログラマー向けAPIドキュメントの作成プロンプトを作成しますね。

---

## ProductInventoryAPI ドキュメント

### APIの概要と目的

### リクエストパラメータ

- **productId** (必須): 商品の一意のIDを指定します。整数型です。

### レスポンスフィールド

- **success**: 処理の成功を示すフラグです。`true`または`false`で返されます。

### エラーメッセージ

- **INVALID_PRODUCT_ID**: 無効な商品IDが指定されました。正しいIDを入力してください。

### 依存関係や前提条件

"
プログラマー="
プログラマーの性格:
- 分析的
- 忍耐強い
- 問題解決志向

プログラマーの対象の悩み:
- 新しい技術の習得
- 複雑なバグの解決
- プロジェクトの締め切りに間に合わせるプレッシャー

プログラマーの興味・関心:
- 最新のプログラミング言語やフレームワーク
- オープンソースプロジェクトへの貢献
- 効率的なコードの書き方

プログラマーの特徴的な行動:
- コーディングに集中すると周りのことを忘れる
- 問題解決のために徹底的に調査する
- 定期的にコードをリファクタリングする
"
APIの名前="

"
APIの目的="

"
リクエストパラメータ="

"
レスポンスフィールド="

"
エラーメッセージの内容="

"
依存関係や前提条件="

"