タスク別プロンプトテンプレート
すぐに使えるテンプレート集
本章では、実際の開発タスクで使えるプロンプトテンプレートを提供します。
コピーして使ってください。
新規機能開発テンプレート
## 役割
あなたは[技術スタック]のシニアエンジニアです。
## 機能概要
[機能の目的と概要を記述]
## 推奨される技術スタックと構成
- フレームワーク: [例: Next.js 14]
- 言語: [例: TypeScript]
- スタイリング: [例: Tailwind CSS]
- 状態管理: [例: Zustand]
## 要件
1. [機能要件1]
2. [機能要件2]
3. [機能要件3]
## 既存コードとの整合性
- ディレクトリ: [例: src/components/]
- 命名規則: [例: PascalCase]
- 既存パターン: [参考にすべきファイル]
## 必須のセキュリティ要件
- [ ] 入力バリデーション
- [ ] 認証チェック
- [ ] XSS対策
## テスト要件
- [ ] ユニットテスト
- [ ] 統合テスト
## AI開発で避けるべき禁止事項
- any型の使用
- console.logのコミット
- ハードコードされた値バグ修正テンプレート
## 問題の説明
[何が起きているかを具体的に記述]
## 期待される動作
[本来どうあるべきか]
## 再現手順
1. [ステップ1]
2. [ステップ2]
3. [ステップ3]
## エラーメッセージ[エラーの全文を貼り付け]
## 関連コード
```[言語]
[問題のあるコードスニペット]環境情報
- OS: [例: macOS 14.0]
- Node.js: [例: v20.10.0]
- ブラウザ: [例: Chrome 120]
試したこと
- [既に試した解決策1]
- [既に試した解決策2]
調査してほしいこと
- [調査項目1]
- [調査項目2]
---
## コードレビュー依頼テンプレート
```markdown
## レビュー対象
[コードスニペットまたはファイルパス]
## 変更の目的
[なぜこの変更が必要か]
## 確認してほしい観点
- [ ] セキュリティ脆弱性
- [ ] パフォーマンス問題
- [ ] エラーハンドリング
- [ ] コーディング規約
- [ ] エッジケース
- [ ] テストカバレッジ
## 特に注意してほしい箇所
[具体的な行番号や関数名]
## AIに伝えるべきコンテキスト情報
[このコードの背景情報]
## 期待する出力形式の指定
以下の形式でレビュー結果を出力してください：
| 行 | 深刻度 | 問題 | 推奨対応 |
|----|--------|------|----------|リファクタリング依頼テンプレート
## 現在のコード
```[言語]
[リファクタリング対象のコード]問題点と発生する原因
- [具体的な問題1]
- [具体的な問題2]
目標
- [達成したいこと1]
- [達成したいこと2]
制約
- 既存のAPIインターフェースを維持
- 破壊的変更を避ける
- テストを壊さない
参考にすべきパターン
[プロジェクト内の良いコード例]
AI開発で避けるべき禁止事項
- 機能追加
- ライブラリ追加
- 大幅な設計変更
---
## テスト生成テンプレート
```markdown
## テスト対象
```[言語]
[テスト対象の関数やクラス]テストフレームワーク
[例: Jest, Vitest, pytest]
カバーすべきケース
正常系
- [正常ケース1]
- [正常ケース2]
異常系
- 不正な入力
- null/undefined
- 空の配列/オブジェクト
エッジケース
- 境界値
- 極端に大きな値
- 特殊文字
テストの書き方
- Arrange-Act-Assertパターン
- 各テストは独立
- モックは最小限
- 説明的なテスト名
期待する出力形式の指定
実行可能なテストコードを出力してください。
---
## API設計テンプレート
```markdown
## API概要
[APIの目的]
## 実装すべき機能要件
1. [エンドポイント1の説明]
2. [エンドポイント2の説明]
## 推奨される技術スタックと構成
- フレームワーク: [例: Express.js]
- データベース: [例: PostgreSQL]
- 認証: [例: JWT]
## 必須のセキュリティ要件
- [ ] 認証必須
- [ ] レート制限
- [ ] 入力バリデーション
- [ ] CORS設定
## 期待する出力形式の指定
OpenAPI 3.0形式でスキーマを出力してください。
## RESTful設計の遵守
- 適切なHTTPメソッド
- 意味のあるステータスコード
- 一貫したURL構造セキュリティレビューテンプレート
## レビュー対象
```[言語]
[レビュー対象のコード]ロール設定
あなたはOWASP Top 10に精通したセキュリティエンジニアです。 攻撃者の視点でこのコードを分析してください。
チェック項目
A01: 認証の不備
- 認証バイパスの可能性
A02: 暗号化の失敗
- 脆弱な暗号化
A03: インジェクション
- SQLインジェクション
- コマンドインジェクション
- XSS
A04: 安全でない設計
- 認可の欠如
A05: セキュリティ設定ミス
- デフォルト設定の問題
期待する出力形式の指定
| 脆弱性 | 深刻度 | 行番号 | 説明 | 修正案 |
|---|
---
## ドキュメント生成テンプレート
```markdown
## ドキュメント対象
```[言語]
[ドキュメント化するコード]ドキュメントの種類
- APIドキュメント
- 関数リファレンス
- README
- 使用例
期待する出力形式の指定
[例: JSDoc, TypeDoc, Markdown]
対象読者
[例: チームメンバー、外部開発者、エンドユーザー]
含めるべき情報
- 概要
- パラメータ説明
- 戻り値
- 使用例
- 注意事項
---
## 今日から実践できるアクション
### ステップ1: テンプレートを保存
本章のテンプレートをプロジェクトの `docs/prompts/` に保存してください。
### ステップ2: カスタマイズ
プロジェクト固有の技術スタック、命名規則、コーディング規約を反映してください。
### ステップ3: チームで共有
テンプレートをチームで共有し、フィードバックを集めて改善してください。
---
## まとめ：重要ポイントの振り返り
- **新規機能**: 要件、技術スタック、セキュリティを明示
- **バグ修正**: 再現手順、エラー、環境を詳細に
- **レビュー**: 観点と出力形式を指定
- **リファクタリング**: 問題点、目標、制約を明確に
- **テスト**: カバーすべきケースを網羅
- **セキュリティ**: OWASP Top 10をベースに
- **教訓：テンプレートを育ててチームの資産に**