最近、プログラミングやサーバー関係のことを学習していて分からないことがあれば、スタック・オーバーフローで質問をしています(stackoverflowの日本語版)。2019年3月5日に初めて質問してから、3月28日までに11回の質問をして、おおむね解決にいたっています。
スタック・オーバーフローで質問をするときのコツ
自分で言うのも何ですが、質問を見てくださった方が、なるべく「回答しやすい質問文」を書いているつもりです。その「回答しやすい質問文」はいくつかコツがあります。今回の記事ではそのコツについてご紹介いたします。
質問は1つだけにする
1つの投稿でする質問は1つだけにしましょう。解決したいことが複雑な場合、一度バラして最初から順番に質問することをおすすめします。
質問の経緯を明らかにする
スタックオーバーフローで質問をするということは、「ブラウザやターミナルの画面などでエラー表示が出た」、「意図通りの動作をさせることができない」などの問題が発生していることになります。
スタック・オーバーフローで質問するときには、その問題にいたった経緯を明らかにしましょう。具体的には以下の4つのことを行ってその結果を質問文の中で明記します。
1.該当するプログラミングコードを明らかにする
問題が発生するプログラミングコードを質問する文章に挿入します。マークダウン記法で”“`”を使うと、コードの引用を表すことができます。もし比較的長いプログラミングコードを示したい場合は、GitHubでコードを公開してそのリンクだけを質問の文章内で示すことも有効な手段でしょう。
2.デバッグをする
JavaScriptであれば”console.log”、PHPであれば”var_dump”といった変数値・配列値などを確認するメソッドがあります。問題がありそうな箇所の前後にこれらのメソッドを明らかにして、どういう値が入っているか確かめたことを、質問文の中で記述しておきましょう。
3.公式ドキュメントを確認したかを確認する
問題がありそうな箇所について、公式ドキュメントの用例と比較を明示しておきましょう。公式ドキュメントのどこを確認したかを明記しておくと、質問文を見かけたときに回答をしやすくなります。
もしどうしても公式ドキュメントとの比較が難しい場合は、書籍との比較やGoogle検索でヒットしたブログ記事との比較について記述しておきましょう。
4.スクリーンショットをはる
問題があるプログラミングコードによって、本来意図しない動作がローカル開発環境やターミナルコマンドなどに表示されます。その表示内容をスクリーンショットにして、質問文と一緒に投稿しましょう。
「質問力」の鍛え方
以上、スタック・オーバーフローで質問をするときのコツをまとめてみました。ただ初めてプログラミングの学習をする方にとって、スタック・オーバーフローで質問をすること自体が難しいかもしれません。
ただしスタック・オーバーフローにおける回答は有志の方が行われています。主旨や経緯が明らかになっていない質問は敬遠されて、回答を得られないかもしれません。
ドットインストールで質問力を鍛える
「そもそも質問するための文章をどうやって書けばいいのか分からない」と言う初心者の方は、ぜひドットインストールの有料会員に登録しましょう。
有料会員に提供されるプレミアムサービスの1つとして、月に5回までの「質問サービス」があります。「質問サービス」はレッスン動画に関して分からないことがあれば、「ドットインストールのなかのひと」に質問することができるというサービスです。
質問に関する補足説明する力を鍛える
プログラミングの学習をはじめる方は、いきなり「質問の主旨を明確にしてください」と言われても戸惑うことがあるかもしれません。
その点、ドットインストールの「質問サービス」では、主旨がはっきりしない質問でも補足説明として何が不足しているか、少しずつヒントを与えてくれます。そのヒントにもとづいて、質問に関する補足説明を自分で見つけていくというスタイルです。
ドットインストールの先生に「質問のしかた」について指摘されることがなくなっている頃には、スタック・オーバーフローでも回答がいただける質問を投稿できるようになっていると思います。