開発ドキュメンテーション ドキュメント化事例(1)

開発ドキュメンテーション  ドキュメント化事例(1)

開発現場で、必要になってくるドキュメントは、必ずしもなくてはならないものではない。
だが、必要になる場面は必ずあることは確かだ。

ただ、ドキュメントと一言で言っても、その時々で必要となるドキュメントの種類も数多い。
ここでは、まず、ドキュメントが必要な理由から、追求してみよう。

ドキュメントの必要性

【必要になる場面】

  1. プロジェクトの立ち上げ
  2. 既存プロジェクトへ参加
  3. プロジェクト内案件の担当割り振り
  4. 業務の引き継ぎ
  5. 他部署へのレクチャー
  6. 他部署からの要望のヒヤリング

など・・・他にも多くの場合がある。

実際、プロジェクトの立ち上げで必要になるのは、プロジェクトの参加メンバーへの概要(プロジェクト概要書)の共有を行いスムーズにプロジェクト進行をするためなので、リーダーまたはマネージャーが作成する必要がある。

また、業務の引き継ぎ、他部署へのレクチャーに関しては、システム全体を把握してもらい(システム全体図)詳細に落とし込み、個々の機能(機能一覧)個々の機能の概要(概要仕様書)個々の機能の詳細(詳細仕様書)が必要になってくる。

これはすべて、業務の効率化、工数削減、部署をまたいだ社員全体のシステム仕様の把握を行うために必要だといえるだろう。

ドキュメントの種類

実際どれだけの種類のドキュメントがあるのか開発工程にそって列挙してみたい。

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

※図:Think It (シンクイット)より抜粋

図から読み解いてわかるように、膨大な量のドキュメントが必要になってくる。

では、この中から最小限で必要なドキュメントはなにか、を考えてみたい。

必要最小限のドキュメントとは?

必要になってくるドキュメントは現場に応じてまたは、プロジェクトに応じて異なる。
そんな中、必要なドキュメントを絞る上で、最初に考えるべきは、誰が使うかだ。

そこで、私が過去に経験したプロジェクトで、部門別にどういったタイプのドキュメントを用意したのかをまとめてみた。

営業部

必要知識(製品知識):

  • 機能の把握
  • 概要仕様の把握

必要ドキュメント:

  • 画面構成図
  • 機能一覧表
  • 要件定義書
  • 概要仕様書

品質管理部

必要知識(製品知識):

  • 機能の把握
  • 概要仕様の把握

必要ドキュメント

  • 画面構成図
  • 機能一覧表
  • 要件定義書
  • 概要仕様書
  • ユースケーステスト仕様書

開発部

必要知識(製品知識、機能詳細):

  • プロジェクトの概要
  • システム構成の把握
  • 機能の把握
  • 概要仕様の把握
  • 詳細仕様の把握

必要ドキュメント:

  • プロジェクト概要
  • システム構成図
  • 画面構成図
  • 機能一覧表
  • 要件定義書
  • 概要仕様書
  • 詳細仕様書
  • 単体テスト仕様書
  • 結合テスト仕様書

上記の様になるだろう。

まとめると、最小限必要なドキュメントは:

  • プロジェクト概要
  • システム構成図
  • 画面構成図
  • 機能一覧表
  • 要件定義書
  • 概要仕様書
  • 詳細仕様書
  • 単体テスト仕様書
  • 結合テスト仕様書
  • ユースケーステスト仕様書

上記のドキュメントが必要になる。このドキュメントがあれば、ある程度、円滑なプロジェクト進行を行える。

次回の投稿は、もう少し紐解いていくことにする。

コメント