SEとして、資料作りや説明・プレゼンの場をいくつも
経験してきて、気づいたこと、後輩に伝えてきたことなどを、
すこしまとめてみようと思いました。
稚拙な内容ではありますが、私自身のアウトプットの
訓練のひとつでもあります。
お時間あればお読みください。
私たちSEの職場はコミュニケーションで
成り立っています。口頭、電話、メール、文書などなど、
最終成果物はシステムそのものであっても、それを
作り上げているのは私たち一人ひとりのコミュニケーション。
よく、「ドキュメントの品質」が問題に取り上げられることが ありますが、正確なコミュニケーション(口頭や、
ドキュメンテーションも含めて)は、トラブルを回避するための 生命線です。タイプミスがプログラムのバグに結びつくように、
正確でないコミュニケーションは、そのままシステムの品質へと
つながってしまいます。
ここでは、おもにドキュメントに焦点を当てて、正確で わかりやすい資料作りを考えてみることにしましょう。
---
システムが複雑化したうえ、ひとつの事象を説明するために、
広い範囲のシステム知識に加え、業務知識まで理解して
(少なくともかじって)おかないと、説明が不十分になってしまう
ケースも増えてきました。
業務知識を身につけるのはなかなか難しい面もありますが、
そうした状況でも、わかりやすい資料作りを心がけるヒントは
あります。
ご紹介するヒントは、大きく分けると ①目的の策定 ②内容の構成 ③説明の技術 の3点です。
①目的の策定
その資料は、誰が何のために使う資料でしょうか。 単に自分が相手に説明するだけ、と考えているならば、
自己満足の域を超えていません。
説明する内容を使って、相手に何かを判断してもらったり、
何か行動をしてもらったり、指示を仰いだりするなど、
「誰が」「何のために」使うか、目的があるはずです。
そうは言っても、相手がどんな人で、どんな背景があって、
どうしようとしているのかいまいちわからない、という場合には、
自分の身の回りで、相手のことを知っている人に尋ねて
みるとよいでしょう。
「わかりやすい資料」というと、②の「内容の構成」が
もっとも重要に思えるかもしれませんが、いくら論理的で
きれいな図表を使ったとしても、相手にとって欲しい情報で
なければ意味がありません。
「目的の策定」については、いつでも心がけるようにして
おきたいですね。
(つづく)