連載
» 2012年03月28日 11時00分 公開

説明書を書く悩み解決相談室:鳥瞰的ストーリーを描くように説明するコツ (1/2)

聞き慣れない用語を含む説明文の場合、人はその用語を理解しようとして全体の枠組みがなかなか頭に入ってきません。まずは大まかな構造を明示し、ストーリー仕立てにする必要があります。

[開米瑞浩,Business Media 誠]

 文書化支援コンサルタント、開米瑞浩の「説明書を書く悩み解決相談室」第21回です!

 先日、ある草の根勉強会にて「ライティング」に関する講師を務めました。そこで「鳥瞰的(※)ストーリーを描くように書くことが大事」という話をしたところ、会場の反応がよかったので、今回はそのテーマで書くことにします。

(※)鳥瞰的(ちょうかんてき)とは……鳥が空から地面を見るように、物事を広く捉えること

 例えばこんな解説文があったとします。

 デルタメソッドは、当初コンピュータプログラムの構造をデルタ型相互作用の関係として捉えてプログラムを書き表すデルタ指向プログラミングから始まっているが、その後、要求分析フェーズにおいて、開発しようとする対象領域のデルタ要素を抽出・定義していくデルタ指向分析、システムの動作や構造をデルタ的に記述するデルタ指向設計の技術としても広く発展・普及した。

 こうした文章を読むと「デルタ、デルタばっかりでやかましいなあ……しかもさっぱりピンと来ないし」と感じる人が少なくないはずです。

 実は、デルタメソッドというのは実在しない架空の手法で、デルタという用語自体が具体的に何を意味するのか、という説明をこの解説文でははっきりと書けていません。

 つまり、この解説文を読むと「意味不明の用語を立て続けに連発される」ことになるため「やかましいし、ピンと来ない」と思うのは当然なのです。

 さらにこの原文にはもう1つ、欠点があります。「デルタ指向分析」の方が「デルタ指向設計」よりも先に書かれていますが、「実際に世の中に登場したのはデルタ指向設計の方が前だった」としたらどうでしょうか。後で登場したものを先に書くのは、無用な誤解の元です。

 こうしてみると、この原文の理解を妨げるハードルは2つあります。

  1. デルタという概念の意味が分からないこと
  2. デルタの適用範囲が広がっていった流れが分からないこと

 応用範囲の広い新技術を解説するような場合、同じハードルに出くわすことは少なくありません。

 「それはどんな技術か?」という疑問と「どのような分野を起点に広まっていったのか?」という疑問。この2点はいずれも重要な問いですが、その答えを一度に書こうとすると大抵失敗します。そして、原文はそのどちらも失敗しています。

コンピュータプログラムの構造をデルタ型相互作用の関係として捉えて

 という部分が「それはどんな技術か?」の問いに対する答えの一部ですが、これでは情報量が少なすぎて答えになっていないのです。

 これに対して「どんな技術か?」の問いをいったん捨てて、「どのような分野に?」の疑問に集中するなら次のように書けます。

鳥瞰的ストーリー型説明文

デルタメソッドの適用フェーズには分析・設計・実装の三段階がある。そして、歴史的には実装段階のデルタ指向プログラミングから始まり、設計段階のデルタ指向設計、分析段階のデルタ指向分析へとフェーズをさかのぼるように発達してきた。

 これが鳥瞰的ストーリー型の説明文で、以下2つの特徴があります。

  1. 大まかな構造を明示して
  2. ストーリーを語っている

 技術そのものの中身が分からないままでも、適用範囲が広がっていった流れについてはこの書き方をするだけで数段分かりやすくなりますよね。

       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

注目のテーマ