詳細設計書(前半)

2005年8月2日(火)
梅田 弘之(うめだ ひろゆき)

機能設計書のドキュメント体系


   設計ドキュメント標準「DUNGEON」で定義されている設計工程のアウトプットは表1の通りです。「DUNGEON」では、基本設計書で骨組みを定義し、詳細設計書で肉付けを行います。つまり、基本設計書で作成したドキュメントはそのまま(必要に応じて修正も加えて)利用され、さらに詳細機能を表すためのドキュメントを追加して「詳細設計書」となります。
? ドキュメント 用途・内容 基本
設計
詳細
設計
1 業務フロー 業務の流れを理解し、機能を洗い出す  
2 機能一覧表 開発範囲となる機能(画面・帳票・バッチ)の一覧  
3 ネットワーク構成図 システム構成を把握  
4 テーブル定義 SI Object Browser 使用  
5 ER図 SI Object Browser 使用  
6 画面遷移図 画面遷移を図示  
7 機能設計書 機能別の設計書
(表紙)  
(目次/概要)    
(I/O関連図) データと機能の関係を図示  
(画面レイアウト) 画面イメージ  
(帳票レイアウト) 帳票イメージ  
(フローチャート) バッチ処理のフローチャート  
(項目説明書) 画面/帳票の項目説明  
(イベント一覧) 画面操作で発生するイベントの一覧  
(BL一覧) 機能に含まれるBL(ビジネスロジック)の一覧  
(更新仕様書) 機能またはBL単位の更新・処理内容を記述  
(補足説明書) 上記の記述に対する補足説明  
8 設計書記述様式 設計書の記述方法の説明  

表1:基本設計および詳細設計フェーズのドキュメント

   前回までに表1の? 7「機能設計書」の基本設計ドキュメントとして、「表紙」「I/O関連図」「画面レイアウト」「帳票レイアウト」について紹介しました。今回からは、詳細設計に関するドキュメントについて順に説明していきます。


"機能"単位での設計書


   機能設計書は、機能単位でドキュメントが作成されます。例えば、「プロスペクト登録画面」と「プロスペクト一覧画面」と「プロスペクト一覧表」という3つの機能があれば、3セットの機能設計書を作ることになります。ここで注意して欲しいのは、設計書の記述はあくまでもユーザのイメージする"機能"単位で、プログラミング単位の"プロシージャ"や"クラス"ではないということです。この"機能"という概念について、図1「プロスペクト登録画面」を例に説明しましょう。

プロスペクト登録機能の構成
図1:プロスペクト登録機能の構成

   図1を見ると、「プロスペクト登録画面」という機能は、画面、イベント、BL(ビジネスロジック)などのオブジェクトから構成されていることがわかります。オブジェクト指向のアプリケーション構成においては、このように画面やBLが単独のオブジェクトとして存在します。

   画面「プロスペクト登録画面」を参照モードで開いたときにイベント「ページ.ロード」が発生し、イベント処理の中でBL「プロスペクト参照」が実行され、BLはイベントから与えられたパラメータ「プロスペクト番号」を使ってテーブル「プロスペクト基本」「プロスペクト詳細」などにアクセスし、そのSQLで得られた結果を画面に表示する、このようなアプリケーションの動作を定義するために、DUNGEONの設計書では、オブジェクト間の関連および各オブジェクトの処理内容をオブジェクト種類単位でわかりやすくまとめる様式にしています。

   以下、表1の? 7に含まれる各ドキュメントを順に説明していきましょう。

著者
梅田 弘之(うめだ ひろゆき)
株式会社システムインテグレータ

東芝、SCSKを経て1995年に株式会社システムインテグレータを設立し、現在、代表取締役社長。2006年東証マザーズ、2014年東証第一部、2019年東証スタンダード上場。

前職で日本最初のERP「ProActive」を作った後に独立し、日本初のECパッケージ「SI Web Shopping」や開発支援ツール「SI Object Browser」を開発。日本初のWebベースのERP「GRANDIT」をコンソーシアム方式で開発し、統合型プロジェクト管理システム「SI Object Browser PM」など、独創的なアイデアの製品を次々とリリース。

主な著書に「Oracle8入門」シリーズや「SQL Server7.0徹底入門」、「実践SQL」などのRDBMS系、「グラス片手にデータベース設計入門」シリーズや「パッケージから学ぶ4大分野の業務知識」などの業務知識系、「実践!プロジェクト管理入門」シリーズ、「統合型プロジェクト管理のススメ」などのプロジェクト管理系、最近ではThink ITの連載をまとめた「これからのSIerの話をしよう」「エンジニアなら知っておきたいAIのキホン」「エンジニアなら知っておきたい システム設計とドキュメント」を刊行。

「日本のITの近代化」と「日本のITを世界に」の2つのテーマをライフワークに掲げている。

連載バックナンバー

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

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

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

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