超シンプル入力設計書

設計書というものは、「これが正解」というものがありません。
その会社にとって利益を上げる為の「ノウハウ」が詰まったもの、と
考えたほうが良いです。

ですから、会社が違うと「認識の違い」がかなりあったり、
言葉一つにしても、同じものを別の単語で呼んだりする事もしばしばです。

しかし、「設計書」と呼ばれる目的は皆同じですので、
文章でプログラマに指示を与える方法論というのはある一定の作法があると思います。

以下に示した3つの Excel のページは、マスタメンテという、
アプリケーションとしては基本形となる題材を、最低限の仕様と説明でまとめたものです。

ページ(1)

入力設計書を読む前には「前提条件」があります。

まず、そのシステムで共通の認識とされる「仕様」です。
それは通常「共通仕様書」というものにまとめられるべきですが、全く無い場合もあります。

それは、業界やその会社にとってあまりにも「常識」であったり、あるいは
予算やスケジュールの都合上そのようなものを作成する余裕がなかったり、という理由ですが、
わりと普通にそういう状態は存在します。

ですが、そのような場合でも、経験レベルの比較的低い開発員ばかりの場合は、
どこかでレビューされるべきです。

ページ(2)

そしてさらに該当アプリケーションレベルでは、「概要」と「画面」と「リソース」について
の情報があってはじめて読む事が可能となります。

設計書を書く側としても当然それは事前に作成するものですが、
それぞれ、「概要書」「画面設計書」と呼ばれ、、形式はやはり多様です。
が、経験から言える事は「タイトル(説明の無い1ページ)」の次にくる「概要書」には、
全ての情報が「リソースとの関連図」を含めて 一望できるもの であるべきです。

設計書は、「作る為」と同じぐらい重要な「メンテナンスする」為の手がかりなので、
全ての書類に目を通さなければ全体を知る事ができない構造になっていてはいけないのです。

ページ(3)

このサンプルでは、できるだけ情報をまとめたかったので、本来入力設計書には書かない
共通仕様的な情報も含まれています。また、本来のシステムでは「メッセージ」そのもの
も別に定義されるべきなので、その場合はコードでエラーメッセージの指示を行います。

なにより、A4 縦は情報を記述するには不向きで、B4横を A4横に縮小して印刷するのが良いでしょう。