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

数年前のある日のこと、相談者Ａさんから、「開米さん、ちょっとこれを見て欲しいんですが・・・」

と、こんな文書をいただきました。

開米　：これは何に使う文書ですか？
Ａさん：社内の勉強会で技術紹介をするための資料です
開米　：で、これを・・・・
Ａさん：いつも、お前の発表はわかりにくいと言われてしまうんです。何か改善のヒントはありませんか？

ということで、考えてみました。

簡単なプレゼンをするとき、「箇条書き」はよく使われる方法ですが、この例の場合は「ラベル付き箇条書き」のほうが良さそうです

Ａさん：「ラベル付き箇条書き」と言うのはなんですか？
開米　：たとえばこういうことです

Ａさん：赤字で「プラットフォーム」と書いてある部分が「ラベル」なんですね
開米　：そうです。「ラベル」はこの場合、「話題」を示します。「今からプラットフォームについて書きますよ」という話題を明示した上で、具体的な中身を書く方法です
Ａさん：でも・・・・「プラットフォーム」はPythonですけど、「GUIアプリケーションのテスト自動化ツール」というのはプラットフォームの話じゃないですよ？
開米　：そこが大事なところです！　それはつまり、この1箇条は本当は2箇条に分けるべきだった、ということなんですよ

Ａさん：「○○○○」のところに、別なラベルをつけるんですね
開米　：その方がいいと思います。考えてみてください

こんなふうに、ラベルをつけようとすると「一文で書いていたけれど、実は2つに分けるべきだった」と気がつくことは少なくありません。「一度に1つのことしか言わない」というのは、わかりやすく説明するための鉄則なので、これに気がつきやすくなるだけでも「ラベル付き箇条書き」を普段から心がける価値があります。

なお、その後Ａさんと開米で5分ぐらい考えて整理すると、こんなふうになりました。（文章で書くのをやめて、表形式にしました）

↑実はこの結果は5分でサクッと作ったものだけに、イマイチ違和感を感じる部分があります。たとえば「用途」と「自動化方針」の２つの項目などはもっとうまい分け方とラベリングがあるんじゃないか、という気がします。

ですが、このまま載せておくことにしました。完璧な例ではありませんが、逆にそのほうが「考えてみる」題材としては役に立つでしょう。「ここがダメ、こうしたほうがいい」とツッコミを入れてみてください。それが「わかりやすく書く」腕をあげるための経験値になりますので。

質問、ご意見等はtwitter, facebook, メール等で私宛にお尋ねください。
→　開米へのお問い合わせ先
http://ideacraft.jp/cms/main-contact.html