要件と機能を簡潔に伝えるテンプレート

2008年10月9日(木)
山口 智也

基本設計のドキュメントで誰に何を伝えるか?

 濃密なコミュニケーションの相手の1つは、もちろん顧客です。要件定義でつめた内容をどう実装するのか、「われわれはこう考えています」と具体的に示すためにドキュメントを作成します。しかしコミュニケーションの相手は顧客だけではありません。もう1つは、これから詳細設計書を作成するSEです。

 詳細設計以降から製造フェーズにかけてプロジェクトのメンバーは通常増加します。その際、要件定義や基本設計といった上流工程から参加しているメンバーであれば問題ないのですが、増員した途中参加者に詳細設計を依頼するケースが多々あります。その時、元からいるメンバーが持っている情報の量と質を薄めずに伝える必要があります。それを怠ると、詳細設計時に漏れが発生したり、顧客の意図とは異なる機能が設計されたりする事態となるからです。筆者らはそれを「温度差の問題」と呼んでいます。

 途中参加メンバーは顧客の顔も知りませんし、顧客から直接怒られることも感謝されることもありません。そのため多少の「温度差」が生じるのは仕方ないのですが、その「温度差」を少しでも埋めるために、顧客から得た情報を漏れなくドキュメントに落とし込み、設計メンバーへ伝える必要があるのです。「温度差」を「1℃」埋めるだけで後工程の品質は格段に上がるはずです。

 そこで、情報の量と質を落とさずに、かつ限られた時間の中で簡潔に伝達するために、基本設計のテンプレートとして用意したのが「概要説明」です(図2)。概要説明のフォーマットは、こちら(http://www.thinkit.co.jp/images/article/140/2/14021.zip)からダウンロードできます(14021.zip/3.87 KB)。

たった1枚の概要説明が品質を向上させる

 DUNGEONテンプレートの概要説明は、顧客およびSEとの2方向のコミュニケーションを円滑に進める目的で作成しています。そして、それをたった1枚で実現するというのがポイントです。

 新人研修などで、ビジネス文書は簡潔に書くように指導されます。しかし、設計書はどうかと考えてみると、正確に漏れなく記載することばかりに意識が向き、わかりやすく伝えるということが忘れられてはいないでしょうか?

 また、細かく記載された内容を全ページに渡って目を通さないと全体像が把握できないといったことはありませんか?せっかく記載しても、伝える相手に理解されなければ意味がありません。普通のビジネス文書では、冒頭にサマリーを記載し、その後、詳細に展開するという方法がよくとられています。

 それと同様の発想で設計書に用意しているものが概要説明になります。つまり数十ページに渡る基本設計書のサマリーを概要説明1枚にまとめることで、このページだけを見れば、ユーザーも途中参加のSEも、何のために開発する画面、帳票なのかを短時間で理解することができるのです。まずは全体像を確認した上で詳細を読み込めば、理解も早いはずです。

 では、その概要説明の各項目を説明しましょう。ここではその意図のとおり、その画面、帳票でどんな機能が必要か、なぜその機能が必要か、そのためにはどのように実装するかをパッと見でわかるようなフォーマットになっています。

 まず左上段が要件項目です。これは「なぜその機能が必要か」を伝える個所で、「要件NO」により、「第1回:要件と機能の関連を保つテンプレート(http://www.thinkit.co.jp/article/140/1/)」で紹介した「要件一覧」とのひも付けが行われ、トレーサビリティが確保されています。

 次に左下段の「機能概要」項目です。これは「どんな機能が必要か」を伝える個所で、「機能NO」により、同じく第1回(http://www.thinkit.co.jp/article/140/1/)で紹介した「機能一覧」とのひも付けが行われています。

 続いて、右側の「IO関連図」と最下段の「テーブル一覧」は、「どのように実装するか」を伝える個所になります。これらの項目はただの個条書きではなく、記載しやすさとわかりやすさを考慮してレイアウトされています。

 さらに「制限事項」という欄も用意していますが、これが実は非常に重要な項目です。この欄に筆者も何度となく救われていると言っても過言ではありません。では、ここの記載は一体どういう意味を持つのでしょうか。

株式会社システムインテグレータ
国産WebERPパッケージ「GRANDIT」の開発に参画。ファーストバージョンリリース後、経験を生かして多数のERP導入プロジェクトを担当。カスタマイズ開発案件のプロジェクトマネジメントやERP導入コンサルとして活躍中。生の顧客要望を製品に反映する改善活動にも尽力している。http://www.sint.co.jp/

Think ITメルマガ会員登録受付中

Think ITでは、技術情報が詰まったメールマガジン「Think IT Weekly」の配信サービスを提供しています。メルマガ会員登録を済ませれば、メルマガだけでなく、さまざまな限定特典を入手できるようになります。

Think ITメルマガ会員のサービス内容を見る

他にもこの記事が読まれています