整備しておくファイル
AIをプロジェクトにオンボーディングさせるにあたり、整備しておくべきファイルを紹介します。
ここで紹介するファイルは、インストラクションやプロンプトを共有するで紹介したカスタムインストラクション(インストラクションファイル)として作成します。
アーキテクトの方であれば、こちらで紹介しているファイルの内容を見た時に方式設計書や実装ガイドに記載する内容と重複しているのでは?と思われたでし ょう。
また、最初からAIのオンボーディングを見据えたドキュメントにしておけばよいのでは?とも思われたでしょう。
本ガイドでは対象工程と開発プロセスで記載したように、製造および単体テスト工程を対象にしています。
方式設計書など、前工程の成果物を含めてAI前提の開発プロセスにするべきかは今後整備予定です。このあたりは前提をご確認ください。
2度手間ですが、まずはGitHub Copilotを迷わず導入し生産性を上げやすくするため、このような方針としています。
📄️ GitHub Copilotに役割を設定する
AIには特定の役割(ロール)を設定することで、専門家のような振る舞いをさせることができます。これをロールプレイと呼びます。
📄️ プロジェクトの目的
新しいメンバーがプロジェクトに参画する際、その背景や目的などを書いた資料があればオンボーディングがスムーズに進みます。
📄️ 技術スタック
プロジェクトで使用する技術スタック(プログラミング言語、フレームワーク、ライブラリなど)をAIに伝えましょう。
📄️ ディレクトリ構成
プロジェクトのディレクトリ構成をAIに伝えることで、AIがファイル生成やコード参照を行う際に、適切なパスを推測しやすくなります。
📄️ クラスのステレオタイプとパッケージ構成
プロジェクトで扱うクラスの役割(ステレオタイプ)とそれらがどのパッケージに配置されるべきかというルールをAIに伝えることは、一貫性を持ったコードを生成させ、保守性を高めるうえでも重要です。
📄️ コーディング標準
プロジェクトでのコーディング標準や規約をAIに伝えておくことは重要です。
📄️ テストコード標準
プロジェクトにおけるテストコードの標準や規約をAIに伝えておくことは、品質の高いテストコードを効率的に作成するために必要です。
📄️ 開発の進め方
GitHub Copilot ChatのAgent Modeを使用すると、AIにある程度自律的な動作をさせることが可能になります。