基本設計のドキュメント構成と作成手順

基本設計のドキュメント構成と作成手順

第1回で「業務フロー」、第2回で「機能一覧表とI/O関連図」について説明しました。今回は残りのアウトプットを取り上げて、基本設計フェーズのドキュメント標準を完了させることにします。「DUNGEON」の標準で定義されている基本設計工程のアウトプットは、表1の通りです。

工程 ドキュメント成果物 内容 範囲 媒体 基本設計 （外部設計） 業務フロー 全体 Excel システム構成図 全体 Excel ER図 全体 OBER テーブル定義書 全体 OBER 機能一覧表 全体 Excel 設計書記述様式 全体 Excel 基本設計書 （外部設計書） 概要 I/O関連図 画面/帳票レイアウト 個別 Excel

表1：基本設計工程のドキュメント構成    基本設計書は機能ごとに表紙、I/O関連図、画面レイアウトまたは帳票レイアウトで構成されます（図1）。この例では説明の便宜上、画面レイアウトと帳票レイアウトを一緒にしていますが、実際はプロスペクト一覧（画面）とプロスペクト一覧表（帳票）は別々の設計書として起こします。 図1：基本設計書 （画像をクリックするとExcelファイルをダウンロードできます。/58.0KB）    基本設計フェーズの作業をおおまかに言えば次のような手順で行います。 業務フロー作成 機能一覧表作成 基本設計書（表紙＋I/O関連図＋画面/帳票レイアウト）作成 テーブル定義（ER図＋テーブル定義書）作成 表2：基本設計フェースの作業手順    最初にユーザ業務のヒアリングを行いながら「業務フロー」を作成し、その中にシステム化対象となる画面や帳票を位置づけます。次にそれらの画面や帳票をサブシステム単位に整理して、「機能一覧表」を作成します。そして1つずつの機能に対して「基本設計書」を作成します。    基本設計書ではどのデータを使ってどう処理するかをI/O関連図で定義し、具体的な画面・帳票イメージを「画面レイアウト」や「帳票レイアウト」で表します。ユーザが理解しやすいように実際の画面・帳票に近いものを作成して、項目などの確認を行ってもらいます。そして、それらの画面・帳票に表示するデータを考慮したテーブル設計を行い、「ER図」と「テーブル定義書」を作成します。 画面レイアウトと帳票レイアウト    図1の画面レイアウトの目的はユーザにイメージを見てもらって仕様を確認することです。それと同時に、この後の詳細設計にも流用して使用しますので、作る観点での記述様式も取り入れています。具体的には、表示項目なのか入力項目なのか、数値表示なのか文字表示なのか、半角文字か全角文字か、データ表示の桁数、金額などのカンマ編集、日付の表示パターン、リンクの有無、ラジオボタンやチェックボックスやプルダウンリストなどの使用、スクロールバーの有無、ボタンの配置や表示文字などです。    図2は表1に含まれている「設計書記述様式」の中から、画面・帳票レイアウトの記述方法の説明箇所を取り出したものです。「設計書記述様式」は設計書の記述ルールを説明するためのもので、第1回で「業務フロー記述様式」、第2回で「I/O関連図の記述様式」を紹介しています。 図2：画面/帳票レイアウトの書式文字 （画像をクリックすると別ウィンドウに拡大図を表示します）    一般の画面レイアウトではデータ部分の表記文字に「X」を使い、「XXXXXX」と表す例が多いと思います。しかし、「X」だけだと情報量が不足するので、DUNGEONでは図2の例のように「6、9、Z、O、B」などの文字を使うようにしています。文字の桁数や全角半角の区別も原則的には設計書に記述した文字通りに記述するルールとなっています。例えば、「ＯＯＯ」なら全角3文字の表示、「Z,ZZZ,ZZ9.99」ならゼロサプレス付で9百万までの半角数値を小数点2桁で入力できることになります。    図1の帳票レイアウトの方では入力しないので「9」や「B」は使いませんが、記述書式は画面と統一しています。改行条件、改ページ条件、データの表示順などにつきましては、詳細設計時に追記しますので、ここではイメージだけに留めます。 Web画面の設計サイズは枠を超えてしまう    これまでの画面設計は図1の画面レイアウトのような縦横の固定枠でOKでしたが、Webベースの画面の場合は縦がずっと長くなる可能性があります。そのためDUNGEONではExcelの画面レイアウトだけでなく、HTMLで画面を作成したものを設計書に貼り付けるという処理も許可しています。    なお、ここではExcelを使用していますがExcelには重大な欠点があります。それは、デザインモードで文字が枠内に入っていても、印刷した場合にはみ出てしまう場合があることです。そのためExcelで画面設計を作成する際は、プレビューを確認しながら枠幅を調整する必要があります。DUNGEONはExcelで統一というのが基本構想なのですが、仕方がないので、ここはWordで仕様書を作成することも許可しています。

ER図とテーブル定義書

画面・帳票レイアウトを作成したら、次はER図とテーブル定義書の作成です。ER図とはEntity Relationship Diagramの略で、データ中心設計（DOA：Data Oriented Approach）に向いたモデリング記法です。ER図はデータベース設計に広く使われており、E（エンティティ）はテーブル、R（リレーション）はテーブルの関係に相当します。図4のようにエンティティを四角、リレーションを線で表わし、リレーショナルデータベースのデータの関連性をわかりやすく示すことができます。 図3：データモデリングツールでER図を作成 （画像をクリックすると別ウィンドウに拡大図を表示します）    実は弊社では、データモデリングを簡単に行うツールを自社開発しており、「SI Object Browser ER」という商品名で販売しています。当然ながら、DUNGEONでもこのツールを使ってデータベース設計を行うことにしており、本ツールから「ER図」や図4のような「テーブル定義書」も出力することができます。 図4：テーブル定義書の例（SI Object Browser ERから出力） （画像をクリックすると別ウィンドウに拡大図を表示します）

まとめ

今回は、基本設計フェーズにおけるドキュメントの中から、「画面レイアウト」「帳票レイアウト」の記述様式について説明しました。また、データモデリングツールを使ったER図の作成、テーブル定義書の出力なども紹介しました。これで基本設計フェーズで作成する各ドキュメントのテンプレートとその作成手順の説明は終了です。次回からは詳細設計フェーズに入っていきます。 リンク： https://thinkit.co.jp/free/project/4/3/1.html