連載
» 2010年04月27日 00時00分 公開

文書ごとに最適な「構成のフレームワーク」は異なる誰にでも分かるSEのための文章術(9)(1/2 ページ)

「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。

[谷口功,@IT]

 第3回「分かりやすい提案書はアウトラインが美しい」、第4回「『要件定義書のアウトライン作成』完全マニュアル」で説明したように、全体を「階層構造」にすると文章が読みやすくなります。特に、提案書や要件定義書、マニュアルのようにページ数が多い文書は、必ず階層構造にしましょう。さて、今回は「階層構造を作った次のステップ」を説明します。

いきなり文章を書き始めるのはNG

 階層構造を作ったら、いよいよ中身の文章を記述します。このとき、思いつくままに文章を記述し始めてはいけません。分かりやすい文書にするためには、いきなり文章を書くのではなく「表現の構成」を考える必要があります。

 「表現の構成」とは、伝えたい内容を「いくつかのトピックの組み合わせ」で表現することです。表現を構成する作業はたった2つだけです。

  1. 項目をトピックの集まりに分解する
  2. 順序を決めて、項目の流れを再構成する

 トピックのラベルを付けた箱を必要なだけ用意し、その並び順を決めてから、箱の中に具体的なもの(文章)を入れていくイメージでしょうか。面倒くさいかもしれませんが、分かりやすい文書を書きたいならこの作業は必須です。

 1つひとつのトピックの表現方法は千差万別です。いくつかの文章で記述することもあれば、一文だけで記述することもあります。また、文章と図解を組み合わせて表現する場合もあります。

 以下は、「顧客の現状」という項目におけるトピック構成の一例です。

1.「貴社の現状を次のようにとらえている」という趣旨の総論

2.順調に発展し、既存事業を強化するとともに積極的に新規事業を展開する方針

3.事業の継続と廃止の判断のために採算を把握分析する仕組みの必要性を認識

4.事業の拡張と新規展開に伴い、さまざまな業務や作業が複雑多様化

5.業務や作業を効率化する仕組みの必要性を認識

6.これらの仕組みを実現するには現在のシステムでは難しいことを認識

7.新しいシステムの導入の検討を開始


書きたい中身は「引き算」で決める

 トピックの抽出と決定は、「引き算」で行いましょう。

 まず、項目で伝えたい内容を表現するために必要だと思うトピックを、思いつくままに書き出します。トピックの詳細な内容まで踏み込む必要はありません。簡単な言葉で表す程度で十分です。単にキーワードだけでも構いません。そのトピックが本当に必要かどうかの判断は、取りあえず留保しておきます。


 「トピックを考え尽くした」と判断したら、すべてを見渡して、不要だと考えられるものを削除します。論旨から外れたトピックが紛れ込んでいれば除き、内容が重複するトピックがあれば統合します。このようにしてトピックを整理し、必要なものだけを残したら、展開を考えて順番にトピックを並べ替えます。

文章構成のフレームワーク:基本は概論から各論への展開

 トピックの展開方法には、いくつかのフレームワークがあります。主なものを以下に紹介します。分かりやすい文書にするためには、こうしたフレームワークの上で個々の展開を考えます。

 基本は、「概要」→「詳細」(各論)への展開です。技術者が作成する主な文書では、通常このように展開します。最初のまとまりで伝えるべきことの概要を記述し、それ以降の各論で詳細を記述します。

読みにくい構成

1.時間と労力の節約を重視するという消費者の意識の変化について

2.ネット通販サイトの増加、多様化について

3.通販商品やサービスの品ぞろえが豊富になった点について

4.さまざまな機会をとらえた値引きとポイントの付与について

5.パソコンの家庭への普及、携帯電話は1人1端末の現状について

6.高速回線の整備が進んでいる点について

7.総括の記述:これらを背景にしてネット通販が発展、普及した


 上記の例は、「インターネット通販が発展・普及している背景を説明する」見出し項目の展開です。いきなり各論に入っているため、読み手は書き手の意図をつかめないまま読み進めなくてはなりません。

 そこで、最初に概要を記述しましょう。概要によって、読み手は全体の「見取り図」を把握できます。書き手の意図をつかんで読めるため、内容を理解しやすくなります。

読みやすい構成

1.概要:ネット通販の発展・普及の現状と「その背景を以下に述べる」という記述

2.時間と労力の節約を重視するという消費者の意識の変化について

3.ネット通販サイトの増加、多様化について

4.通販商品やサービスの品ぞろえが豊富になった点について

5.さまざまな機会をとらえた値引きとポイントの付与について

6.パソコンの家庭への普及、携帯電話は1人1端末の現状について

7.高速回線の整備が進んでいる点について


結論を先に書くか、過程から書くか?

 技術者が書く文書の中には、「報告書」のように考察結果や検討結果を伝える文書があります。そのような文書には、2つの展開パターンがあります。

  • 結論を先に記述して、後にそこに至る筋道を記述する展開の方がよいもの
  • 筋道を記述して考察や検討を積み上げ、最終的に結論に至る展開の方がよいもの

 どちらの展開にすればよいかは、読み手が何を一番知りたいのかによります。

 読み手が、どのような結論に達したのかを最も知りたいのであれば、結論を最初に記述してからそこに至る道筋を記述します。

「障害の対策や今後の見通しを伝える報告書」の場合

 報告書では、読み手は、結論としての対策や今後の見通しを真っ先に知りたいはずです。特に、経営陣や管理職などはそうでしょう。そこで、最初のまとまりで「結論」を書いてしまいます。そして、その後のまとまりで「なぜその結論に至ったか」という道筋を順を追って記述します。

1.障害発生の現状、状況

2.障害の原因

3.障害を防ぐための考察

4.実施する対応策



 

1.総括と実施する対応策の概要

2.障害発生の現状、状況

3.障害の原因

4.障害を防ぐための考察

5.対応策の詳細


 一方、読み手が結論そのものよりも、そこに至る過程や理由を重要視し関心を寄せているときは、最初から1つずつ順を追って経過や理由を記述し、最後に結論を記述しましょう。

「製品候補から1つを選択し、検討結果や調査結果を伝える報告書」の場合

 結論は、読み手もすでに知っている製品のうちのどれかです。そのため、なぜそれが選定されたのか、その過程や理由を重要視するはずです。

1.総論と選定の結論

2.調査・検討の目的

3.調査・検討の方法、手順

4.調査・検討の結果



 

1.調査・検討の目的

2.調査・検討の方法、手順

3.調査・検討の結果

4.選定の結論


       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。