オルタナティブ・ブログ > 技術屋のためのドキュメント相談所 >

専門的な情報を、立場の違う人に「分かるように説明する」のは難しいものです。このブログは「技術屋が説明書や提案書を分かりやすく書く」ために役に立つ情報をお届けします。

フローを整理してコメントを書き、見出しをつける

»

こんにちは。技術屋のためのドキュメント相談所長の開米です。

昨日掲載したペーパーレス会議システム「MP:eMeeting」の紹介記事について、「わかりやすく書く技術」という観点でどんなポイントがあったかを振り返ってみましょう。

まず大きな役割を果たしているのがこの図です。

2014-MP-eMeeting-dandori.JPG

↑この図は大まかに左と右の2つのパートに分かれていて、左側は「一般的な会議運営のプロセス」を簡単なフロー図で書き、右側はそのフローに対して「そこに含まれる問題点」という観点でコメントを書いています。

この形式、つまりフローとコメントを組み合わせたものを私は「フロー&コメント型」と呼んでいて、非常によく使います。このパターンで書くと全体像を読み取りやすくなることが多いためです。

2014-MP-flowcomment.JPG

今回は製品紹介でしたが、ソフトウェアの使い方を説明する操作手順書のようなものも、単なる箇条書きではなく、このフロー&コメント型を使うと全体の見通しがよくなるので、試してみてください。


それに加えてもう一つ、大きな意味があるのが3つの「見出し」です。

■紙媒体で資料配付をする会議につきものの問題とは?
■ペーパーレス化が費用とリスクを引き下げる
■ペーパーレスならではのコミュニケーションのしやすさも

という見出しをつけたことで、それぞれ続く部分で何の話を書いているのかがわかりやすくなりました。
ちなみに、見出しの2つめで「費用とリスク」、3つめで「コミュニケーション」という文言を使っていますが、これは前の図で「そこに含まれる問題点」の項に出てきたものに対応するようにしてあります。最初に関連情報を整理することで、適切な見出しもつけられるようになるわけです。

今回は以上です。次回はまた別な製品紹介を書く予定です。

Comment(0)