効果的なプロンプト・コンテキストの原則

GitHub Copilot・GitHub Copilot Chatは、IDEで要求（プロンプト）とともに、IDEで開いているファイルやワークスペースを文脈（コンテキスト）として加味した上で、提案を返却します。
そのため、プロンプト・コンテキスト次第で、出力結果が大きく変わります。

効果的な出力を得るために、以下の4つの原則に従って、プロンプト・コンテキストを作成してください。

備考

本ページは以下からの抜粋です。

• AI-Powered Development with GitHub Copilot 20240202 - Speaker Deck
  
• GitHub Copilot のプロンプト エンジニアリング- GitHub Docs

以下スライドにて4つの原則が簡潔に示されています。

1. 文脈

GitHub Copilotが予測のために使う文脈を以下のように制御してください。より良い結果が生まれやすくなります。

• 文脈として与えたいファイルのみをタブで開いてください
  ※GitHub Copilotは現在タブで開かれているファイルを予測のために扱います
• GitHub Copilot Chatを使う場合は、@workspaceコマンドや、#file等のコンテキスト変数コマンドを使うことで、文脈の指定を行えます
  • ※@workspaceの使い方はGitHub Copilot Chat ＞ コマンドを参照ください
    
  • ※#fileの使い方はGitHub Copilot Chat ＞ コンテキスト変数を参照ください

2. 意図

何をゴールにすべきかをGitHub Copilotに明示的に伝えてください。意図に沿った結果が生まれやすくなります。

• コメントで意図を記載してください
• クラス名、メソッド名等で意図を伝えてください

3. 明瞭さ

曖昧さを避け、明瞭な指示をしてください。GitHub Copilotは指示が明瞭なほど、意図した結果が生まれやすくなります。

4. 具体性

プロンプトの具体性を以下のように上げてください。具体性が増すほどGitHub Copilotの予測精度が良くなります。

• 具体的な出力例をプロンプトに含めてください
• 出力・入力の型を記載してください