イントロ&サマリ
ITエンジニアをやるうえでトラブルは避けられないものです。トラブルの状況によっては顧客やPMに対してトラブル報告を実施することが多くあると思います。そういった方たちに向けて、少しでもトラブル報告がスムーズに進むようにトラブル報告のフォーマットおよびノウハウを記載しますので、ぜひ参考にしてみて下さい。
<トラブル報告書のフォーマット>
1.表題
2.はじめに
3.事象
4.原因
5.影響
6.対処
7.水平展開
8.再発防止策
トラブル報告書のフォーマット&ノウハウ
1. 表題
・「XXXXの件についてのご報告」といった形で記載する。
・クライアントから見える事象を記載するようにする。
NG：Webサーバにて404エラーが発生した件についてのご報告
OK：Webサーバのコンテンツがユーザから参照できなくなった件についてのご報告
2.はじめに
・5W1Hの要素を含めてトラブルの概要を分かりやすく記載する。
・エンドユーザ影響やクライアントに迷惑が掛かっている場合は、謝罪の文言を記載する。
3. 事象
・客観的な事実（発生日時、エラーメッセージ、エラー件数）を記載する。
・システム構成図や処理フロー図を使って図示を行い、問題が発生している箇所を視覚化するとよい。
4. 原因
・誤りが作りこまれた原因を論理的に記載する。原因が複雑になる場合は、一次原因・二次原因・三次原因といった形で順を追って説明を記載する。
・端的に説明する。もし説明が長くなるようであれば最初に結論を記載し、そのあとに詳細な説明を記載するとよい。
・事象の説明と同様にシステム構成図や処理フロー図を使って図示を行い、原因を視覚化するとベター
・未発見理由についても記載する。レビューおよび試験で検知できなかった理由があるとよい。
5. 影響
・発生したサービス影響をエラー件数、エラー発生期間等等の具体的な情報を含めて記載する。不明点がある場合はクライアントに確認したうえで記載すると良い。
・直接サービス影響がないとしても、運用を含めてシステムに対して影響がある場合はシステム影響を記載する。
6. 対処
・暫定対処と本格対処が異なるようであれば分けて記載する。
・対処の具体的な日程および修正対象を記載する
・一時的に運用対処が必要となる場合はその旨も記載する。
7. 水平展開
・最低限、一次原因に対する水平展開（横並び確認）を実施し、具体的な内容を記載する。
・水平展開の方法および範囲についてはバランス感覚が求められるため、上位層と相談したうえで決めることを推奨する。
8. 再発防止策
・原因に記載した内容の裏返しとして、再発防止策を記載する。
・「徹底する」、「努める」といったあいまいな再発防止はNG。必ずプロセスに落として機械的に実施できる再発防止にする。
まとめ
以上がトラブル報告書のフォーマットおよびノウハウでした。まずは下記のフォーマットに則って記載していき、組織としてブラッシュアップしていってもらえればと思います。
<トラブル報告書のフォーマット>
1.表題
2.はじめに
3.事象
4.原因
5.影響
6.対処
7.水平展開
8.再発防止策
他にも文書作成という類似テーマで、読まれるブログ記事の作成方法についても記載していますので、興味ある方はぜひご覧になってください！
【技術ブログの書き方】読まれるブログにするための方法3選
コメント