連載
» 2009年10月13日 00時00分 公開

誰にでも分かるSEのための文章術(3):分かりやすい提案書はアウトラインが美しい (1/2)

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

[谷口功,@IT]

 分量がある文書を作成する際には、文書全体の「アウトライン(骨格、構成)」をきちんと作り上げてから内容を記述する必要があります。今回は、「読みやすく分かりやすい提案書」にするアウトラインの作成方法について紹介します。

提案書の書き方について知りたい方は、以下の記事も参考になります
開発工程でSEが書く文書の基本
さらば、翻訳調の文章! 技術者向け校正ルール


読みやすい文書は「階層構造」をしている

 読みやすい、分かりやすい文書は、全体が階層構造になっています。文書は、一般的に下記のような階層で構成されています。

  • 大見出し(章)
  • 中見出し(節)
  • 小見出し(項)

 階層構造は、複雑で大量の情報を含んだ文書の内容を、分類・整理するために必要不可欠です。階層化した文書は、各トピックで記述される範囲が決まっているため、焦点を絞って読むことができます。このことは、読者の理解を大いに助けます。

 階層構造の方法について、順を追ってみていきましょう。まず「大見出し」の層に分割します。その後に各「大見出し」を「中見出し」の層に、さらに必要であれば「中見出し」を「小見出し」に分割します。それぞれの層での分割の数は5から10程度にします。分割数が多すぎると、読み手が文書の全体像を把握できなくなる恐れがあるためです。


 記述量による分割方法もあります。分かりやすい文書にするためには、1つの項目の記述量が1ページ内に収まるように分割するといいでしょう。

提案書を階層構造にする

 提案書の「大見出し」には、次のような項目が考えられます。

  • システムの導入について(説得するための材料や情報)
  • 導入システムの概要
  • 開発プロジェクトの進め方
  • 見積もり

 これらの「大見出し」の下にある「中見出し」の項目は、次のようなものが考えられます。さらに必要であれば、「小見出し」の層に分割します。

1.システムの導入について

  • システム導入の背景
  • システム導入の必要性
  • システム導入の目的
  • 顧客の現状
  • 現状の問題点
  • システム導入の効果・成果・目標
  • システム導入における課題
  • 実現の方針・方策・方法
  • 対象となる業務の範囲・領域

2.導入するシステムの概要

  • 導入するシステムの構成
  • システム導入後の業務フロー
  • システムの品質条件、性能条件
  • 開発するシステムの範囲

3.開発プロジェクトの進め方

  • 開発プロジェクトの進め方
  • 顧客に納入する成果物
  • 開発体制
  • 開発スケジュール

4.見積もり

  • コスト見積もり

「読み手が求める」提案書の展開

 読みやすく分かりやすい文書にするには、読み手のことを考慮した展開が必要です。

 技術者側の興味や思い込みで展開することは避け、顧客が提案書に求めるものを考えて展開することが重要です。

 技術者は、技術的な興味を中心に内容の順番を構成しがちです。システム仕様の解説文書と同じような感覚で、最初にシステム全体の構成などを説明しておこうとします。すると、提案書は下記の I のような展開になってしまいます。

 しかし、これでは顧客向けの文書とはいえません。なぜなら、顧客は提案書の段階では技術的な問題に優先順位を置いておらず、あまり興味がないためです。

 彼らが求めているのは、「自分たちの現状や問題点」「何のためにシステムを導入しようとしているのか」「システムに何を求めているのか」を、提案側が具体的に理解していること。そして、その理解に基づいた最適な解決策の提案です。

 そこで、顧客の期待に応える II のような提案書にしましょう。

 最初に書くべきは、システム導入が必要になる背景です。それから、システム導入の目的、顧客の現状や問題点、システム導入による効果、達成すべき目標を記述し、さらにシステム化を進めるうえで解決しなければならない課題を示します。読み手側に立った提案書は、顧客に安心感を与え、顧客からの信頼を得ることができるでしょう。

I (修正前)

1.システムの概要

  • システムの構成
  • システム導入後の業務フロー
  • システムの品質条件、性能条件
  • システムの範囲
  • パッケージソフトの利用

2.開発プロジェクトの進め方

  • 開発プロジェクトの進め方
  • 納入する成果物
  • 開発体制
  • 開発スケジュール

3.見積もり

  • コスト見積もり

4.運用と保守

  • 運用サポート
  • 保守体制


II(修正後)

1.システムの導入について

  • 業務の現状
  • 現状での問題点
  • システム導入の目的
  • システム導入の効果・成果・目標
  • システム導入の背景
  • システム導入における課題
  • 実現の方針・方策・方法
  • 対象となる業務の範囲・領域

2.導入システムの概要

  • システムの構成
  • システム導入後の業務フロー
  • システムの品質条件、性能条件
  • システムの範囲

3.開発プロジェクトの進め方

  • 開発プロジェクトの進め方
  • 納入する成果物
  • 開発体制
  • 開発スケジュール

4.見積もり

  • コスト見積もり

       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

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

メールマガジン登録

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