アンチパターンから学ぶ！先輩エンジニアへの3つの質問のコツ（テンプレート付き）

社会人にとってのコミュニケーション能力とは、飲み会を盛り上げられる人のことではありません。
要件を正しく伝える、正しく理解する、相談しやすい雰囲気を作るなど、
仕事を円滑、かつ正確に進めるための会話術が社会人におけるコミュニケーション能力です。

エンジニアの多いZennですから、
今回はその中でも 『先輩エンジニアへの質問の仕方』 にフォーカスします。

3つの質問のコツ

以下の3つの質問のコツを押さえれば、先輩エンジニアは快く答えてくれるでしょう。
なお、今回はSlackなどのコミュニケーションツールでのやり取りを想定しています。

1、状況を正確に伝える

アンチパターン

「Vue CLIでSass使おうとしたんですけど、上手く動きません。何が原因でしょうか？」

🤦🏻
これだけじゃ何が動かないのかよくわかりませんよね。
先輩エンジニアは回答に困るでしょう。

「まず、ターミナルの話よね？
うまく動かないってエラーが出てるってこと？
どんなエラー？てか、まずググってみた？
ググったらどうだった？解決できる内容なかった？」

先輩エンジニアの頭の中はいっぱいいっぱいです。
でも、逆に言えば後輩くんはこれらに気をつけて質問すれば良いのです。

ちょっと改善版

「Vue CLIの4系でSassを動かそうとしたんですが、ターミナルで以下のエラーが出ました。

Syntax Error: ValidationError: Invalid options object. Sass Loader has been initialized using an options object that does not match the API schema.

ググったら、vue.config.jsを修正する必要があるらしいのですが、それをしても直りませんでした。
他にどんな原因が考えられますか。」

ここまで書いてくれれば及第点ですね。
実際にエラー文があると、相談された側としても分かりやすいですし、
一度ググってダメだった方法がわかれば、先輩エンジニアも同じ轍を踏まなくて済みます。

先輩「公式ドキュメントのこのやり方で解決するんじゃない？」
後輩「あ、それやってみたんですけど、ダメでした。エラー変わりません。」
先輩「もうやったんだ……言ってくれたら良かったのに……」
という事態を防げるわけです。

2、読みやすく伝える

次は説明の書き方についてです。
プログラミングは専門用語もありますし、自分の言葉にして説明するのって難しいですよね。
その場合は文章ではなく箇条書のほうが上手く伝わります。

アンチパターン

「コーポレートサイトの構築の件です。
WordPressで記事一覧を表示したいのですが、真っ白なままうまく表示されません。
archive-news.phpを作成したところまではいいんですが、その中のループがおかしいのでしょうか。
一応、index.phpにも似たような記述があったのでそれを参考にしようとしましたが、ただそのまま移すだけでは動かないようです。
CPT UIでカスタム投稿タイプは作成し終えています。」

長いですね。

聞きたいことがなにか、ハッキリ分かるようにもっとシンプルにしましょう。

ちょっと改善版

■困っていること
・カスタム投稿タイプ（news）のループが表示されない

■トライしたこと
・index.phpの似たような処理をコピペでもってきた
・プラグインのCPT UIですでにカスタム投稿タイプは作成済み

スッキリしましたね。
■などの記号も効果的に使いましょう。見出しがどこなのか分かりやすいです。

3、環境や自分の意見も伝える

使っている環境は非常に大事です。
バージョンが違うことで解決方法のアプローチも変わってくるからです。

また、自分の意見を伝えることですが、これには2つ意味があります。

1つ目は、自分で考える癖をつけること。
聞いてばかりじゃなくて、ちゃんと自分で考えるステップを踏まなければエラー解決能力は上がりません。
2つ目は、問題の切り分けを行うこと。
「XXXはすでに試したのですが、それでもエラーが変わらなかったので原因はファイルではなく、ソースコードにあるようです。」
などのように、原因究明のためにも自分の予測を書いておくことは大切です。

また、補足ですが言葉だけでは伝わらない場合、スクリーンショットを添付するのも大変有効な手段です。

その他

「書いた関数が動かない！」とかであれば、GitHubのPull RequestのURLを送るのがベターです。
関数の部分だけコピペするのはNGです。
関連した他の関数や変数がわからないため、問題解決に至らない場合があります。
関数が動かないのは、関数以外の場所に原因があるかもしれませんからね。

ベストプラクティス

■困っていること
・ローカルでWordPress構築中だが、画像がなぜか表示されない
( スクショ：https://gyazo.com/XXX )

■環境
・MAMP
・PHPのバージョン7.2.8

■トライしたこと
・画像のパスが間違っていないか再度確認した
・フォルダの中に該当する画像ファイルがあることも確認した

■備考
画像のパスも間違っていないし、実際に画像もあった。
なので、ソースコードやファイルの設置などは問題ないはず。
MAMPやローカルでの環境特有の症状かもしれない。

たぶん、ここまでちゃんと書けたらもう先輩エンジニアは言うことありません。
満面の笑みで丁寧に教えてくれるでしょう。

質問の仕方テンプレート

以下、質問するときのテンプレートです。
先輩エンジニアに質問するときに使用してください。

■困っていること
・
( スクショ：URL )

■環境
・

■トライしたこと
・

■備考・考察
・