設計書の共通項目の標準化(ヘッダー情報・フッター情報)

標準化

このページの概要

システムの構築で作成する要件定義書や外部設計書などの設計書は、その用途や特徴から、書式・形式の異なった様式なレイアウトになるが、システム名などのシステム全体にわたって共通的な情報、またはどのドキュメントにも必ず記載する作成者名などは、ヘッダー情報やフッター情報として所定の書式で記述するように標準化しておくのが一般的だ。

このページでは、どのような項目を共通項目として扱えばよいか、提案する。

共通項目を定義することのメリット

共通項目を定義するとともに、実際に記入する位置までを標準化することで、デザインの統一も兼ねる。
位置を固定しておくことで、利用者の慣れの効果から使い勝手の向上を期待出来る。
さらに、各種設計書を自動検索するソフトウェアを作成することも容易になる。
(本サイトでは、各種設計書に対する様々な自動化についてのツールを掲載する予定である。)

共通項目

一般的に共通化されている項目を一覧にした。
必要に応じて、プロジェクトで検討し、カスタマイズするとよい。
開発工程や文書管理番号など任意の項目も含めたが、執筆者の負担を考え、プロジェクトの特性などから内容を吟味して不要な項目は削除すべきである。

共通項目一覧(ヘッダー情報・フッター情報)

 No項目名 記述例ヘッダー情報フッター情報
◆共通情報
1 ドキュメント書式名画面設計書
2 開発工程外部設計
3 システム名全社基幹システム
4 システムIDACS
5 サブシステム名営業サブシステム
6 サブシステムIDEG
7 機能名取引先管理機能
8 機能IDCUS
◆作成情報
9 作成日2016/4/1
10 作成者名山田 太郎
◆更新情報
11 更新日2016/8/31
12 更新者名鈴木 花子
13 版数1.01
◆固有情報
14 ドキュメントタイトル取引先検索画面
15 文書管理番号(構成管理や命名規約で制定)
◆その他情報
16 ページ(通しページ等)
17 著作権情報(必要な著作権表示)

レイアウトイメージ例

※今のところは、イメージのみの掲載。 後日、各種設計書サンプルを作成後、整形、解説する。

standard

追記事項

本ページの内容は、各種設計書サンプルを作成後、見直しを行い、変更される可能性がある。

タイトルとURLをコピーしました