質問の仕方
質問の仕方がよくなかったので、質問の仕方をまとめてみた。
質問する場面
15分頑張っても解決できない時 ただし、質問内容を考えるのは倍以上の時間をかけて精査すること そこまでしても、回答を頂ければその時間は回収できるし、何より回答者の時間を奪わない
フォーマット
可能な限り、以下のフォーマットに従って質問する。
## 質問概要 ※2行以内で簡潔に書く（書けなければ、別のQAにできないか考える） ## 詳細 ### 目標 あるべき姿を記述する ### 現状の問題 - エラーなどを見やすく抜粋してコピーして貼る - とりあえず、ログの内容はしっかり理解すること - 必ず、自分や他の環境で再現するか検討する - スクリーンショットは回答者が調べにくいため、貼らない ### 背景 なぜその問題を解きたいか ### やったこと - 何ができて、何ができないかを明確にする - コードが長くなり過ぎないように貼る - もし、長くなるなら、そもそも問題を簡略化できないか？、必要ないコードまで貼り付けていないか？を考える - GitHub やGist にて共有も考える ### 考えたこと - 問題に関して、なぜ問題が起きたかの自分なりの考えを記述する - 問題は分割して、１ステップずつ考えたことを書く ## 補足 ### 調べたこと - 今把握している知識を簡単に書く - 必ず公式ドキュメントを読む ### 試したこと 問題解決に向けてしたことやデバッグ結果を書く。 ### 実行環境やフレームワークについて 相手の手元で再現できる情報を記載する。
質問時のチェック項目
質問する前に確認する項目
- [ ] フォーマット通りかけているか？ - [ ] ChatGPTに確認したか？ - [ ] 読む側の視点に立って、うっと思わないか？ - [ ] 読む側の視点に立って、言いたいことを推測するようにエスパーさせてないか？ - [ ] 質問の背景やなぜ知りたいかを明記されているか？ - [ ] 可能なら、回答者のメリットやどうタメになるかを書く - [ ] QAをスマホで見ても、見にくくなってないか？ - [ ] そもそも、回答者が回答したいと思う文面になっているか、もう一度確認する - [ ] 質問する前に一息ついて、見直す
質問した後
- [ ] 必ずお礼を言う - [ ] 再度質問する時も、上記の内容を確認する - [ ] 解決結果を伝える
参考にした記事
バグなどの謎の現象に立ち向かうも闇が濃く、どうしても沼から脱出できない時に見るフローチャート - Thanks Driven Life
恥ずかしがらずにオープンな場で積極的に質問していきましょう、という話 - give IT a try
【初心者ITエンジニア向け】上手な質問は「相手にエスパーさせない質問」です - give IT a try
質問は恥ではないし役に立つ - Qiita プログラマーに嫌われない質問術！プログラミングスキルアップに繋がる最高の質問のための3ポイントを紹介 | 東京フリーランス
teratail【テラテイル】｜ITエンジニア特化型Q&Aサイト
学習効率をグッとあげる質問の仕方 | Take off Rails
