1. 導入: なぜSystem Promptが重要なのか
AIエディタ（CursorやGitHub Copilot Chatなど）を導入したものの、「期待するコーディングスタイルと違う」「不要なコメントが多い」「ライブラリのバージョンが古い」といった悩みを抱えていませんか？これらの問題を解決するのがSystem Prompt（System Instructions）です。AIに対してプロジェクトの文脈や役割を事前に定義することで、生成されるコードの品質をチームの規約レベルにまで引き上げ、手修正という「AIの再調整」にかかる時間を最小化できます。
2. 基礎知識: System PromptとPersonaとは
System Promptとは、AIモデルに対する「振る舞い」や「制約」を定義する事前指示のことです。
・Persona（役割）: AIに特定のスキルセットやマインドセットを付与します。「シニアエンジニアとして」「パフォーマンスを最優先するアーキテクトとして」といった役割指定が含まれます。
・Project Context（プロジェクト規約）: 使用する技術スタックや、命名規則（camelCase/PascalCaseなど）、禁止されている書き方（例: any型の禁止）をAIに強制します。
これらを適切に設定することで、AIは「単なるコード生成マシン」から「プロジェクトのルールを理解したペアプログラマー」へと進化します。
3. 実装/解決策: 具体的な設定手順
多くのAIエディタには、プロジェクトルートに特定の設定ファイルを配置することでSystem Promptを読み込ませる機能があります。例えば、Cursorであれば「.cursorrules」というファイルを作成することで、AIエディタ全体にこのルールを適用可能です。
手順:
1. プロジェクトルートに `.cursorrules` ファイルを作成する。
2. チームの規約や技術スタックを記述する。
3. AIが回答する際の「禁止事項」や「推奨事項」を明確に言語化する。
4. サンプルプログラム: 実践的な.cursorrules設定例
以下は、TypeScriptプロジェクトを想定した実践的な設定例です。これをそのまま `.cursorrules` として保存してください。
あなたの役割
あなたは10年以上の経験を持つシニアTypeScriptエンジニアです。
コードの可読性、型安全性、パフォーマンスを最優先に考えてください。
プロジェクト規約
- すべての外部インターフェースには型定義を作成し、’any’型は絶対に使用禁止です。
- 非同期処理には必ず async/await を使用し、Promiseチェーンは避けてください。
- コンポーネントは関数型コンポーネントのみを使用し、React Hooksのルールを遵守してください。
- エラーハンドリングは例外を適切にキャッチし、ログには必ずコンテキスト情報を含めてください。
出力形式のルール
- コードの解説は簡潔に行い、コードブロック内のコメントは日本語で記述してください。
- 既存の命名規則（camelCase）を厳守してください。
- 修正提案を行う際は、修正理由を必ず一行添えてください。
5. 応用・注意点: 現場で役立つ運用Tips
・情報の更新とメンテナンス
プロジェクト規約は生き物です。ライブラリのアップデートやチームのルール変更に合わせて、`.cursorrules` を定期的に更新してください。古い情報を保持していると、AIが古いライブラリの記法を提案し続ける原因になります。
・過度な制約の注意点
ルールを詰め込みすぎると、AIの推論能力が低下し、本来の柔軟性が失われることがあります。特に重要な「禁止事項」と「コーディングスタイル」に絞り、重要度の低いルールは含めないのがコツです。
・チームでの共有
このファイルはGitで管理しましょう。チームメンバー全員が同じルールを共有することで、誰がAIを使ってコードを生成しても、一貫した品質を保つことができます。これは「AIによるコードレビューの自動化」にもつながる非常に強力な手法です。
コメント