困った時に使う、質問フォーマットの紹介

はじめに

自分で必死に調べてもわからないこと、ほんとに沢山あります。
諦めることができるならそれも手ですが、お仕事となったらそうはいきません。

わからないことを聞くために、誰か知見のある方に質問することになるでしょう。

きっとそんな時に役に立つ、僕が使っている質問のフォーマットを紹介します。

質問フォーマット

こちらが質問のフォーマットです。

- 概要(一言)
- 質問内容
- 目的
- 自分で調べたこと

使用例はこちら

お疲れ様です。

(概要)
VSCodeのフォーマッターについて質問です。

(質問内容)
VSCodeでファイルを保存した時に、自動でフォーマットをする設定の方法をご存知でしょうか？

(目的)
私はコードのインデントを修正する際に、都度ショートカットキーを押してインデントを修正しています。  
しかしこのやり方だと、ショートカットキーを押し忘れてしまうことがあり、
インデントが乱れてしまったまま放置してしまうケースが発生しまうことがあります。
そこでフォーマットし忘れを防止するため、
ファイルの保存時に自動でフォーマットを揃える機能を導入したいと考えております。

(自分で調べたこと)
「vscode formatter」などのキーワードで調べてはみましたが、
自動フォーマットの設定方法に関しての情報はまだ取得できていない状態です。

お時間がある時で結構ですのでコメントいただけると助かります。  
お手数ですがよろしくお願いいたします。

解説

内容について解説します。

概要

何についての質問なのかを説明するための項目です。
最初に何についての話なのかを伝えることで、相手に質問に対するメンタルモデルができます。
これにより、この後の項目の内容が相手に理解してもらいやすくなります。

質問内容

相手に聞きたいことを説明するための項目です。
この部分を長文で書くと相手に伝わりにくくなってしまうので、なるべく端的にまとめると良いと思います。

目的

どんな問題を解決するためなのかを書く項目です。
相手に目的を伝えることには、自分にとっても相手にとってもメリットがあります。

• 相手が思考する量を減らすことができる
• 質問相手が解決方法を絞り込みやすくなる
• 自分が質問した内容より、高次元の解決方法が獲得できる可能性がある。

これらのメリットを享受するため、必ず相手に意図を伝えるよう心がけましょう。

自分で調べたこと

自分で調べたことを書く項目です。

質問内容に関して、情報不足や相手にとっても未知のケースだった場合、質問に対応するため相手自身にも調査をしてもらう場合があります。その際に自分の調べたことを共有することで、相手に調査してもらうコストを大きく下げることができます。

そもそも質問をするという行為は、自分の作業コストを相手に一部移譲していることに他なりません。

もちろん課題の解決のために必要な行為であることは確かですが、相手にとっては迷惑をかけているという側面は間違いなくあります。

なるべく相手にコストをかけさせないために、自分で調べたことはもれなく共有するようにしましょう。

さいごに

質問が必要な時というのは、自分が困っている時です。
困っている時というのは、えてして頭が混乱しており、質問をまとめる際に苦悩することも多いでしょう。

そんな時に質問のフォーマットがあると、何もない時に比べて効率よく質問内容をまとめることができます。

このフォーマットやその他のフォーマットを利用して、質問を活用し、どんどん問題を解決していってください。