はじめに
このプロンプト集は、AIを活用してクリーンで保守性が高く、スケーラブルなコードを効率的に開発するためのガイドです。以下のプロンプトを参考に、プロジェクトの要件や進捗状況に合わせて適切なプロンプトを選択し、カスタマイズしてください。
AIとの対話を通じて、コードの生成やレビュー、改善案の提案を受けながら、自身でコードを見直し、リファクタリングを行うことで、高品質なコードを効率的に開発することを目指します。
AI を活用したソフトウェア開発のための個人的ガイド
下記のredditを日本語にしたものです。はじめに私は個人プロジェクトでコードを書く際、特に自動化のためのものを書く際には、AI を活用しています。この点について、人によって意見が分かれるようです。同じように AI を使っている人もいれば、...
hamaruki.com
2024.05.22
プロンプトの使用方針
- コンテキストは低く保ち、新しい会話をこまめに行う
- AIにコードをレビューさせる際は、別のAIが書いたコードだと伝える
- 開発者の努力を節約するワークフローを作成する
- AIに全面的に頼らず、ジュニアデベロッパーのように扱う
要件定義とコード生成の依頼
以下のプロジェクトの要件を満たすPythonコードを書いてください:
[プロジェクトの概要と目的]
機能要件:
- 'file_utilities'モジュールに'FileManager'クラスを作成
- 'FileManager'クラスにファイル名を引数に取る'read_file'メソッドを実装
- 'display_utilities'モジュールに'display_contents_of_file'メソッドを作成
- 'display_contents_of_file'メソッドでファイルの内容をコンソールに出力
非機能要件:
- クリーンで保守性の高いコード
- 可読性が高く、他の開発者が理解しやすいコード
- 将来の拡張性を考慮した設計
これらの要件を考慮して、コードを生成してください。もしより良い実装方法があれば提案してください。別のAIへのコードレビュー依頼
以下の要件を別のAIに提示し、コードを生成してもらいました:
[要件]
生成されたコードはこちらです:
[コード]
このコードを批評的にレビューし、以下の観点からリファクタリングの提案をお願いします:
1. コードの可読性と保守性
2. 命名規則と変数・関数名の適切さ
3. コードの構造とモジュール化
4. エラーハンドリングと例外処理
5. パフォーマンスと効率性
具体的な修正案とともに、フィードバックをお願いします。コードの最適化とヘルパーメソッドの提案
以下のコードをレビューし、改善点を提案してください:
[コード]
- 不要な部分や冗長な箇所はありませんか？
- コードの可読性を高めるための提案はありますか？
- ヘルパーメソッドを追加することで、コードをよりモジュール化できませんか？
- 将来の拡張性を考慮した設計になっていますか？
- パフォーマンスを向上させるための提案はありますか？
具体的な修正案とともに、フィードバックをお願いします。機能追加とコード更新の依頼
現在、以下の機能を持つPythonプログラムを開発しています:
[既存の機能説明]
これに加えて、以下の機能を追加したいと考えています:
[追加したい機能の説明]
追加機能の要件:
- [要件1]
- [要件2]
- [要件3]
既存のコードを考慮しながら、新しい機能を追加するためのコードを提案してください。その際、既存のコードに必要な修正も合わせて提示してください。
提案する際は、以下の点に留意してください:
1. 追加機能とのシームレスな統合
2. コードの可読性と保守性の維持
3. パフォーマンスへの影響
4. 将来の拡張性を考慮した設計
よろしくお願いします。まとめ
AIを活用することで、効率的かつ高品質なコードを開発することができます。上記のプロンプトを参考に、プロジェクトに合わせてカスタマイズし、AIとの協働を通じて開発を進めてください。
コード生成やレビューの際は、要件を明確に伝え、具体的な指示を与えることが重要です。また、AIからのフィードバックを踏まえて、自身でコードを見直し、改善していくプロセスを繰り返すことで、よりクリーンで保守性の高いコードを効率的に開発できるでしょう。
このプロンプト集を活用し、AIとの協働を通じて、プロジェクトの成功を目指しましょう。
コメント