Prompt file imported from dahatake/HypervelocityEngineering (
.github/prompts/Doc-APISpec.prompt.md). Copyright stays with the author.
> API仕様書を生成する。
WORK:
work/run/<run-id>/Doc-APISpec/Issue-<識別子>/
共通ルール
共通行動規約は
.github/copilot-instructions.mdおよび Skillagent-common-preamble(.github/skills/agent-common-preamble/SKILL.md) を継承する。
Agent 固有の Skills 依存
- input-file-validation
- work-artifacts-layout
- harness-verification-loop
1) 目的と非目的
目的（MUST）
- エンドポイント仕様を統一フォーマットで整理する。
非目的
- API実装の追加/変更は行わない。
2) 入力（必ず参照）
- API関連ファイルサマリー群
3) 出力フォーマット（Markdown固定スキーマ）
docs-generated/components/api-spec.md- セクション:
## API 概要## エンドポイント一覧テーブル| HTTPメソッド | パス | 説明 | リクエスト型 | レスポンス型 | 認証 |## 共通ヘッダー## エラーレスポンス## 型定義
4) 実行手順（順序固定）
- エンドポイント候補を抽出する。
- リクエスト/レスポンス/認証を整理する。
- エラー仕様と型定義を記述する。
4.1) 収集・記述ルール
- 対象外ディレクトリや生成物（例:
.git/,node_modules/,dist/）は必要時のみ参照してください。 - 記述は「観察した事実」と「判断（必要最小限）」を分けてください。
- 不明点は断定せず、
TBDと確認ポイントを併記してください。
4.2) 失敗時ハンドリング
- 入力ファイルが見つからない場合は、探索条件と結果を記録して中断理由を明記してください。
- 文字コードや巨大ファイルで読取失敗した場合は、範囲分割して再読込してください。
- 出力先ディレクトリが無い場合は作成してから出力してください。
5) 品質原則（必ず守る）
- 捏造は絶対に禁止です。ソースコードに基づいて客観的に記述してください。
- 欠損がある場合は TBD（理由付き） と明記してください。
- ソースコードや既存ドキュメントに存在しない情報を書かないでください。
- 主要な記述には出典（ファイルパス + 行番号）を記載してください。
5.1) 出典記載の最小単位
- テーブル/箇条書きの各要素は、可能な限り行番号付き出典を併記してください。
- 同一出典が続く場合も、省略せず明示してください。
- 出典が取得できない情報は
TBD扱いとしてください。
5.2) 形式チェック
- 見出し階層（
##/###）を崩さないこと。 - 指定された固定テーブル列を削除しないこと。
- Mermaid ブロックは構文エラーがない形で出力すること。
6) セルフチェック（出力前に必ず確認）
- エンドポイント一覧が空でない（対象が存在する場合）。
- HTTPメソッドとパスが重複なく整理されている。
- 認証要件が不明な場合はTBDで明示している。
7) 完了条件
- API仕様書が生成され、実装読解に必要な情報が揃っている。