第4回 「要件定義書のアウトライン作成」完全マニュアル
谷口 功
2009/11/19
| 「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。 |
他の文書と同様、要件定義書はまず文書全体のアウトライン(骨格、構成)をしっかり作り上げてから内容を記述します。今回は、読みやすく分かりやすい要件定義書にするためのアウトライン作成方法を紹介します。
■階層構造で読みやすい文書にする
要件定義書を作るためには、全体を大見出し=中見出し=小見出し(章=節=項)の階層構造にします。
| エンジニアライフ コラムニスト募集中! |
あなたも@ITでコラムを書いてみないか 自分のスキル・キャリアの棚卸し、勉強会のレポート、 プロとしてのアドバイス……書くことは無限にある! コードもコラムも書けるエンジニアになりたい挑戦者からの応募、絶賛受付中 |
「大見出し」「中見出し」「小見出し」の数を、それぞれ5から10程度にするのは、前回(第3回「分かりやすい提案書はアウトラインが美しい」)紹介した提案書と同様です。見出しの数が多すぎると、読み手が文書の全体像を把握できなくなります。また、1つの項目の記述量を1ページ内に収めるようにします。
■要件定義書を構成する項目
要件定義書に必要な大見出しの項目としては、次のようなものが挙げられます。
-
システムの概要/システムの構想
- 機能要求
- 入力要求と出力要求
- システム導入後の業務フロー
-
品質・性能要求
- セキュリティ要求
- システム導入の目的と目標
「システムの概要/システムの構想」、「機能要求」(要求機能)「入力要求と出力要求」(入力イメージと出力イメージ)は中心的な項目です。そのほか、「システム導入後の業務フロー」は、業務とシステムの間の架け橋になる情報を提供するための欠かせない項目です。
機能に問題がなくても、品質に不備があればシステムの不備になります。そのため、「品質・性能要求」を明確にしておく必要があります。さらに、現在はセキュリティもシステムの重要な要素であり、「セキュリティ要求」も明確にしておきます。
「システム導入の目的と目標」も重要な項目です。ただ、非常に抽象的な記述になってしまうことがよくあります。それでは読み手に伝わりにくくなってしまいます。そこで、「導入の目標」は「導入の目的」から導き出し、上位=下位の関係になるものとして整理します。
まず、「システム導入の目的」は、「顧客や取引先と、BtoBオンライン商取引によりビジネスを効率化し、コストを削減する」や「顧客サービスを向上させる」といった、経営戦略や経営方針などに基づいた、経営陣や上層部のシステムに対する要求(理念的な要求)と考えます。
一方、「システム導入の目標」は、「在庫率を現在から3割圧縮できるようにする」や「受注の時点で納期を即答できるようにする」といった、何をどれだけ向上・改善させるのかを具体的に示すものです。「導入の目的」の1つひとつに対して、実際の業務を遂行する部署や担当グループ(担当者)など現場の視点で具体化して落とし込んだ「下位の要求」と考えます。このように整理すると、具体的に分かりやすく記述できるでしょう。
■要件定義書の展開
要件定義書の目的は、開発者に必要な情報を提供して、設計作業の基盤となることです。しかし、技術的な関心・興味のおもむくままに展開しては、例えば I のように伝わりにくい文書になってしまいます。
要件定義書は、顧客が求めるシステムの全貌を的確に把握できるように整理・展開する必要があります。この作業は、開発側だけでなく顧客にとっても必要なことです。顧客は自分たちの要求を的確に把握でき、開発側は顧客の求めるものすべてを過不足なく正しく受け取れるようでなければなりません。
物事の全貌を把握しやすい展開は、全体から細部・部分へという流れの展開です。要件定義書では次のような流れになります。
システム全体(=システム概要)→ 業務フロー → 機能 → 入出力 → 品質・性能 → セキュリティ
ただし、システム開発を進めるための出発点は、「システム導入の目的と目標」です。そのため、この項目を最初に記載しておかなければなりません。そこで、要件定義書の全体の展開は II のようにします。
| ⇒ |
|
| 目次作成完全マニュアル | |
誰にでも分かるSEのための文章術 バックナンバー
- 第1回 開発工程でSEが書く文書の基本
- 第2回 ヒアリング現場で使えるコミュニケーション力
- 第3回 分かりやすい提案書はアウトラインが美しい
- 第4回 「要件定義書のアウトライン作成」完全マニュアル
- 第5回 ドキュメントの質を確実に上げる6つの文章作法
- 第6回 読みやすい文章の極意は「修飾語」にあり
- 第7回 専門用語は徹底的に「読み手指向」で書くべし
- 第8回 さらば、翻訳調の文章! 技術者のための校正ルール
- 第9回 文書ごとに最適な「構成のフレームワーク」は異なる
- 第10回 論理的プログラムを書くPGは論理的な文章も書ける?
- 第11回 「バグ数に興味ない」 顧客が喜ぶテスト仕様書とは?
- 第12回 知るだけで天地の差?テスト仕様書の項目&表現法
- 第13回 「目次」の良し悪しが、マニュアルの良し悪しを決める
- 第14回 マニュアル執筆が怖くなくなる、12の執筆ポイント
- 第15回 開発を成功させたいSEに送る「執筆のおきて」まとめ
|
|
| スキルアップに役立つ問題を無料で出題 | |
| ITスキル研修4000件、最新情報の検索できます |
キャリアアップ
スポンサーからのお知らせ
・ケ・ュ・チマツ、クヲオ貍シ・ケ・ン・・オ。シ
- - PR -


点数に応じてレベル認定、PHP技術者認定上級試験が開始へ