お疲れ様です。○○について質問させてください。
【状況】
現在、○○モジュールの修正作業中で、XX関数の挙動を調査しています。
【やりたいこと】
○○を行うための処理フローを把握したいと考えています。
【試したこと】
・ソースコードを追った結果、XX.c の 42行目で処理が分岐しており、ここが関係していると予想
・Gitログを確認し、2022年のコミットで追加されたことは確認
【質問内容】
この部分の処理フローについて、以下の理解で合っていますでしょうか?
→ 処理は A → B → C の順で進み、XX関数はその中でBに該当する
もし認識が誤っていたら、ご指摘いただけますと幸いです。
お忙しいところ恐れ入りますが、ご確認いただければ幸いです。
補足:一言つけると印象が良くなるフレーズ
「もしお時間あるときに見ていただければ大丈夫です」
「もし別の資料など参照すべきものがあれば教えていただけると助かります」
○○の件で詰まっています。
【やりたいこと】
→ ○○を実現したいと考えています。
【現在の状況】
→ △△という方法を試しましたが、□□というエラーが出ました。
【環境】
→ OS: ○○ / 言語: ○○ / フレームワーク: ○○
【調べたこと・試したこと】
→ Googleで「○○ エラー名」で検索し、公式ドキュメントを確認しましたが解決に至りませんでした。
【お願いしたいこと】
→ このエラーの解決方法、または別の実現手段があれば教えていただきたいです。
【やりたいこと】
【現在の状況】
【環境】
【調べたこと・試したこと】
【お願いしたいこと】
よくあるパターン別テンプレート
- エラーが出たとき
○○の実装中に以下のエラーが発生しています。
【エラーメッセージ全文】
→ (ここに貼り付ける)
【再現手順】
→ △△という操作を行うと、エラーが出ます。
【試したこと】
→ ○○を変更してみましたが、改善しませんでした。
【エラーメッセージ全文】
【再現手順】
【試したこと】
2.設計や方針がわからないとき
○○をどう設計すべきか悩んでいます。
【前提】
→ ○○のような要件があります。
【自分の案】
→ △△の構成を考えましたが、拡張性やパフォーマンスに不安があります。
【相談内容】
→ 他に考えられる構成やベストプラクティスがあれば、ご意見いただきたいです。
【前提】
【自分の案】
【相談内容】
✅ コードレビューをお願いしたいとき
書いたコードのレビューをお願いできますか?
【目的】
→ ○○の機能を実装しました。
【ポイント】
→ △△の処理の書き方に自信がなく、より良い書き方があれば知りたいです。
【対象ファイル】
→ filename.js(該当箇所にコメントを付けています)
【知りたいこと】
→ 処理の効率性やコードの可読性についてアドバイスいただけると助かります。
✅ 仕様の意図や背景を知りたいとき
○○の仕様について確認させてください。
【対象の仕様】
→ ○○画面の「△△ボタン」を押すと□□が実行される仕様です。
【背景】
→ 他の画面では似たようなボタンが別の処理をしています。
【確認したいこと】
→ この違いには何か意図や背景がありますか?
✅ 誰に質問していいかわからないとき
○○について詳しい方、いらっしゃいますか?
【困っていること】
→ △△の設定ファイルに関する仕様が不明で手が止まっています。
【やりたいこと】
→ 設定ファイルを変更して□□を実現したいです。
【知りたいこと】
→ この辺りに詳しい方、または過去に対応したことがある方がいれば、少しお話を伺いたいです。
✅ ドキュメントを読んでもわからないとき
ドキュメントを読んだのですが理解できず、補足いただけないでしょうか?
【参照したドキュメント】
→ https://example.com/docs/○○
【わからなかったポイント】
→ 「XX」という記述が抽象的で、具体的に何を指しているのかが不明です。
【やりたいこと】
→ 実装にあたって正確に仕様を理解しておきたいです。
✅ 雑談チャットでのカジュアル質問(フランクVer)
ふと疑問に思ったんですが、○○ってみなさんどうしてます?
【背景】
→ △△のタスクでちょっと悩み中です。
【聞きたいこと】
→ この辺、みなさんの工夫とかあれば聞いてみたいです!
まとめ
質問にも「設計」があります。相手がすぐに「なるほど、それなら○○ですね」と答えられるように、背景・状況・試行錯誤・目的を明示することが大切です。