Tips-08.システム仕様書のテンプレート

自社用のシステムは作業しながら作り上げていくこともあるかと思います。とりあえずそれなりに動くようになれば目的は達成されますので、わざわざ仕様書などの文書にまとめることはなさらないかもしれません。
しかし、使っているうちに、
　　〇新たな機能が欲しい
　　〇現状にマッチしなくなった
　　〇気づいたバグを回避しながら操作をしている
など、修正したくなることはないでしょうか？
また、操作を他者に依頼することがあるかもしれません。
検証や改修が必要になった時、文書化された書類があれば有難いものです。
そこで、システム仕様書のテンプレートを紹介したいと思います。

※対外的な場合を想定していません。あくまで自社用のシステム仕様書です。

システム仕様書のテンプレート

１．システムの概要

1.1　システム名称

仮称でもとりあえずシステム名を付けてください。愛着がわきます。

1.2　機器構成

自社用の場合は省略してもいいと思いますが、後々の参考になるかもしれません。

1.3　システムの目的

システムの目指すところを明記します。
出力結果を何かの資料として利用する場合は、その旨も書き添えると目的がはっきりします。

1.4　システムの効果

このシステムによって合理化される、または負担が軽減される点を列挙します。

1.5　システムの制限

このシステムではここまでしか想定していないなど、制限事項を明記します。
次に改修する際の課題として書き残してもいいと思います。

1.6　特記事項

自社用なので自社特有の処理があれば明記します。

1.7　作成日と製作者

作成日と製作者を明記します。
体裁上のことでもありますが、他者による改変やコピーを防止する歯止めになります。

２．システムの概略

2.1　システムの概略設計

必要となる処理をブロック単位にまとめ、データ項目の関係を整理します。

2.２　システムフローチャート

処理とファイルの流れを作図します。
上記サンプル表の概略フローですが、全体の流れが分かれば省略してもいいと思います。

2.３　概略説明

各ブロック及び各処理の概略を記述します。
プログラムとファイルの一覧表もあればわかりやすいです。
細かい処理内容やファイルの項目などは別章で書きます。

３．共通仕様

プログラムやフォーム設計の統一基準を決めます。

3.1　画面設計の共通仕様

• 画面はヘッダー、詳細、フッターにわける。
• ヘッダーにはタイトルを表示する。
• フッターにはレコードの操作ボタンと終了ボタンを配置する。
• 参照するファイルのデータはリストボックス又はサブフォームで表示する。
• リストボックス又はサブフォームからのダブルクリックでの入力を可能とする。
• PFキーの機能は統一する。（バラバラだと操作者は混乱します。）

3.2　帳票設計の共通仕様

• 帳票はプレビューとし、印刷はプレビュー画面から行うようにする。
• 開くときに最大化し、閉じる時に元に戻す。
• 帳票には作成日とページ数を入れる。
• 原則として用紙はA4サイズとする。
• タイトルはページヘッダーに書く。
  （レポートヘッダーは２頁以降は印字されなくなります。）

４．プログラム仕様

４.１　プログラムの処理明細

共通モジュールなどがあれば表に追加すると親切です。
共通モジュールを改修した場合には、使用しているプログラムのチェックも必要となりますので、使用プログラムを検索する助けになります。
ただし、ここまで書き込むのは大変面倒な作業ですし、書き漏れがないとも限りません。
機械的に検索できる方法を考えた方がいいかもしれません。

４.２　フォームレイアウト

　　画面、帳票の設計図をまとめて収録します。

４.３　ファイルレイアウト

ファイルレイアウトをまとめて収録します。

５．修正履歴

システムは改良を重ねていくものです。修正履歴を残すことはとても大事なことです。
修正日と修正内容は是非記録するようにしてください。

このサイトで紹介しているPG資源の棚卸、テーブル定義書の作成、フィールドのプロパティの調査などは、システムの現状（途中経過）を把握するために作成したツールですが、仕様書に差し替えるためでもありました。よければ参考にしてください。