ChatGPT活用大全集　4. エンジニア・プログラマー

エンジニア・プログラマー向けのChatGPT活用例をご紹介します。
Copilot、Gemini、Claudeなど他の対話型AIチャットでも使用できます。

1. コードのリファクタリングアドバイス

使用シーン

エンジニアが既存のコードベースを改善し、読みやすく、保守しやすいコードにするためにリファクタリングを行う際に使用します。特に、複雑なロジックや長い関数を整理するために役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすコードのリファクタリングアドバイスを提供してください。

- プログラムの目的: ユーザー入力に基づいて商品の価格を計算し、合計を表示するプログラム
- 言語: Python
- 現在のコードは、関数が長く、ネストされたif文が多く含まれているため、読みづらい。
- 提供するリファクタリングアドバイスには、関数の分割、ネストの削減、コメントの追加を含めること。
- 以下のコードをリファクタリングしてください:

```python
def calculate_total(prices, quantities, discount):
total = 0
for i in range(len(prices)):
if quantities[i] > 0:
price = prices[i] * quantities[i]
if discount > 0:
price -= price * (discount / 100)
total += price
return total
```

ChatGPT出力例

# リファクタリングされたコード
```python
def calculate_price(price, quantity, discount):
"""Calculate the price after discount for a given quantity."""
total_price = price * quantity
if discount > 0:
total_price -= total_price * (discount / 100)
return total_price

def calculate_total(prices, quantities, discount):
"""Calculate the total price for all items, applying discount if applicable."""
total = 0
for price, quantity in zip(prices, quantities):
if quantity > 0:
total += calculate_price(price, quantity, discount)
return total
```

# 新しい関数構造によって、コードがより理解しやすく、保守しやすくなりました。
# calculate_price関数を追加することで、個々の商品の価格計算がモジュール化され、ネストの深さが減少しています。

応用シーン

1. コードレビュー: チームメンバーのコードをレビューする際に、改善提案としてリファクタリングのアドバイスを行うことができます。これにより、コードの品質向上と保守性の向上を促進します。

2. リファクタリングトレーニング: 新人エンジニアのトレーニングセッションで、リファクタリングのベストプラクティスを学ぶための教材として使用することができます。特に、読みやすさと保守性を重視したコードを書けるようにするために役立ちます。

2. バグ修正のためのコードレビュー

使用シーン

エンジニアが自分の書いたコードにバグが発生した場合、そのバグを修正するためにコードレビューを行う際に使用します。特に、複雑なロジックが含まれるコードで、何が問題なのかを素早く見つけるために役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすコードのバグ修正のためのレビューを提供してください。

- プログラムの目的: リスト内の数値を合計し、平均値を計算して返すプログラム
- 言語: JavaScript
- 現在のコードにバグがあり、平均値が正しく計算されていません。
- バグ修正のために、コードの問題点を指摘し、修正方法を提案してください。
- 以下のコードをレビューしてください:

```javascript
function calculateAverage(numbers) {
let sum = 0;
for (let i = 0; i <= numbers.length; i++) {
sum += numbers[i];
}
return sum / numbers.length;
}
```

ChatGPT出力例

// コードレビューとバグ修正提案

// 問題点:
// 1. forループの条件式で、i <= numbers.length としているため、配列の範囲を超えてアクセスしてしまう。
// 2. これにより、undefinedを数値として合計しようとし、NaNが結果として返される。

// 修正方法:
function calculateAverage(numbers) {
let sum = 0;
// 修正点: i < numbers.length に変更
for (let i = 0; i < numbers.length; i++) {
sum += numbers[i];
}
return sum / numbers.length;
}

// 修正後のコードは、配列の範囲内で正しく数値を合計し、平均値を計算します。

応用シーン

1. デバッグトレーニング: 新人エンジニアやインターン向けに、バグの見つけ方と修正方法を教えるためのトレーニング資料として使用できます。バグ修正の実践的なスキルを学ぶのに役立ちます。

2. ペアプログラミング: ペアプログラミングのセッションで、バグ修正を行いながらコードの品質を向上させるためのアクティビティとして使用できます。チームメンバー間での知識共有と問題解決スキルの向上に寄与します。

3. プログラムのアルゴリズム最適化提案

使用シーン

エンジニアがプログラムのパフォーマンスを向上させるために、アルゴリズムを最適化する必要がある際に使用します。特に、計算時間やメモリ使用量を削減するための最適化を行いたい場合に役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすプログラムのアルゴリズム最適化提案を提供してください。

- プログラムの目的: 大きなリストから重複する要素をすべて削除し、ユニークな要素のみを含むリストを返す。
- 言語: Java
- 現在のアルゴリズムは、二重ループを使用しているため、時間効率が悪い。
- 提案する最適化には、時間計算量の削減を重視したアルゴリズムを含めること。
- 以下のコードを最適化してください:

```java
import java.util.ArrayList;
import java.util.List;

public class Main {
public static List<Integer> removeDuplicates(List<Integer> list) {
List<Integer> uniqueList = new ArrayList<>();
for (int i = 0; i < list.size(); i++) {
boolean isDuplicate = false;
for (int j = 0; j < uniqueList.size(); j++) {
if (list.get(i).equals(uniqueList.get(j))) {
isDuplicate = true;
break;
}
}
if (!isDuplicate) {
uniqueList.add(list.get(i));
}
}
return uniqueList;
}
}
```

ChatGPT出力例

// 最適化提案: HashSetを使用して時間計算量を削減

import java.util.HashSet;
import java.util.List;

public class Main {
public static List<Integer> removeDuplicates(List<Integer> list) {
// HashSetを使用することで、重複の確認がO(1)で行える
return new ArrayList<>(new HashSet<>(list));
}
}

// この最適化により、時間計算量がO(n^2)からO(n)に改善されます。
// HashSetを使用することで、リスト内の重複を効率的に排除できます。

応用シーン

1. パフォーマンステスト: 最適化されたコードを使ってパフォーマンステストを実施し、最適化前後の性能を比較する際に使用できます。アルゴリズムの効率性を実証するために役立ちます。

2. コード最適化ワークショップ: チーム全体でのコード最適化ワークショップで、さまざまなアルゴリズムの最適化手法を学ぶための教材として使用できます。エンジニアの最適化スキルを向上させるために役立ちます。

4. 新しい技術の導入ガイド作成

使用シーン

エンジニアがプロジェクトに新しい技術やフレームワークを導入する際に、そのガイドを作成する場合に使用します。特に、チーム全体で新しい技術を効率的に学習し、導入できるようにするために役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たす新しい技術の導入ガイドを作成してください。

- 技術: Docker
- ガイドには、1. Dockerの基本的な概念、2. 簡単なセットアップ手順、3. 主要なコマンドのリストを含めること。
- 各セクションには、具体的な例と実践的なアドバイスを記載してください。

ChatGPT出力例

**Docker導入ガイド**

1. **Dockerの基本的な概念**
- Dockerは、アプリケーションをコンテナ化するためのプラットフォームです。コンテナとは、必要なすべての要素（コード、ライブラリ、設定ファイルなど）を含む軽量な仮想環境のことです。
- コンテナを使用することで、環境の一貫性を保ちながら、迅速にアプリケーションを展開できます。

2. **簡単なセットアップ手順**
- 公式サイトからDocker Desktopをダウンロードし、インストールします。
- インストール後、ターミナルを開き、「docker --version」を実行して、Dockerが正常にインストールされたことを確認します。

3. **主要なコマンドのリスト**
- `docker run`: 新しいコンテナを作成して起動します。
- `docker ps`: 現在稼働中のコンテナのリストを表示します。
- `docker stop`: 指定したコンテナを停止します。
- `docker rm`: 停止したコンテナを削除します。
- `docker images`: ローカルに保存されているイメージのリストを表示します。
- 例: `docker run -it ubuntu bash` コマンドで、Ubuntuコンテナを起動し、対話型シェルを開きます。

このガイドを参考にして、チーム全体でDockerの使用方法を習得し、プロジェクトに導入しましょう。

応用シーン

1. 技術導入ワークショップ: チーム全体での新技術導入ワークショップを開催する際に、ガイドとして使用できます。全員が同じ知識レベルで新しい技術を導入できるようにします。

2. 社内ドキュメントの作成: 新しい技術やフレームワークを社内で導入する際の公式ドキュメントを作成するために使用できます。チーム全体での効率的な技術導入を促進します。

5. デバッグ手順の提案

使用シーン

エンジニアが複雑なバグを解決するために、効果的なデバッグ手順を提案してもらう必要がある際に使用します。特に、どこから問題をトレースすべきか、どのようにしてバグを再現するかを知りたい場合に役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすデバッグ手順を提案してください。

- プログラムの目的: ファイルの読み取りと処理を行うPythonプログラム
- 問題: プログラムが大きなファイルを読み取る際にクラッシュする
- 提案するデバッグ手順には、1. 問題の再現方法、2. デバッグツールの使用方法、3. バグ修正のための推奨事項を含めること。
- 提案を行う際に、具体的なコマンドやツールの名前を挙げてください。

ChatGPT出力例

**デバッグ手順の提案**

1. **問題の再現方法**
- 小さなファイルでプログラムを実行し、問題が再現されないことを確認します。その後、大きなファイルでプログラムを実行し、クラッシュが発生するか確認します。

2. **デバッグツールの使用方法**
- 使用ツール: `pdb`（Pythonデバッガ）
- 実行手順: プログラムの先頭に「`import pdb; pdb.set_trace()`」を追加し、ステップバイステップで実行します。
- 注目する点: メモリ使用量とI/O操作のパフォーマンス

3. **バグ修正のための推奨事項**
- 大きなファイルを処理する際のメモリ使用量を最小化するために、ファイルをチャンクごとに読み込む方法を検討してください。
- 例: `with open('largefile.txt') as f: for chunk in iter(lambda: f.read(1024), ''): process(chunk)`
- メモリリークが疑われる場合、メモリプロファイラツール（例: `memory_profiler`）を使用して、メモリの使用状況を特定します。

これらの手順を使用して、問題を特定し、クラッシュの原因を解明してください。

応用シーン

1. バグバッシュイベント: チーム全体でバグを一斉に解決する「バグバッシュ」イベントを開催する際に、効果的なデバッグ手順を共有するために使用できます。

2. コードの品質向上: 継続的なデバッグ手順の改善を通じて、コードの品質向上を図ることができます。定期的にデバッグ手順を見直し、ベストプラクティスをチームで共有することで、バグ発生率を減らすことができます。

6. コーディングベストプラクティスの共有

使用シーン

エンジニアがチーム全体でコーディングのベストプラクティスを共有し、コードの品質を向上させるために使用します。特に、プロジェクト全体で一貫性を持たせるためのガイドラインを作成する際に役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすコーディングベストプラクティスのガイドラインを作成してください。

- 言語: JavaScript
- ガイドラインには、1. コードの可読性向上、2. パフォーマンス最適化、3. セキュリティ強化に関するアドバイスを含めること。
- 各セクションには具体的なコード例とアドバイスを記載してください。

ChatGPT出力例

**JavaScriptコーディングベストプラクティスガイドライン**

1. **コードの可読性向上**
- 一貫した命名規則を使用する（例: キャメルケース `myVariableName`）
- コメントを適切に追加し、コードの意図を明確にする
- 例:
```javascript
// 良い例
function calculateTotalPrice(price, tax) {
return price + (price * tax);
}
```
このガイドラインを使用して、チーム全体で一貫したコード品質を維持し、プロジェクトの成功を目指しましょう。

応用シーン

1. コードレビューの標準化: コードレビューの際に、全員が同じ基準でコードを評価できるようにするためのガイドラインとして使用できます。これにより、コードの品質を均一に保つことができます。

2. オンボーディング資料の作成: 新入社員向けのオンボーディング資料として使用することで、新しいエンジニアがすぐにチームのコーディングスタイルに適応できるようにします。

7. 継続的インテグレーション（CI）パイプラインの設定

使用シーン

エンジニアが新しいプロジェクトや既存のプロジェクトに継続的インテグレーション（CI）を導入する際に、そのパイプラインの設定を行う場合に使用します。特に、ビルド、テスト、自動デプロイを含むCIパイプラインの設定が必要な場合に役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすCIパイプラインの設定ガイドを作成してください。

- 使用ツール: GitHub Actions
- パイプラインには、1. ビルドステップ、2. テストステップ、3. デプロイステップを含むこと。
- 各ステップには、具体的な設定ファイル（YAML）と実行されるアクションの説明を記載してください。

ChatGPT出力例

# GitHub Actions CIパイプライン設定

name: CI Pipeline

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: コードのチェックアウト
uses: actions/checkout@v2

- name: Node.jsをセットアップ
uses: actions/setup-node@v2
with:
node-version: '14'

- name: 依存関係のインストール
run: npm install

test:
runs-on: ubuntu-latest
needs: build
steps:
- name: コードのチェックアウト
uses: actions/checkout@v2

- name: テストの実行
run: npm test

deploy:
runs-on: ubuntu-latest
needs: test
steps:
- name: コードのチェックアウト
uses: actions/checkout@v2

- name: デプロイの実行
run: npm run deploy

応用シーン

1. プロジェクトスタートガイド: 新しいプロジェクトを始める際のスタートガイドとして使用し、チーム全体で同じCIパイプラインを使用することで、開発の一貫性と効率性を向上させることができます。

2. デプロイメント戦略の改善: 継続的デプロイ（CD）と連携させることで、デプロイメントプロセスを自動化し、エラーのリスクを低減しながら迅速なリリースを実現するために使用できます。

8. コードドキュメントの自動生成

使用シーン

エンジニアがコードベースのドキュメントを自動生成するためのツールや方法を導入する際に使用します。特に、大規模なプロジェクトでのドキュメント作成の手間を軽減し、一貫したドキュメントを維持するために役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすコードドキュメントの自動生成ガイドを作成してください。

- 使用ツール: JSDoc
- ガイドには、1. JSDocのセットアップ手順、2. ドキュメンテーションコメントの書き方、3. ドキュメントの生成手順を含めること。
- 各セクションには、具体的なコード例と実行コマンドを記載してください。

ChatGPT出力例

**JSDocを使用したコードドキュメントの自動生成ガイド**

1. **JSDocのセットアップ手順**
- Node.jsプロジェクトのルートディレクトリで以下のコマンドを実行してJSDocをインストールします。
npm install -g jsdoc

2. **ドキュメンテーションコメントの書き方**
- 関数やクラスに対して、JSDocコメントを追加します。以下は関数の例です。

```javascript
/**
* 2つの数値を加算します。
* @param {number} a - 最初の数値
* @param {number} b - 2番目の数値
* @returns {number} 加算結果
*/
function add(a, b) {
return a + b;
}
```
このガイドに従って、JSDocを使用してコードドキュメントを自動生成し、プロジェクトの理解を深めましょう。

応用シーン

1. 新メンバー向けオンボーディング: プロジェクトに新しく参加したメンバーがコードベースを理解するためのドキュメントを迅速に作成する際に使用できます。これにより、オンボーディングの効率が向上します。

2. コードメンテナンス: 長期的なプロジェクトで、コードのメンテナンスが必要な場合、最新のドキュメントを常に維持するために、ドキュメントの自動生成を行うことで効率化を図ります。

9. パフォーマンスボトルネックの特定

使用シーン

エンジニアがアプリケーションのパフォーマンス問題を診断し、ボトルネックを特定するためにプロファイリングを行う際に使用します。特に、アプリケーションのレスポンスタイムやリソース消費が問題となっている場合に役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすパフォーマンスボトルネックの特定手順を提案してください。

- アプリケーションのタイプ: Webアプリケーション
- 使用ツール: Chrome DevTools
- 提案する手順には、1. プロファイリングの実行方法、2. 結果の分析方法、3. 改善策の提案を含むこと。
- 各ステップには、具体的な操作方法と結果の読み方を記載してください。

ChatGPT出力例

**パフォーマンスボトルネックの特定手順**

1. **プロファイリングの実行方法**
- ChromeブラウザでWebアプリケーションを開きます。
- 「F12」キーを押してChrome DevToolsを開き、「Performance」タブを選択します。
- 「Record」ボタンをクリックしてプロファイリングを開始し、アプリケーションを操作します。完了したら「Stop」ボタンをクリックします。

2. **結果の分析方法**
- タイムラインで、スクリプトの実行時間が長い箇所や、頻繁にリクエストが発生している箇所を特定します。
- メモリ使用量のグラフを確認し、メモリリークの可能性があるかどうかを評価します。

3. **改善策の提案**
- 長時間実行されているスクリプトが見つかった場合、その部分のコードを最適化します。不要なループや重複した計算を削減します。
- メモリリークが疑われる場合、メモリ管理を見直し、不要なオブジェクトの参照を削除します。
- 例:
```javascript
// 不要な計算を減らす最適化例
let result = computeHeavyTask(); // ループ外に移動
for (let i = 0; i < array.length; i++) {
array[i] += result;
}
```

これらの手順を使用して、Webアプリケーションのパフォーマンスボトルネックを特定し、改善策を実行してください。

応用シーン

1. アプリケーションパフォーマンス最適化: パフォーマンス最適化のトレーニングセッションで、具体的なプロファイリング方法と最適化手法を学ぶための教材として使用できます。

2. デバッグセッションの効率化: チームで行うデバッグセッションの際に、パフォーマンス問題を迅速に解決するためのガイドラインとして使用できます。

10. バージョン管理のベストプラクティス

使用シーン

エンジニアがチーム全体でバージョン管理を効率的に行い、コードベースの整合性を保つためにベストプラクティスを共有する場合に使用します。特に、大規模なプロジェクトでの複数メンバーによる共同開発において役立ちます。

プロンプト例

あなたはソフトウェアエンジニアです。以下の条件を満たすバージョン管理のベストプラクティスを作成してください。

- 使用ツール: Git
- ガイドラインには、1. コミットメッセージの書き方、2. ブランチ戦略、3. プルリクエストの作成方法を含むこと。
- 各セクションには具体的な例とアドバイスを記載してください。

ChatGPT出力例

**Gitバージョン管理のベストプラクティス**

1. **コミットメッセージの書き方**
- コミットメッセージは短く、変更内容を明確に示すこと。
- 例: `git commit -m "Fix: 修正されたバグ#1234に関連するエラーハンドリングを改善"`
- 一貫した形式を使用し、プロジェクト全体で統一されたメッセージスタイルを維持します。

2. **ブランチ戦略**
- 基本ブランチとして「main」を使用し、すべてのリリース可能なコードがここに集約されるようにします。
- 機能追加やバグ修正の際には、新しいブランチを作成します（例: `feature/新機能名` または `bugfix/バグ名`）。
- ブランチをマージする際には、レビューを行い、コードがメインブランチと互換性があることを確認します。

3. **プルリクエストの作成方法**
- プルリクエスト（PR）を作成する際には、変更内容とその背景を簡潔に説明します。
- 例: 「このPRは、バグ#1234の修正を目的としています。変更点としては、エラーハンドリングの改善とログメッセージの詳細化を行いました。」
- PRをレビューする際には、コードの品質とテストカバレッジに注目し、必要に応じて修正を依頼します。

このガイドラインを活用して、チーム全体で一貫したバージョン管理を行い、コードベースの品質を維持しましょう。

応用シーン

1. チーム開発の効率化: チーム全体で一貫したバージョン管理を行うことで、コードベースの競合を減らし、開発プロセスの効率を向上させることができます。

2. コードの信頼性向上: バージョン管理のベストプラクティスを徹底することで、コードの変更履歴を明確にし、問題発生時に迅速に対応できる体制を整えることができます。