本記事では、Creative Content Lab Tokyo(クリエイティブコンテンツラボトウキョウ)が作成した要件定義書のテンプレート(サンプル付き)をご提供しております。
通常、要件定義書は、パワーポイントやWORDで作成することが多いと思います。今回はPPT版(ワイド版)で作成しておりますが、今後要望があればWORD版でも作成しようと思います。
また、今回は非機能要件、テスト要件、移行要件をそれぞれ別紙として構成しています。これらの定義書は改めて新しいテンプレートで作成して公開する予定です。
[toc]
1.要件定義書のサンプルイメージとご利用方法に関するご説明
では、要件定義書のサンプルイメージを使って、作成手順についてご説明いたします。
【改訂履歴】
まず改訂履歴のページは必ず入れておきましょう。要件定義書は作成後、お客様のレビューなどにより最終FIXするまでに変更が発生することが多いため、誰がいつどのような経緯で修正したのか残しておく必要があります。
【本書の構成】
続いては、本書の構成のページを入れています。
要件定義書のファイル構成は、プロジェクトごとにお客様の意見も取り入れて、どのような構成にするか検討しておくとよいでしょう。
まずは要件定義書のフォーマットは、WORDなのか、PPTなのかを決めてください。
PPTの場合、システム機能一覧やオブジェクト項目定義書などを盛り込むと可読性が下がるため、エクセルファイルで作成し、別紙参照とするほうがよいでしょう。
以下の例では、要件定義書(本書)のPPT以外に、多くは別紙としているため本書の構成でどのファイルに何が記載されているのか一目でわかるようにファイル構成を可視化しています。
【目次】
本書の構成とは別に、今度は要件定義書全体の目次ページを作成しています。
章立てについては、プロジェクトの特性や規模により記載内容や粒度は変更してください。
非機能要件定義書、テスト要件、移行要件はそれぞれ記載内容が多くボリュームも多いため、別紙としましたが、要件定義書内に記載できる程度のボリュームであれば盛り込んでも構いません。
【はじめに】
要件定義書の作成目的を記載します。
【1.業務・システム要件(表紙)】
【1-1.システム構成】
最初に作成するシステムの全体像を提示します。(ポンチ絵レベルのものでよい)
【1-2.システム化範囲(プロジェクトスコープ)】
システム構成図の中で、システム領域の定義と今回の開発範囲(スコープ)の定義(赤枠)を定義します。
全体の中で、どこが対象で、どこが対象外か明確にわかるように定義します。細かい部分はコメントで記載します。
【システム領域と実現方式】
続いて、システム領域(エリア)の定義を行います。
領域は略称でわかりやすいものを定義するとよいでしょう。(例では、Service Cloudの略をSCとしています。)
また、それぞれの領域の対象業務とシステム化概要(説明)、利用サービス・ツールや実現方法、機能を定義します。
【1-3.業務フロー図(AS-ISモデル)】
現行の業務フロー図を定義します。最初のページには凡例を差し込んでおくとよいでしょう。
また各プロセスには番号を振って、番号に対する業務内容の説明資料を入れる場合もあります。
【1-3.業務フロー図(TO-BEモデル)】
続いては、新業務フロー図を定義しますが、現行業務フローとの違いの部分がわかるように強調表示や説明コメントをいれるとよいでしょう。
※以下のサンプルはAS-ISと同じものを利用しています。
【1-4.現状の業務課題と対応策】
現状業務の課題と対応策(施策)について取りまとめたものを記載します。
【2.システム機能要件(表紙)】
【2-1.システム機能要件(システム機能一覧)】
・業務分類(大・中・小)の分類を定義
・システム機能ID、機能名、システム機能概要を定義
・機能分類、標準/アドオン開発を定義、具体的な方法を定義
【2-2.オンライン機能(画面一覧/帳票一覧】
1.画面一覧:作成する画面の一覧を記載します。
・業務面、画面ID、画面名、概要
・画面種別(WEB・モバイル)
・利用者(プロファイルベース)
2.帳票一覧:作成するシステム帳票の一覧を記載します。
・帳票名、概要
・帳票設計(様式、サイズ、改頁条件、ページ数、頻度、履歴管理、再出力要件有無、開発有無)
・利用者(プロファイルベース)
【2-3.バッチ処理一覧】
【2-4.情報・データ要件】
1.オブジェクト一覧
・オブジェクト名、API参照名、表示ラベル、種別、区分、用途
・利用者権限(プロファイルベース)
2.オブジェクト項目定義書
オブジェクト毎に項目定義書を作成します。こちらは別紙としエクセルファイルで作成することをお勧めします。
Salesforce DevToolsのダウンロードと利用方法は、以下の記事を参考にしてください。
-
参考Salesforce DevToolsを使ってオブジェクト設計書を自動生成(xgeek.net)
今回は、xgeek.netさんが提供する無料ツールであるSalesforce DevToolsをご紹介していきたいと思います。 xgeek.netでは、今回ご紹介するSalesforce DevToo ...
続きを見る
【2-5.インタフェース要件】
1.外部システム連携(全体像)
外部システムとの連携方式の全体像が分かるように連携図を作成します。
2.外部インタフェース一覧
続いて、外部インタフェース一覧を定義します。
・インタフェースID、インタフェース名、処理概要、頻度、送受信区分、連携システム送受信
・処理方式(接続方式、処理区分、データ種別
・データ形式(データ形式、文字コード、デリミタ(区切り文字)、改行コード、サイズ等
【2-6.レポート・ダッシュボード要件】
1.レポート要件
・タイトル、説明、形式、表示項目、抽出条件、集計軸、レポート格納先フォルダ
・利用者(プロファイルベース)
2.ダッシュボード一覧
・タイトル、説明
・表示形式、表示項目、抽出条件、集計軸、元レポート
・利用者(プロファイルベース)
【3.非機能要件】
※今回のサンプルでは、非機能要件については別紙として、非機能要件定義書を作成する構成としている。
【4.テスト要件】
※今回のサンプルでは、テスト要件については別紙として、テスト要件定義書を作成する構成としている。
【5.移行要件】
※今回のサンプルでは、移行要件については別紙として、移行要件定義書を作成する構成としている。
【6.別紙(Appendix)】
【成果物一覧、用語集】
成果物・納品物一覧は、別紙のエクセルとしたが、ボリュームが少ない場合は、スライドに直接記述してもよいでしょう。
【クロージング】
テンプレートのダウンロード
資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。
一般公開資料
★ワイド版(16:9)
要件定義書(PPT版)はこちら
PDFで資料のサンプルを参照したい場合は、こちらのPDFをダウンロードしてご利用ください。
要件定義書(PDF版)はこちら
その他、要件定義書(別紙)のテンプレートが必要な場合は以下の記事からダウンロードしてください。
-
参考ダウンロード可能なコンテンツ(サンプル・フォーマット)一覧
サポーターお問合せ・ご要望いただいているコンテンツも頑張って作成しているので、もうしばらくお待ちください ダウンロード可能なコンテンツ一覧 提供しているテンプレートと公開範囲は以下の通りとなっています ...
続きを見る
まとめ
皆様の役に立つように改善していきたいと思います。
テンプレート関連の記事