ドキュメントの正規化

あまりいいのが思いつかなかったのだけども例えばこんな章立ての機能仕様書。

1.売上入力機能 1-a.売上入力画面遷移定義 1-b.売上入力フォーム定義 1-c.売上入力フォームエラー定義 1-d.売上入力処理

2.売上検索機能 2-a.売上検索条件入力フォーム定義 2-b.売上検索条件入力フォーム定義 2-c.売上検索フォームエラー定義 2-d.検索表示処理

3.決算機能 3-a.決算条件入力画面遷移定義 3-b.決算条件入力フォーム定義 3-c.決算条件入力フォームエラー定義 3-d.決算処理

で、機能使用書がFATになってきたなと思ったので、対象による文書の正規化を考えてみる。

・処理仕様書 1.売上入力処理 2.売上検索処理 3.決算処理

・画面定義書 1.売上入力画面 1-a.売上入力画面遷移定義 1-b.売上入力フォーム定義

2.売上検索画面 2-a.売上検索条件入力フォーム定義 2-b.売上検索条件入力フォーム定義

3.売上入力機能 3-a.決算条件入力画面遷移定義 3-b.決算条件入力フォーム定義

・エラー定義書 1.共通エラー 2.売上入力時エラー定義 3.売上検索時エラー定義 4.決算条件入力時エラー定義

ところで、こういった正規化の試みにより、文書の更新性は上がるだろうが、閲覧性は下がるだろうな。

調査とかしたわけではないけど、プログラマが作業効率にあまり影響を受けずに同時に参照できる文書って３つぐらいまでで、それより増えると文書から情報を探す手間のロスが目に付くようになると思う。

自分の欲しい情報だけがA4一枚に収まっているのが一番いいのだけどもね。 Wikiを改造したものだったり、オンラインにすればそういったことも可能なのかしら。