いい質問の仕方

効率的に問題を解決し、自分の成長に繋げるための質問の仕方について。

エンジニアとして働く上で、わからないことは必ず出てきます。
その際に、効率的に問題を解決し、自分の成長に繋げるためには、適切な質問の仕方が重要です。

また、適切な質問ができると、チーム全体の生産性向上にも繋がります。

下記内容を参考に、いい質問の仕方を身につけましょう。

いい質問とは

いい質問とは、問題を具体的に説明し、回答者が適切に対応できるように必要な情報を提供する質問です。

質問に回答するエンジニアは魔法を使って答えを導き出しているわけではなく、与えられた情報から推測を重ねているだけなので、質問には必要な情報を提供することが重要です。

  1. 具体的であること:問題の詳細や状況を明確に説明します。
  2. 自分で試したことを伝える:何を試し、どのような結果になったのかを共有します。
  3. 期待する結果を示す:何を達成したいのかを明確にします。
  4. 関連するコードやエラーメッセージを提供する:問題を再現できる具体的な情報を提供します。

いい質問と改善の余地がある質問

以下に、いい質問と改善の余地がある質問の例を示します。

いい質問

ローカル環境でサインインページで「Googleでサインイン」ボタンを押すと、以下のエラーが発生しました。

<エラー内容>

ログを確認し〇〇が原因だと考えて以下の手順を試しましたが、エラー内容は変わりませんでした。

<手順、エラー内容、参考URLなど>

検証環境や本番環境では問題なく動作しているため、ローカル環境でのみ発生している問題と考えています。
サインイン後のユーザー情報を取得する処理を実装しているため、この問題を解決したいです。
この問題の解決方法がわかる方、アドバイスをいただけますでしょうか?
  • 問題の詳細: ローカル環境でのみ「Googleでサインイン」ボタンを押すとエラーが発生することを明確に説明。
  • 自分で試したこと: ログを確認し、原因に目星をつけて試した手順を共有。
  • エラーメッセージ: エラー内容を明確に示し、参考URLも提供。
  • 期待する結果: サインイン後のユーザー情報を取得する処理を実装するため、この問題を解決することが必要であることを示す。

改善の余地がある質問

サインインができませんでした。どうすればいいでしょうか?
  • 問題の詳細が不明:具体的なエラーや状況がわからない。
  • 自分で試したことが不明:何も試していないか、試したのか、その結果がわからない。
  • 期待する結果が不明:何を達成したいのかがわからない。

質問テンプレート

エラーの解決方法がわからない場合のテンプレート

## 質問内容

ローカル環境でサインインページで「Googleでサインイン」ボタンを押すと、以下のエラーが発生しました。
この問題の解決方法がわかる方、アドバイスをいただけますでしょうか?

### エラーメッセージ

```
エラーメッセージの内容
```

### 該当するコード

sign_up_page.dart
```dart
コードの該当部分
```
再現できる Draft PR のリンク: [リンク](https://github.com/altive/xxx/pull/123)

### エラーが発生するまでの手順

1. 手順1
2. 手順2
3. 手順3

### 試したこと

ログを確認し、〇〇が原因だと考えて以下の手順を試しましたが、エラー内容は変わりませんでした。

1. 手順1
2. 手順2
3. 手順3

参考URL
- [リンク](https://example.com)

### 環境

- OS: Android
- アプリ環境: ローカル

### 期待する結果

サインイン後のユーザー情報を取得する処理を実装するため、サインインができるようにしたいです。

進め方がわからない場合のテンプレート

## 質問内容

https://github.com/altive/xxx/issues/123
上記 Issue にて新しい機能フラグを追加しようとしていますが、どのような手順で進めればよいかアドバイスをいただけますか?

### 現在の状況
- 機能フラグについての概要を把握。
- Remote Config で機能フラグを管理していることを把握。

### 試したこと
- 機能フラグについて記載されている以下の記事を読んでみたのですが、具体的な手順がわからないため、進め方がわかりませんでした。
  - [リンク](https://example.com)

### 期待する結果
機能フラグを追加するための具体的な手順や参考になるソースなどがあれば教えていただけると助かります。

質問する際の心構え

魚の釣り方を学ぶ

「魚をくれ」ではなく「魚の釣り方」を教わるようにしましょう。答えを教わる方が手短に済みますが、それでは成長には繋がりません。

自分の成長を考えて、どのように原因を探るかを尋ねるようにしましょう。

問題が解決したときには報告する

質問に答えてもらったらお礼を言うだけでなく、「どうやって解決したか」を報告することが大切です。

これにより、回答者も学びを得ることができます。

参考資料

以下、本ページを作成するにあたり参考にした記事のリンクです。
本ページには記載されていない情報も含まれているため、ぜひ参考にしてください。