SE徒然日誌

一連の処理を複数のプログラムでする場合、個々のプログラムの
仕様書がしっかりとかけていても、全体像が把握できなけりゃ
意味を成さないことがあります。


例えば、

・プログラムＡ：ＣＳＶへデータ出力
↓
・ＣＳＶの特定項目入力
↓
・プログラムＢ：ＣＳＶの取込み

のような流れがあったとします。


プログラムＡで障害が発生した時、プログラムＢにも影響する
可能性が十分にあります。

この時、プログラムＡに出力後のＣＳＶをプログラムＢで
取り込むことを明記してあれば、修正による二次障害を未然に
防げるかもしれません。

保守する側からしてみれば、自分が関係していないシステムの場合は、
個々の細かな仕様より、むしろ他のプログラムへの影響が気になります。

なぜって、詳細仕様につては最終的にソースを追っかければ、
「なぜそうしているか」は分からなくても「こうなっている」と
いうのは分かるからです。
（この辺のことは、1005/10/03の日記を見てね。）


《結局のところ仕様書にあって欲しいもの》

１．連携元、連携先プログラムの概要

　・但し、他のプログラムの詳細仕様を別のプログラムの仕様書に
　　書くと、メンテされないおそれがあるので、概要程度に留めて
　　おくのが無難です。


２．連携が複雑な場合は、概要仕様書を起こす。

　・一番すっきりとした形なります。
　・但し、概要仕様書と各仕様書それぞれに自ファイル以外に処理に
　　関わる内容が記載されている旨を明記していないと、どちらかが
　　メンテされない惧れがあります。


※個人的には、１プログラムに関わることが複数個所に記載される
　のは嫌いです。
（必ずどっちかのメンテが忘れられて正しいのがどれだか分からなくなるので）

　記載方法にもよるかと思いますが、複数のプログラムが関連しあって
　システムを作っている以上、横のつながりも分かるようにしておく
　べきだと思います。