PR

開発ドキュメント体系と業務フロー

2005年6月10日(金)
梅田 弘之(うめだ ひろゆき)

開発ドキュメントの種類と内訳


   DUNGEONでターゲットとしているのは、主に業務系システムの開発です。これにはWebのポータルサイトやe-Learningなども含まれますが、ゲームソフトや組み込み系ソフトウェアなどは想定していません。C/SやWebなどのシステム開発において、最適なドキュメントはどういうものかというテーマを主体として体系化しています。

   業務系システムの開発フェーズは、「要求分析 → 基本設計 → 詳細設計 → プログラミング → 単体テスト → 結合テスト → 総合テスト」という順に工程が進んでカットオーバーを迎えます。DUNGEONでは、各々のフェーズにおいて作成するドキュメントを表1のように定めています。

工程 ドキュメント成果物 内容 範囲 媒体
要求分析
(要件定義)
要求分析書
(要件定義書)
要求概要
システムの目的
現状の課題と改善案
基本要件と優先順位
到達目標
システムの実現手段
システム化の範囲
概略費用
効果(定性/定量)
体制図
概略スケジュール
全体 Excel
基本設計
(外部設計)
業務フロー   全体 Excel
システム構成図   全体 Excel
ER図   全体 OBER
テーブル定義書   全体 OBER
機能一覧表   全体 Excel
設計書記述様式   全体 Excel
基本設計書
(外部設計書)
概要
I/O関連図
画面/帳票レイアウト
個別 Excel
詳細設計
(内部設計)
画面遷移図   全体 Excel
詳細設計書
(内部設計書)
概要
I/O関連図
画面/帳票レイアウト
項目説明書
更新仕様書
補足説明
個別 Excel
プロジェクト共通ルール   全体 Excel
プログラミング        
単体テスト 単体テスト仕様書
/報告書
  全体 Excel
結合テスト 結合テスト仕様書
/報告書
  全体 Excel
総合テスト 総合テスト仕様書
/報告書
  全体 Excel

表1:開発フェーズにおけるドキュメント成果物

   これらのドキュメントの標準フォーマットを規定し、そのテンプレート(記入例を含む)を提供するのがDUNGEONの位置づけとなります。


全体/個別


   表1の「範囲」欄には、ドキュメントが全体か個別かを記しています。これは、ドキュメントファイルがシステム全体で1ファイルとなるか、プログラム個別にファイル分割されるかを表したものです。

   例えば、業務フローやシステム構成図はシステム全体に対して1ファイル(枚数は複数枚となりますが)作成されるので"全体"、基本設計書や詳細設計書はプログラム単位(例えば受注入力など)で個別ファイルとなるので"個別"ということになります。


ドキュメント媒体


   表1の「媒体」欄にはドキュメントのファイル様式(WordやExcel、PowerPointなど)が記されています。皆さんは、普段どのアプリケーションで設計書を書いていますか?著者自身は「文章なんだから当然Word」という根っからのWord派なのですが、社内にはなぜかExcel派も多く棲息しています(PowerPoint派もいました)。

   どちらも、それなりの譲れない主張はあるようなのですが、あくまでも"ドキュメントの標準化"を目指しているので、WordとExcelを混在してテンプレートを作成しておくのは非合理的です。Word派 VS. Excel派の大議論の結果、DUNGEONではプロジェクト管理手法PYRAMIDに合わせてExcelを基準とすることになりました(無念)。

   ただし、PYRAMID同様、ツールが有効な部分はできるだけツールを活用する方針です。現段階ではER図とテーブル定義書に関しては、自社ツール「SI Object Browser ER」を使うことにしています(自社ソフトなので当然ですが…)。

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

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

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

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

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

連載バックナンバー

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

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

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

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