エラーを正しく伝える技術

システム開発に関わる現場であればエラーは切っても切れない存在である。発生しないことに越したことはないが、避けては通れない、それがエラーというものである。

自身でエラーの内容を理解し解決できるならば問題はない。しかし、そうではない立場の人（エンジニア以外の職種、自身で解決するスキルが無い）は解決できる人に頼らなければらない。そのような時に必要なスキルこそ「エラーを正しく伝える技術」である。

なぜ正しく伝える必要があるのか

誰かに頼る必要がある以上、その人の貴重なリソースを削ることになる。ここでいうリソースは時間だ。自分で解決できない以上、他人の時間を削ることになるということを依頼する側は理解する必要がある。冒頭でも述べている通り、エラーが発生することは仕方がない。かといって、他人のリソースを無尽蔵に奪っていくのはあまり好ましくない。依頼する立場の人にはそれ相応の義務が生じると思っている。
それこそまさにエラーを正しく伝える技術なのではないだろうか。

エラーを正しく伝える技術とは

自分の経験則となるが、以下の要素を満たしていればエラーを正しく伝えることができ、短い時間で問題の解決を行う道標となる場合が多い。

発生した状況を正しく整理し、できるだけ正確かつ具体的に情報を渡す

これだけでは結構ざっくりしているかもしれないので、例を挙げてみる。

1.～という操作をしようとしたところ
2. 何時何分に
3. どこで
4. どんな状態の時に
5. どのような操作をした結果
6. 〇〇というエラーが発生した

正しく状況を伝えるための具体例

イメージがつきやすいよう、次のような設定を設けたいと思う。

toC向けに展開しているアパレルECサイトの構築システムにアサインされたディレクターor新米エンジニア。自身で問題を解決することができず、上級エンジニアに頼らざるをえない状況。

この状況を踏まえ、先程の例に当てはめてみると以下のようになる。

1.  商品購入のテストを行おうとした
2. 2000年1月1日 00:00
3. 商品ページA(http://xxxxx.exapmle/goods/parts/xxxxxx/)
4. TAROというユーザデータでログインしていた
（このユーザデータはhttp://xxxxx.exapmle/admin/users/000001/のユーザデータ）

5. 商品ページAの個数選択画面で1を選択し購入ボタンを押した

6. その結果、「サーバエラーが発生しました」という画面が表示された。（ステータスコードは500）

情報が揃うことによって、どこに対して何をすれば良いのか検討をつけることができる。

つまり、一方的に情報を伝えるだけではダメだと思っている。

まとめ

「エラーを正しく伝える技術」という仰々しいタイトルにしたが、本質的には「そうとしか伝わらない正しいテキストコミュニケーションを実施する事」だと思っている。
自身が困っているということをキチンと伝え、協力をしてもらう（リソースを削ってもらう）からには相応の対応（態度）が必要なのでは無いだろうか。