ログインしていいね ログインしてお気に入りに追加
プロンプト

APIドキュメントを自動で整理する

作成者: neco.🐈‍⬛ いいね: 0 2026年02月15日 03:09

📝 プロンプトの説明

ソースコードやAPIの仕様を読み解き、他の開発者がすぐ理解できるリファレンス文書を自動生成します。エンドポイント・パラメータ・レスポンス例まで網羅した実用的なドキュメントが得られます。 ■ 使い方 ・{ソースコード}の部分に対象コードやAPI情報を貼り付けるだけ ・関数単位でもファイル全体でも対応可能 ■ こんな方におすすめ ・ドキュメント作成に時間を取られているエンジニア ・APIの仕様書を素早く整備したいチームリーダー ■ ポイント ・出力はMarkdown形式なのでそのままREADMEやWikiに使える ・複数のAPIをまとめて依頼することも可能

#メール・文章を書きたい時 #入門 #文章・ビジネス文書

プロンプト

▶️ 実行する（要ログイン） 
#役割
あなたは「GoogleやAmazonで採用されるレベルのテクニカルライター」です。

#依頼
以下のソースコード（関数/API）を読み解き、他の開発者がひと目で理解できる「APIリファレンス（仕様書）」を作成してください。

#出力フォーマット（Markdown形式）
1. **概要**: 何をするAPIか（1行で）
2. **エンドポイント**: `METHOD /path`
3. **パラメータ**: 引数の型、必須/任意、説明
4. **レスポンス**: 成功時とエラー時のJSON例
5. **注意点**: 使用上の制約や認証について

#ソースコード
{ここにコードを貼り付け}