プログラマ、テスター、SE、PMなど、いろいろやってるオヤジです。

「資料作成の基本」を学んで再利用できるドキュメントを作ろう

»

 「ゲスの極みのエンジニア」

 でonoTさんが紹介していた「外資系コンサルタントが実践する資料作成の基本」を私も読んでみた。

■資料作成の基本は、これ読んどけ

 この本では、資料を作成する際の構成の作り方から、細かい体裁の整え方までが書かれている。1冊に全てを盛り込んだ本だ。筆者が後輩に資料の作り方を教えるときは 「これ読んどけ」 のひと言で済むようにするために書いたような本だ。

 資料作成の王道となる70個ものポイントが載っている。最初からまともに全部読もうとしたら眠くなってしまった(笑)。この本は全部読もうとするのではなく、気になったところ、知らなかったことをつまみ食いして読むべきだろう。得るところはいくつもあった。

■相手のタイプを考えて書け

 主張を伝えるにあたって、相手によって6つの発想パターンを使い分けることが説明されている。例えば、こちらの主張に否定的な相手にはこうする、斬新な発想を求める相手にはこう書く、というように。

 T部長に説明するからこのデータも載せておいたほうがいいだろう、と資料を作るときに考えることは私もあった。だけどここでは相手のタイプに応じて構成全体を変えている。相手を納得させるにはここまでやっておくべきなんだろうな。

 私がコラムを書くときも、今回はこんな人に読んでもらいたい、と一応は読者を想定して書いている。しかしこの本のように 「斬新な発想を求める相手」 向け、「データにもとづく判断をしたい相手」 向け、などとより具体的に読者を想定してもいいのかもしれない。

■変更に強く、再利用できるドキュメントを作れ

 細かいところでは、Power PointやWordやExcel でのプロパティ設定まで言及されている。悪い例として、図形を入れるときに図形とテキストボックスと直線を組み合わせていたりすると、変更するときに位置がずれてしまうことがある。その予防策も載っている。

 あるある。編集すると意外なところがずれてしまうゲスなドキュメント。直すのに苦労したりするんだよねえ。

 変更に強く、再利用しやすく、というのはコードに対しては共通のルールを作ったりして気を使っている。だけどドキュメントになると個人に任されていることが多いのではないだろうか。コードは動作させるものだからちゃんと書かないと動かない。ドキュメントはプログラマに内容が伝わりさえすればちゃんとしてなくても影響はない。中には一度も参照されることのない哀れなドキュメントもある。そんなものだからプログラマを兼任している人はコードには気を使うけどドキュメントは軽視してしまいがちだ。

 でもこの本を読んで、ドキュメント丁寧に作らないといけないなと思った。

 「『も』 じゃないだろ。コードだってバグだらけじゃないか!」

  叱られた(+_+)。  abekkanでした。

 「外資系コンサルタントが実践する資料作成の基本」こちらで入手できます。

 ついでにお知らせです。9月6日に東京新宿区の早稲田大学で行われるXP祭り2014の領布コーナー「エンジニアライフ番外地」 を出します。7人のコラムニストが書いた同人誌です。興味のあるかたはぜひお越しください。

Comment(2)

コメント

仲澤@失業者

その前にWordやExcelの使い方、特に基本的概念を勉強したほうが良い
人たちがいっぱいいますが。まぁそれは放置プレイというこで。

ところで、一回こっきりのプレゼン資料などは単に美術品品質で
作ればよいだけなので簡単なのですが、問題は自分用に残す資料。
歳のせいか先週の自分はすでに他人となってしまうので、
「これは前にやったよな~、どこにコードと設計資料があんべや」
ってなのが日常的になります。
それを検索できることが効率的な業務の必須条件で、
それができないと何もないのと同じなわけですね。
現在はドキュメントとコード内のコメントに同じキーワードを残して、
一括して検索できるようにしてますが、やや限界に近づいてきたかもしれません。
キーワード自体を忘れてしまったときのために一覧表も作ってます(泣)。

最近は「設計書にソースコードのハイパーリンクしてはどうだ」とか、
「全てHTMLかXMLで書けないか」、「そもそも設計書がコンパイルできないか」
などの妄想にとり憑かれてます(笑)。

abekkan

〉仲澤@失業者さん

コメントありがとうございます。

これは以前にやったよな。忘れないようにメモを書いたはず。あれ? メモをどこに置いたか忘れた(^_^;) っていうのは私もありますね。誰でも似たようなことをしているのかもしれません。 人間だもの(笑)!

コメントを投稿する