プログラミングの質問方法のテンプレートについてまとめました。

質問テンプレート

1. 今やりたいこと
2. 今の表示画面（またはエラー画面）のスクリーンショット
3. コード
4. 試したこと
5. ログ（あれば）
6. その他参考にしたサイトの URL

今やりたいこと

今やりたいことを一言で表現しましょう。

例

1. ⚪︎⚪︎ というエラーを解決したいです。
2. 画像のダウンロード機能を実装したいです

今の表示画面（またはエラー画面）のスクリーンショット

画面のスクショはとても情報量が多いです。

エラー文を文字で要約されるのは本当に迷惑で、要約せずにそのまま送信するのが当然なのですが、エラー文の前後やその他画面の情報には色々なヒントがあるため、スクリーンショットで共有するのが一番良いと思います。

簡単ですしね。

例えば、「画面が表示されない」というバグに対してスクリーンショットを共有すれば「そもそも今開いている URL が違う」という単純なミスを指摘できたりします。

文字での共有だとそれができません。

また「構文エラー」と要約されたエラー情報も、エラー画面のスクリーンショットを見たら例えば

「HomeController の 45 行目の記述で構文エラーが起きています」

と具体的に返せたりします。

プログラミングに慣れれば慣れるほど画面から受ける情報量は多くなり、解決できるようになります。

コード

実際に書いたコードを送ります。

できるだけ今回の実装に関係があるコードだけ送るようにした方が良いですが、迷ったら多めに送って良いと思います。

試したこと

出力結果や、試行錯誤した結果を共有しましょう。

エラーの場合、新規のコードでバグが発生したのか、作業中にもともと動いていたコードでバグが発生したなど、時系列込みで説明できる方が伝わりやすいです。

例：

認証を実装するためにコマンドを打っていったらエラーになりました。

php artisan ***
php artisan ***
php artisan ***
php artisan *** //ここでエラー

configファイルを**に変更してもう一度実行しましたが、エラー文は変わりませんでした。

悪い例：

php artisan *** //エラー発生

ログ（あれば）

どんなエラーが発生しているのかは、ログを見るとわかる可能性があります。

特に非同期に JavaScript でサーバーに通信している際にサーバーでエラー発生している時とかログを見る必要があります。

プログラムを実行した結果どんなログが出力されたのか、ブラウザのコンソールの情報含めログは送信しましょう

その他参考にしたサイトの URL

今回実装するにあたって参考にしたサイトの URL を添付します。

回答者側の悩み

できるだけ推測での回答を避けたい、というのが回答者側の悩みです。

回答者は、エラーの内容を推測するところからではなく、「質問者がどんなことをした結果これが表示されたのか」を推測するところから始まるので、できるだけ質問者がどんなことをしたのか推測しなくて済むように、情報を渡しましょう。

コードはコピぺしたい

コードの共有は回答者がコピーペーストできるように、テキストで渡しましょう。

スクショでコードを渡すと、コピペでベースを作ってから回答ができなくなります。

エラー画面はスクショ

画面の情報というのはかなり情報量が多いです。

今はコミュニケーションアプリが使いやすくなり画像の共有は当たり前に使える時代なので、スクショで共有するのが一番楽だし共有としてベストだと思います。

まとめ

質問テンプレートを作ってみました。

プログラミングを始めたてでも分かりやすい質問する方も多く、未経験なのにすごいと思います。

たまにステータスコードだけで、「エンジニアならその情報で解決できるはずだ」と言われたりしますけど、そんな人は少数ですね。