質問する際のテンプレート

前に教育についての記事を書いたが、そういえば質問をする際のテンプレートをあげても全く使われなかったなと思い出したので、供養もかねて記事にしようかなと。

---

テンプレートはこんな感じです。

解説

何の案件かの情報を書く

会社によりますが、質問先の人は別の案件をやっていることもあります。

少なくとも別の機能に携わっていることが ほとんどかと思います。

なので、どの案件のどの機能のことか情報を共有することでわかりやすくなり、相手の負担を減らせます。

ここを書かないとどの案件の話か逆質問が来て時間がかかることがあります。

何を実現したいのか書く

現在、OOしたいと考えているのですが、以下のエラーが出てしまいます。

ここはほとんどの人が書くかなと思います。

注意点は目的と手段を間違えないことです。

視野が狭くなるとOOができればこの機能は実装できると思って「OOの関数を使うとエラーが出て困ってます」みたいになるかと思いますが、そうではなく「CSV出力したいので、readfileの関数を使って出力しようとしたらこのエラーが出てうまくいきません」

このような書き方をするとそもそもreadfileの関数ではなく別の関数を使う必要があったときなどに、早く正確な回答を得ることができます。

しかし、前者の質問を使うとOOの関数に限った回答になってしまいがちで間違った回答になる可能性があります。

試したことと結果を書く

OOが原因かと思い、OOを行ってみたのですが別のエラーが出てしまいました。

ここのポイントは、時間の節約と自分の成長の２点です。

質問した相手も同じことを考えることもあるので、何をやってどうだったか書くことで時間の節約になります。

それと同時に、自分の考え方も相手にわかるので、考え方が間違っていた場合は指摘してもらえることが多いです。（ここはOOって考えるんじゃなくてXXって考えだよみたいな）

自分の経験のみに頼るより、先輩からの意見も取り入れた方が早く成長すると個人的には考えています。

---

こんな感じで質問をすると質問される側は助かりますし、質問する側はわかりやすいといい評価をしてもらえるかと思います。