第1回　開発工程でSEが書く文書の基本

谷口　功
2009/7/31

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

｜1　2｜次のページ

　SEはさまざまな文書を作成する必要があります。その中でも、提案書や要件定義書の作成に悩むSEは多いようです。なぜなら、これらは「顧客に読んでもらわなければならない文書｣だからです。

エンジニアライフ コラムニスト募集中！

あなたも＠ITでコラムを書いてみないか 自分のスキル・キャリアの棚卸し、勉強会のレポート、 プロとしてのアドバイス……書くことは無限にある！ コードもコラムも書けるエンジニアになりたい挑戦者からの応募、絶賛受付中

　本連載では、「誰にでも分かる」提案書や要件定義書を作成するための文章術を解説します。ただし、分かりやすい文書を作成するには、文章術だけでは十分ではありません。必要な情報を顧客から引き出すためのコミュニケーション、文書全体の構成も重要です。

　第1回では、SEが作成する文書はどのようなものかを概観します。第2回では、情報を引き出すための顧客とのコミュニケーションのポイントを説明します。第3、4回では分かりやすい文書にするための構成について、第5回では分かりやすい表現にするための文章術について解説します。

■開発工程と必要な文書

　文書は、他者とのコミュニケーションのツールです。情報を伝達し、情報の内容を確認するために使います。

　システム開発では、SEと顧客、SE同士、SEとプログラマの間などで、情報の伝達や情報内容の確認が必要です。そのため、システム開発に文書は欠かせません。SEは、開発工程の各段階で、以下のような文書を作成します。

要件定義 ↓	要件定義書（要求仕様書）
外部設計 ↓	外部仕様書
内部設計 ↓	内部仕様書
プログラム設計 ↓	プログラム設計書
テスト	テスト仕様書（テストケース）

　また、開発工程に入る前の受注段階では、提案書の作成が求められます。開発工程が終了した後（もしくは並行して）、マニュアルや説明書の作成やその支援をすることがあります。

■それぞれの文書の目的、内容

　SEが作成する文書には、それぞれ目的があります。文書は、目的に沿った内容で記述しなければなりません。

（1）提案書

　提案書の最大の目的は、顧客に提案を採用してもらいシステム開発の案件を受注することです。すなわち、提案書とは顧客を説得し、発注の行動を起こさせるための文書のことです。顧客を説明するためには、何をどのように説得するか、ポイントをどこに置くかを明確にして提案書を作成する必要があります。

　提案書のもう1つの目的は、システム開発に関する基本的な事項について、顧客との認識を一致させることです。システムの範囲、開発や受注の範囲などについて文書として明示しておくことで、顧客とSEの間で共通認識を持つことができます。提案書の内容はケースバイケースですが、主に次のような項目を記述します。

• システム導入の背景
  
  
• システム導入の目的・効果
  
  
• 実現の方針・方策・方法
  
  
• システム導入の対象となる業務の範囲・領域
  
  
• 導入するシステムの構成
  
  
• システム導入後の業務フロー
  
  
• システムの品質条件、性能条件
  
  
• 開発するシステムの範囲
  
  
• 開発プロジェクトの進め方
  
  
• 顧客に納入する成果物
  
  
• 開発体制
  
  
• 開発スケジュール
  
  
• コスト見積もり

　提案書は、顧客からのRFP（Request For Proposal：提案依頼）を受けて、それに回答する形で作成する場合もあります。この場合は、RFPに記載されている要求項目の1つ1つに対して、的確かつ具体的に回答することが重要です。

（2）要件定義書（要求仕様書）

　要件定義書の目的は、まずシステム開発のゴールを定めることです。どのような要件を満たせばシステムが完成したことになるのかを、ゴールとして明確に規定します。

　次に、規定したゴールについて、SEと顧客の間で確認して合意するという目的があります。要件定義書の内容を顧客に承認してもらい、開発するシステムの姿を両者で合意します。

　さらに、外部設計の基盤となる文書にするという目的もあります。要件定義書は設計担当者に提示され、設計担当者は要件定義書に基づいて外部設計を行います。要件定義書には、主に次のような項目を記述します。

• システム化の対象領域……システム化の対象となる業務
  
  
• システムの概念……システムを使った業務の全体像
  
  
• システム構成……ハードウェア構成、ソフトウェア構成、ネットワーク構成
  
  
• 業務フロー……システムを使った業務の流れ（フロー）
  
  
• 作業定義……業務を構成する作業の一覧とそれぞれの作業手順
  
  
• 機能要求……業務を実行するために要求される機能
  
  
• 入出力要求……入力情報と出力情報
  
  
• データ項目とデータベースの要求
  
  
• セキュリティ要求……セキュリティを保護するための要求事項
  
  
• 性能要求、品質要求……システムに要求される性能、品質

専門家を読み手としない文書を作る難しさ

｜1　2｜次のページ

＠ITメールマガジン　新着情報やスタッフのコラムがメールで届きます（無料）