高品質なプロンプトの構成要素
- 明確な目的または成果物
- AIモデルに何を生成させたいのか？
- 計画ですか？新規コードですか？それともリファクタリングですか？
- タスクを実行するための関連コンテキストの網羅
- 適切なコンテキストが含まれるよう、@メンションを正しく使いましたか？
- Windsurf には分かりにくい可能性のある、顧客固有のコンテキストはありますか？
- 必要な制約
- 必ず使用すべき特定のフレームワーク、ライブラリ、または言語はありますか？
- 時間計算量や空間計算量の制約はありますか？
- セキュリティ上の考慮事項はありますか？
例
- 悪い例: Order Book オブジェクトのすべてのテストケースに対して単体テストを書いてください。
-
良い例:
@class:unit-testing-moduleを使って、ストップロスを上回る／下回る場合にスローされる例外を検証する@func:src-order-book-add向けの単体テストを書いてください。
- 悪い例: rawDataTransform をリファクタリングする。
-
良い例:
@func:rawDataTransformをリファクタリングし、while ループを for ループに書き換え、出力のデータ構造を@func:otherDataTransformerと同じにしてください。
- 悪い例: Contact Form 用に新しい Button を作成する。
-
良い例:
@class:ContactForm用に新しい Button コンポーネントを作成し、@repo:frontend-componentsのスタイルガイドに従い、ラベルを「Continue」としてください。