ISO/IEC 6592(JIS X 0126)は、「応用システムの文書化要領」と題され、ITシステムでの文書のひな形と言える。実は最近目にして、「悪くないな~」との印象。
正確にはJISは2001年に改訂され、そちらが好印象。従来いくつかの文書で構成されているものを、1つの文書(ただしサブ文書より構成される)の表記に変えている。JISの改訂そのものはISOの改訂によるが、そもそも日本は従来のいくつかの文書での構成としたかったらしい。(JIS X 0126の”解説”に詳しい。)
個人的には、設計ドキュメントは少ない方がよいとか少なくすべきとの考えだし、全体把握の文書があるべきとの考えなので、今回の改訂版の方が馴染みやすい。逆に、規格改定などをウォッチしておけば、早めに気がついたのにと少し反省。(以前の版だと、文書種の列挙で閉口したのだと思う。)
1 システム要求
11 問題の定義
12 目的
:
2 システム記述
21 システムの識別
211 システム名称
のように書かれている。人的資源や費用/項目、長所/弱点といった項目もある。
個人的には、この規格をもとに、組織体で必要とされる項目を追加したり、対象物によっては未記載にする(削除する項目)などを検討しても良いだろう。また、この規格を文書一覧と考えて各文書を用意するよりも、ここでの項目をなるべく1つの文書にする方が良いと考える。
組込みでもそうだが、1つの製品なりシステムの文書化は、章立てをどうするかとか記載分担をどうするかが悩みの種。組込みでは、特に新規開発とか新分野の開発の場合が顕著である。文書の数を多くして、極端にはエクセルでの断片的な仕様表だらけとか、(やれエクセルが好きとかTexが好きとかで)多くのフォーマットでの文書の乱立ということもあるようだ。文書が増えればメンテナンスが大変だし、そもそも協業での変更管理やCO/CIに関連する弊害も発生する。
まっ、一見をお勧め。