付録1
想定学習時間: 8分
AI、特にCodexのようなツールは、単にコードを生成するだけでなく、開発プロセスのさまざまな段階で品質管理やプロジェクト管理を支援する強力なパートナーとなり得ます。このレッスンでは、コードの変更確認から本番利用、さらにはプロジェクトの改善計画まで、AIを効果的に活用するための具体的なプロンプトとその使い方を学びます。
コードの変更は、意図しない問題を引き起こす可能性があります。AIにコード変更のレビューを依頼することで、見落としを防ぎ、品質を維持できます。
コードを変更した後、その変更が適切であるか、余計なものが含まれていないかをAIに確認させます。これにより、意図しない変更や潜在的な問題を早期に発見し、既存機能への影響や動作確認すべき項目を洗い出すことができます。
今回の変更について確認してください。
1. 変更したファイル一覧
2. 各ファイルで変更した内容
3. 依頼に含まれていない余計な変更がないか
4. 既存機能に影響がありそうな点
5. 動作確認すべき項目
初心者にもわかるように説明してください。
もし余計な変更がある場合は、元に戻す方法も提案してください。ソースコードにAPIキー、パスワード、個人情報などの機密情報が混入すると、情報漏洩のリスクが高まります。AIにこれらの観点でプロジェクト全体をチェックさせることで、リリース前にリスクを特定し、セキュリティを強化できます。
このプロジェクトに危険な情報が含まれていないか確認してください。
特に以下の観点で見てください。
1. APIキー
2. パスワード
3. 個人情報
4. 顧客情報
5. 社内情報
6. 公開してはいけない設定ファイル
7. GitHubに上げるべきではないファイル
危険度の高い順に指摘してください。
まだ削除や修正はせず、まず確認結果を説明してください。バージョン管理システムGitを適切に利用することは、開発において不可欠です。AIはコミット前の確認やコミットメッセージの作成を支援できます。
Gitで変更を記録(コミット)する前に、何を含めるべきか、何を確認すべきかをAIに整理させます。これにより、後で問題になるようなコミットを防ぎ、プロジェクトの履歴をきれいに保つことができます。
この状態をGitでコミットしたいです。
まず、コミット前に確認すべきことを整理してください。
1. 変更されたファイル
2. コミットに含めてよいファイル
3. 含めない方がよいファイル
4. 危険な情報が含まれていないか
5. 動作確認が必要な項目
6. コミットメッセージ案
初心者向けに説明してください。
危険な可能性がある場合は、コミット前に教えてください。コミットメッセージは、後から変更履歴を追う際に非常に重要です。AIに簡潔で分かりやすいメッセージ案を複数提案させることで、適切なメッセージを選ぶ手助けになります。
今回の変更内容に合うコミットメッセージを考えてください。
変更内容は以下です。
〇〇を追加した
〇〇を修正した
〇〇は変更していない
初心者にもわかりやすい、短いコミットメッセージを5案出してください。
日本語でお願いします。プロジェクトのREADMEファイルは、他の開発者や利用者がプロジェクトを理解するために不可欠です。AIにその作成を依頼することで、効率的にドキュメントを準備できます。
AIにプロジェクトの概要、機能、使い方、注意点などをまとめたREADMEの骨子を作成させます。これにより、ドキュメント作成の手間を省き、試作品である旨も追記させることで、利用者に注意を促せます。
このプロジェクトのREADMEを作ってください。
内容は以下の構成にしてください。
1. 概要
2. 目的
3. 主な機能
4. 使い方
5. 動作確認方法
6. 注意点
7. 今後の改善案
初心者にもわかる文章にしてください。
このツールが試作品の場合は、本番利用前に確認が必要であることも書いてください。開発したツールを本番環境で利用する前には、様々なリスクを考慮し、徹底的な確認が必要です。AIにチェックリストの作成を依頼することで、安全な移行を支援します。
試作品を本番環境に移行する際には、セキュリティ、個人情報、データ保存、認証などの多岐にわたる観点での確認が求められます。AIにこれらの項目を整理させ、優先度順に不足していることを指摘させることで、安全な本番利用への道筋を立てられます。
このツールを本番利用する前に、確認すべき点を整理してください。
以下の観点でお願いします。
1. セキュリティ
2. 個人情報
3. データ保存
4. 認証や権限
5. バックアップ
6. 操作ミス防止
7. エラー対応
8. 利用者への説明
9. 専門家に確認すべき点
このツールは、現時点では試作品として扱う前提でお願いします。
本番利用に進めるために不足していることを、優先度順に整理してください。AIは強力なツールですが、その出力は常に完璧とは限りません。AIが生成した成果物を人間が適切にレビューするためのチェックリストをAIに作成させます。これにより、AIの限界を理解し、責任を持って成果物を利用するための意識を高めることができます。
このツールについて、AIに丸投げしないための確認ポイントを整理してください。
以下の観点で確認してください。
1. 目的に合っているか
2. 利用者に合っているか
3. 入力と出力が正しいか
4. 例外に対応できているか
5. 危険な情報を扱っていないか
6. 人間が確認すべき部分を残しているか
7. 本番利用してよい状態か
8. 変更前に戻れる状態か
9. 自分が説明できる状態か
初心者にもわかるチェックリストにしてください。開発中のツールについて、AIに現状を伝えて改善案を相談することで、客観的な視点から次のステップを検討できます。
ツールの現状(できること、できないこと、不便な点)をAIに伝え、今後の改善点を整理させます。優先順位付けも依頼することで、効率的な開発計画を立てる手助けとなります。
このツールは現在、〇〇まで動いています。
次に改善するとしたら、何から取り組むべきか相談したいです。
現在できること:〇〇
まだできないこと:〇〇
使ってみて不便だったこと:〇〇
本番利用はまだしない前提です。
改善案を、
1. 最優先で直すべきこと
2. 次に追加すると便利なこと
3. 後回しでよいこと
4. 本番利用前に確認すべきこと
に分けて整理してください。
まだコードは書かないでください。AIを効果的に活用するためには、単にコードを生成させるだけでなく、段階的なアプローチと具体的な指示が重要です。AIは魔法ではなく、明確な指示に基づいて動くツールであることを理解してください。