システムリリース後のメンテナンスや機能追加のために大切な自分のための仕様書

システム開発にて、システム納品時に顧客に必ず納めることになっている決められた書類（仕様書やマニュアルなど）があると思います。

書類のレイアウトは顧客指定や社内での決められたフォーマットなど、いろいろあると思いますが、それ以外にシステムリリース後に、システムのメンテナンスや機能拡張にかなり役に立つ、作成しておいた方が良い大切な書類があります。
それは、システムを開発している最中に（自分の頭が完全にシステムを把握している状態の時に）、システムのポイントとなる部分を、自分が理解しやすいフォーマットで、その都度書き出してまとめた「自分のための仕様書」です。

自分が分かりやすいようにまとめるので、フォーマットがあらかじめ決められた仕様書に、「無理に」自分の頭をあわせる必要がなくなるので、かなり強力な味方になってくれると思います。


例えば

　・自分がぱっと見でわかる画面遷移図
　・自分がぱっと見でわかるDB設計書
　・自分がぱっと見でわかるE-R図
　・自分がぱっと見でわかるクラス図
　・システム内でグローバルで使用している定数が増えた時の追加の方法
　・カンマ区切り（CSV）ファイルなどで定義している定義情報の追加方法
　・システム設定ファイルの各定義情報の意味や定義記述例などの補足説明

などです。

システムの規模が大きすぎて全てをまとめられない事もあるとは思いますが、その場合でも、自分の理解している範囲での資料を作成する事は出来ると思います。


どうしても納期に追われ、時間が無い時は作成するのが難しいかもしれませんが、上記のような資料を少しの空き時間にコツコツと作っておけば、システムリリースからしばらく時間が経って、システムの仕様を忘れかけた頃でも、自分の頭を開発していた時の状態に、少しでも近づけることができるので、
トラブル時の対応時間や機能拡張、実装可否判断、実装時間算定などにも、かなり効果を発揮すると思います。


私も現在社内システムを開発していますが、必ず「自分のための仕様書」を作成するように心がけています。

コメント 2

仕様書はいつも自動的に作っています。
参考にしていただければ幸いです。

ドキュメント自動生成ツール【A HotDocument】
http://www.hotdocument.net/

Excel/chm/html形式出力のドキュメントギャラリー
http://www.hotdocument.net/gallery/

by RURU (2008-08-16 09:59) 

RURUさん、はじめまして。

管理人のtataです。

ドキュメント自動生成ツールは便利ですよね。

情報ありがとうございます。


参考にさせていただきます。


by tata (2008-08-16 19:29)