開発ドキュメント編
第３３章 コンポーネント保守ドキュメント
説明
企業レベルで再利用コンポーネントを構築するための計画書。この計画書は、１つ以上のパッケージ開発に対して作成されるものである。コンポーネント開発計画書は、作成すべきコンポーネントやフレームワークをある程度具体化した時点で作成される。
対象フェーズ
コンポーネント分析フェーズ
対象ワークショップ
再利用コンポーネントワークショップ
記載項目
開発の目的
コンポーネントが必要とされる背景やコンポーネントの目的を記述。
機能概要
コンポーネントを配布する単位であるパッケージ全体としての機能概要を箇条書きしたもの。
オブジェクトモデル図
作ろうとするコンポーネントのオーバービューをクラス図で記述できる場合はここに示す。
コンポーネント概要
それぞれのコンポーネントの大まかな役割や機能を記述する。
開発のシナリオ
将来的な計画も含めた、再利用コンポーネント構築の戦略について解説する。
ハードウェア資源
予定される利用環境と開発環境のハードウェア資源
ソフトウェア資源
コンポーネントの中で利用するミドルソフトやコンポーネントが決定していれば記述する。
開発コスト
予想される開発工数と設備費用
開発スケジュール
パッケージ全体の開発スケジュール
チェックリスト
具体的な設計案が提出されているか。
コンポーネント開発計画書は、コンポーネント構築に対してある程度の具体的な設計案が提出された段階で作成しなけれはせならない。
説明
コンポーネント開発チームにおいて統一化すべき開発ルールを定義したものである。この標準は、パッケージ開発サイクル毎に無造作に作成するべきではない。まず、ODGチームの中で統一できる部分をベースとなる開発環境標準として定めておき、それにパッケージ個々のルールや開発言語の特性を付加したものを作成するとよい。
対象フェーズ
コンポーネント分析フェーズ
対象ワークショップ
再利用コンポーネントワークショップ
記載項目
コーディングルール
ODGコーディング規約に準拠した形でルールを定める。
ファイル名付与規約
システムとして管理可能になるようにファイル名の付与規約を定める。
システムリソース管理方法
システムとして統合化する時の手続き、ファイル配置構成、バックアップ方式、バージョン管理方式などの決定。
チェックリスト
ベースとなるODGの開発環境標準が腐っていないか
開発環境の発展に合わせながら柔軟に改訂がなされ、時代にあった使えるルールが唱えられていなければならない。
説明
フレームワークやコンポーネント群の提供単位であるパッケージを保守するためのドキュメントである。このドキュメントには、コンポーネントとしての要件定義及び、パッケージ全体としての設計コンセプトや将来的に拡張するために必要とされる情報が記述される。
対象フェーズ
コンポーネント分析フェーズ
対象ワークショップ
再利用コンポーネントワークショップ
記載項目
パッケージ名
パッケージの名前。
バージョン
パッケージのリリースバージョン
パッケージ要件
パッケージの設計方針
パッケージの適応範囲（どのようなプラットフォームで利用可能かの記述）
オブジェクト図（継承と関連、属性と操作は不必要）
クラスレイアカテゴリ図
パッケージに含まれるクラス名と概説
インタフェースメソッドの解説
利用例（サンプルソースまたは、チュートリアル）
提供方法
チェックリスト
パッケージがフレームワークのような大きな単位である場合は、チュートリアルが含まれいるか。
システム保守ドキュメントのテスト項目票と同じ
システム保守ドキュメントのバグシートと同じ