エンジニアの質問の仕方|何が分からないか分からないときの相談例

仕事・チーム開発

エンジニアの質問の仕方|何が分からないか分からないときの相談例

「何が分からないの?」と聞かれても、そこを説明できない。画面とコードを行き来しているうちに、質問文を書く手まで止まってしまうことがあります。

そんなときは、原因を言い当てようとせず、「何をしたいか」「どの操作で止まったか」「何が見えているか」を送ってみてください。どこから調べればよいかを一緒に決める相談も、仕事を進めるための質問です。

この記事では、架空の問い合わせ管理を題材に、まだ整理できていない段階と、少し調べた後の段階で使える相談文を紹介します。例に出てくる「件名は必須・1〜100文字」は説明用の仕様であり、実際の職場のルールではありません。

最初の相談は、分かる三つだけで送れる

問い合わせの登録画面に件名を追加するよう依頼されたものの、保存する処理がどこにあるのか分からないとします。ここで「保存処理を調べてから聞こう」と考えると、まさに分からないことを質問の前提にしてしまいます。

次のくらいの文面でも、相談は始められます。

問い合わせの登録画面に、必須の件名を追加したいです。 画面の入力欄は見つかりましたが、登録ボタンを押した後の保存処理を追うところで止まっています。 今見ている画面とファイルを共有するので、最初に追う場所を一緒に確認してもらえますか。まだ調べる言葉も整理できていません。

ファイル名が分からなければ、「今見ている場所を画面共有できます」で構いません。エラーが出ていない場合に、無理にエラーメッセージ欄を埋める必要もありません。

「調べる場所を教えてほしい」「この資料の読み方を確認したい」「まず状況整理を手伝ってほしい」のように、今ほしい助けを一言加えると、相手は答え方を選びやすくなります。

相談は、整理できた分だけ具体的にする

相談は目的と現状から始め、調査結果、自分の案を分かった範囲で追加する三段階。
仮説がなくても最初の段階から相談できる。

最初から完成した質問を作る必要はありません。ここでは、相談の中身を三つの段階に分けてみます。

今の状態送る内容求める助け
調べ方も分からない目的・止まった操作・見えている結果調べ始める場所を決める
いくつか調べた試したこと・その結果・残った疑問次に確認する候補を絞る
方針を考えた自分の理解・案・迷っている理由理解や判断が合うか確かめる

これは進級表ではありません。別の機能を任されたら、また最初の段階から相談してよいのです。「仮説を書けないから送れない」とならないよう、分からない項目はそのまま伝えます。

また、長い説明が作れたからよい質問とも限りません。相手に最初に見てほしい情報が埋もれていれば、冒頭に一文足す方が役に立ちます。

少し調べた後は、操作と結果を組にする

同じ問い合わせの改修で、登録処理の入口は見つかったとします。件名を空にしても保存されるので、入力チェックの場所を調べたものの、どこを変更すべきか決められません。

件名を必須にする改修で、入力チェックを置く場所を相談したいです。 手元の開発環境で、件名を空にして登録すると保存されました。 画面の登録処理と、保存を受け付ける処理を読みましたが、既存の必須チェックがどこにまとまっているか判断できていません。 画面だけ直すと別の入口から空の件名が保存される可能性があると考えています。既存の実装で参考にする機能を教えてもらえますか。

この文面の「保存された」は観察した結果で、「別の入口から保存される可能性」は仮説です。二つを分ければ、まだ調べていないことまで確認済みに見せずに済みます。

試したことは「いろいろ調べました」よりも、「どこを見たか」「何を試したか」「何が分かったか」の組で書くと、同じ調査を繰り返すかどうか判断できます。検索したページを全部並べる必要はありません。今の疑問に関係するものから添えましょう。

環境の違いが影響しそうなら、手元の開発環境なのか共有の検証環境なのか、参照している作業版はどれかを加えます。値が分からなければ「環境名の確認方法も教えてほしい」と書けば、次に確認する対象になります。

何分調べたら聞くかは、作業の影響で決める

「まず30分調べる」といった目安を使うチームもありますが、すべての状況に同じ待ち時間を当てはめると困ります。期限が迫っている作業や、ほかの人を待たせている作業では、早い共有が必要になるからです。

たとえば、今日中に方針を決めないと明日の確認に進めない場合は、原因が分かる前でも「方針の確認が必要です」と知らせます。本番データの変更や権限の扱いなど、操作してよいか分からない場合も、試行を増やす前に担当者へ確認します。

一方、期限に余裕があり、自分の環境で調べられる範囲なら、「まず関連する処理を一つ追い、進めなければ相談する」と区切れます。大切なのは、時間が過ぎたことだけで判断せず、次に確かめる対象があるか、作業への影響が出始めているかを見ることです。

最初の依頼時に、相談先、連絡手段、反応がないときの代わりの相手、途中経過を共有する時点を確認しておくと、迷いを減らせます。相手が集中している時間にはチャットへ残すなど、チームの約束も使ってください。

ログや画面は、相談先に見せてよい範囲で

相談のために画面やログを添えることはありますが、必要な箇所だけに絞ります。顧客情報、パスワード、トークン、個人の連絡先などが映っていないか確かめてください。社内の情報を公開掲示板や外部サービスへ貼ってよいとは限りません。

内容を隠しすぎて現象が伝わらなくなる場合は、共有が認められた場所で見てもらうか、架空の値で再現できるかを相談します。加工したログを原文のままの記録として渡さず、伏せた箇所があることも添えます。

教えてもらったら、次にすることを返す

返事をもらった後は、「ありがとうございます」で終える前に、自分が次にすることを一文で確認します。

まず既存の登録機能から入力チェックの置き方を確認します。同じ形にできるか調べ、難しければ違う点を添えて相談します。

口頭で説明された内容は、要点だけ相談した場所へ残すと、認識のずれにも気づけます。うまく進まなかったときも、前回の話から何が変わったかを伝えやすくなります。

いま質問文で止まっているなら、「何をしたい」「どこで止まった」「何が見える」の三つをまず書いてみてください。文章が長くなって整理したいときは、確認メールを読みやすくする例も参考になります。

-仕事・チーム開発
-