仕事

【現役エンジニアが語る】検討資料の作り方

2022年8月10日

システムエンジニアとして働いているとよく作成する検討資料。調査した結果をプロジェクトリーダやお客様に説明するために使用することが多いです。

私はシステムエンジニアとして約20年間、IT業界で働いています。その経験から「悪い資料の典型例」と「良い資料の作り方」について紹介します。

悪い資料の典型例

調査した結果だけを書いている

よくあるのが「調査した結果だけを書いている」資料です。

何のために調査したのか、調査した結果、どういう結論になったのかなどが一切書かれておらず、調査した結果だけが書かれている資料。「書いた本人」と「依頼した人」以外が見たら、何の資料なのか全くわかりません。

「書いた本人」と「依頼した人」が分かれば十分、と思うかもしれませんが、人は忘れる生き物です。時が経つと「書いた本人」や「依頼した人」も忘れてしまうことがあります。そして資料見直すと、何を書いているか分からない・・・という結果になることも。

調査した結果だけを書いている資料のイメージ例

また、システム開発の現場は人の移動が激しいです。資料を作った人物は違う案件に移動していて、別の人が案件を引き継いでいるかもしれません。分かりづらい資料は、引き継いだ人にとって不親切な資料です。

まつ
まつ

設計書とかもそうですが、設計書が雑なシステムの改修案件は本当に苦労するんですよね。設計書が当てにならないので、ソースから仕様を解析する必要があったりします。何のための設計書なのか・・・。

この手の資料を作る人は「読む側の人にどう読んでもらいたいか」「説明するとき、どのような流れで説明するか」など、一切検討しておらず

調査した結果を、箇条書きに書いている

ように感じます。

このような資料は、本当に読みにくいです。説明が上手な人であれば、このような資料でもうまく説明できるかもしれません。ただ資料としては分かりづらい資料です。

誰に向けた資料なのかを意識していない

IT業界は専門用語が多い業界です。そのため、誰のために向けた資料なのかを意識して作成することが大切です。

例えば、ITの知識があまりないお客様に、IT用語だらけの資料を作成しても、相手を困らすだけです。

誰に向けた資料なのかを意識していない資料のイメージ例

資料を作成するときは、誰に向けた資料なのかを意識して作成することをおすすめします。

細かく書きすぎていて、読み込まないと書いていることが分からない

最後は「細かく書きすぎていて、読み込まないと何が書いてあるのか分からない」資料。

しっかりと読み込めば、よくできている資料なのかもしれませんが、論文ではありません。求められている調査が大量な資料になるようなものであればよいですが、大抵はそうではありません。

難しいことを調査して、IT知識が低いが見ても分かるような資料を作るのが、システムエンジニアの仕事です。

細かく書きすぎていて、読み込まないと書いていることが分からない資料のイメージ例

資料は簡潔に分かりやすく作成するのが基本です。

細かく資料を書きすぎてしまう人は、PowerPointで資料を作成する癖をつけるといいかもしれません。PowerPointはプレゼン資料を作るためのものなので、Excelのようにずらずらと文字が書きづらく、自然と簡潔な資料になります。

良い資料の作り方

資料の目的・調査結果・結論がわかりやすく書かれている

資料は誰が見ても「何の資料なのか」分かるようにするべきです。

資料には調査結果だけではなく、次のような情報も資料に記載します。ただ、どのような資料を求められているかによって記載する内容は変える必要があります。

  • 目的
  • 調査が必要となる背景
  • 調査方法・調査結果
  • 結論

何を目的とした資料なのか、なぜ調査が必要なのか、調査方法、調査結果、最後に調査した結果からわかる結論など。

構成をしっかりと組み立てた資料を作っておけば、説明するとき楽です。

説明が上手な人であれば、資料にそこまで書いてなくても、説明でカバーできますが、説明に自信がない人ほど、構成がしっかりした資料を作っておくことをおすすめします。

構成がしっかりした資料は、資料を読むだけで相手に伝わります

誰に向けた資料なのかを意識している

資料は何のために作っているのか?

それは

相手に調査結果を理解してもらう

ためです。

言葉で伝わるのであれば、わざわざ資料化しません。言葉だけでは説明が難しく、また説明できたとしても相手と認識齟齬が発生してしまうかもしれません。そこで資料化し、相手と認識を合わせる目的で使うことが多いです。

資料の目的は、相手に調査結果を理解してもらうことです。誰に向けた資料なのかを意識して作成することが大切です。

簡潔に書かれていて、わかりやすい

資料は簡潔に書くべきです。

調査した結果をすべて書きたくなりますが「どう書けば分かりやすくなるか」を考え、調査結果を整理して資料化しましょう。

文字だけの表現だと分かりづらいと感じる所は、図を用いることで分かりやすい資料に変わります。その他にも表やグラフを利用するなど、見る側の気持ちになって資料を作ることで、分かりやすい資料を作ることができます。

-仕事