システム仕様書の書き方

プロジェクト

自分なりにまとめたシステム仕様書の書き方を書いておきます。

表紙

表紙は1枚でまとめる。

・システム名

・版数

1.00からスタート。改訂するごとに1.10、1.20と増えていく。細かい修正などは1.01などとする。

・仕様書の枚数

変更履歴

変更履歴は新規作成時、変更毎に記入する。1枚でまとめる。

・システム名

・版数

・変更区分（新規 or 更新）

・変更したページ番号

・変更内容

・作成者＆作成日

・承認者＆承認日（押印等）

はじめに

　この仕様書の意味を記述する。この仕様書が、誰に対して、何を実現するシステムの、何に関して記述しているのかを記述する。必要であれば、お客様のどの要望を、どのように解決するのかも記述する。またシステム固有の専門用語が出てくる場合はその説明も付け加える。1枚程度でまとめる。

目次

　番号体系が3層になるように記述する。以下に例を示す。

　1　業務要件・・・・・・・・・・・・・・・・・・・・・・23

　1.1　顧客システムへのログイン・・・・・35　

　　1.1.1　顧客フローの説明・・・・・・・・・56

　2　アプリケーション機能・・・・・・・・・・・・・77

概要

・目的

お客様の課題の、何を解決するシステムなのかを記述する。

・動作条件

そのアプリケーションが動作するサーバ環境、クライアント環境を記述する。

例：　　クライアントのブラウザ：　Internet Expoler 5　以上

　 Fire Fox 1.1　以上

・システム概要

ハードウェア構成図を記述する。開発環境と本番環境の両方がある場合は、両方とも記述する。

・業務内容

現在行っている業務から、システムを使いことにより、どの業務が変更になるかを記述する。必要であれば、フローチャート図などで表す。

アプリケーション機能

・機能一覧

アプリケーションの機能の一覧表を作成する。機能とそれに対応するプログラムファイルを記述する。

・機能名

・機能説明

・対応するプログラムファイル

・それぞれの機能における詳しい説明

フローチャート図、シーケンス図などのツールを用いて、それぞれの機能について詳しい説明を記述する。

(機能全てについてなのでページ数はかなり多い。)

画面仕様

・操作方法説明

GUIを使ったwebアプリケーションなどの場合は、画面をコピー＆ペーストして、操作のフローを示す。

データベース仕様

・各データベースにおけるテーブル名の一覧を記述する。またそれぞれのテーブルにおけるパラメータを記述する。

・テーブル名

・属性名称（例：ユーザID）

・列名（例：USR_ID）

・データ型

・桁数

・制約（主キーとか）

・備考など

ファイル仕様

・外部ファイルを使用する場合は記述する。

・ファイル名称（例：インデックス情報）

・ファイル名（例：index_info）

・内容

・ファイルの内容がiniファイルなどの設定ファイルである場合は、それぞれのパラメータとデフォルト値を記述する。

クラス図

・普通、仕様書には含めないが、あると便利。

以上です。まだまだ足りないところや抜けてるところがあると思うので、どんどん付け加えて生きたいと思います。ご意見などをいただければ非常にありがたいです。

ツイートする

Permalink | コメント(4) | トラックバック(2) | 22:45