はじめに
報告で意識すべき点や注意点、受け手にとってに分かりやすく書くための方法について記載していく。
ただし、以下記載内容はあくまで記載方法の一例にすぎず、結果的に簡潔で分かり易く書くことが出来れば良いとは思う。
一つの方法として参考にしてもらえれば。
まずは期日確認
- いつまでに報告する必要があるか、期日をまずは確認する
- 報告は素早く行うこと
- 期日前ギリギリに報告しない
報告内容に誤りがあり、再度対応が必要な場合もあるし、観点が間違っている場合もありえる。そのため、報告が早く出来るのであれば前倒しで報告していくスタイルをとる。
対応が完了しても報告することを忘れる、といったことをしない
もしくは"どうなっているのか状況を聞かれてから報告する"、といったことはすべきではない
基本的な書き方
見やすくする
箇条書き、段落を分けて記載するなど、短く端的に記載する。
また、報告相手は得てして忙しい人向けの場合が多い。
（PM/PLなどの役職者向けに報告することが多いと思われる）
そのため、箇条書きや段落分け、必要に応じて強調したい箇所を色を変えたり太字にすり。"分かり易さ"と共に、”何を伝えたいか”も意識して記載する。
必要に応じて図や表、ScreenShotなどで表現することも検討する。
明確に記載する
抽象的に記載し、論点がボヤけるような記載の仕方は極力しない（例えば曖昧な言葉を選んでしまったら数字に置き換えて記載するなど可能な限り明確化する）。
情報に正確性を持たせる
不正確な情報を報告しない。
１つでも誤情報があれば、報告自体の信頼性を失う可能性もあるためだ。
また、事実と自分の意見を明確にさせる 。
調査して明確に分からないことも勿論ある。その場合は判明した"事実"と、調査が難しい領域で推測になる自分の"意見"とを明確になるように記載する。
目的や宛先
いきなり書き始めるのではなく、
「何のために書くのか」
「誰に向けて書くのか」
つまり、目的と誰宛てに記載するのかを明確にする。
これは報告相手によって記載内容や書き方が変わってくるため、明確にすべき。
・PM向け？ それともPL向け？
・アプリ側やサーバ側などエンジニア単位のリーダー向け？
・テックリード向け？
・テスター向け？それともデザイナー向け？
目的や背景説明
"結論から記載しろ"とよく言われるが、目的や宛先を加味した上で何の内容について報告するのか一番最初に記載する。
また、調査事項や問題に関する報告であれば必要に応じて、問題点の背景説明も必要。冒頭に結論だけ書いても、読んだ人はいったい何が書いてあるのか分からないためである。
※チャットなどを使用していて、話題となるスレッドですでに背景説明が不要な場合は不要
要約する
報告で何を伝えたいのか要約する（要約した内容が"結果"を記載することが多いことになるかも？）。
要約の仕方のポイントとして、記載する順番も重要。報告する側が最も伝えたいこと、または報告される側が最も知りたいと思われることから記載した方が分かり易い。
詳細化する
ここまで記載できたら、次にさらに伝えるべきことを一つ一つ詳細にかつ明確に記載する。
内容が長くなりそうであれば、添付ファイルにまとめたり図式化することを検討する。
管理ツールのチケットに詳細を書いて、詳細はこちらとしても良いだろう。
報告量
つい長文になりがちだが、重複するが報告相手は得てして忙しい人向けであることが多いと思われる。そのため、可能な限り短く端的にまとめる
報告前の見直し
誤って記載することで意図した記載内容と真逆になることもあるため、報告する前に最低１度の見直しは絶対に必要。
また、自分が読んだときに分かり易いのか？見にくくないのか？の観点で確認する。
ただし、時間が無かったり緊急性の高い場合も往々にしてあるため、その場合は一旦報告を上げつつ口頭で説明をする、といった２つのアプローチで報告するのもあり。
最後に
報告の基本的な仕方について記載した。
状況によってはスピード重視で対応する必要がある場合や、時間をかけても良いから精度の高い報告をする必要がある場合など、状況によって異なると思う。
その場合は、この記事で記載した記載方法の全てに対応するのではなく、一部だけに特化して記載していければ良いと思う。