調査報告書のフォーマット (2023-09-08の作業メモ)
2023-09-08 はほとんど打ち合わせで作業の進捗はなかった。そのため、作業メモを書くこともないのだた、調査報告書のフォーマットについての覚え書きを書くことにする。
たいてい自分が書く報告書は次のような構成にすることが多い。
概要と結論を先に書く
調査対象と調査手法を定義する
調査が必要な項目ごとに詳細を書く
目的と結論を先に書く
目的は報告書を書く理由である。報告書を読む人は何のための文章なのかきちんと理解しているとは限らない。また、自分自身が報告書を見直すときに忘れていることもあるので簡潔に目的をまとめておくと自分自身が思い出すときの助けにもなる。
また、読み手からすると先に結論を知りたいだろうから、調査の結果わかったことは先に書くようにしている。
調査対象と調査手法を定義する
報告書は第三者が見て正しいかどうか、あるいは、抜け漏れがないかが判断できる必要がある。
第三者がこれらを判断するためには最低限次の定義ができている必要がある。
調査対象に抜け漏れがないか
調査手法が論理的に正しいか
前者の「調査対象に抜け漏れがないか」については、あらかじめ関係者で合意をとっておくのがよい。
後者の「調査手法が論理的に正しいか」については、機械的な方法で再現性があるものが望ましい。そうでない場合、同じような調査対象を分類しておいて、分類ごとに検証手順を書くというのも読みやすくする工夫だと思っている。
調査が必要な項目ごとに詳細を書く
以降は調査対象ごとに調査結果をまとめる。ぶっちゃけ報告書を提出された人はこれ以降は読まないことが多いんじゃないかと思っている。
ここに書く内容は、自分自身や報告書のレビュー者が報告書を読むときに正しさを判断できるものにしなければならない。
そのため、ここのフォーマットは同僚に相談して、どう書くのがよみやすいかを決めることが多い。
まとめ
今週考えていたことを言語化してみた。最初は、架空の調査なりで実際のフォーマットを書いてみようかと思ったが、良い例が思いつかなかったので断念した。思いついたら書くかもしれない。