読者です 読者をやめる 読者になる 読者になる

メンテナンスをするのに必要な文書ってなんだろう

Column Development SIer 考え 開発

SIerにおいて、システムをメンテナンスしていくのに必要なドキュメントとはなんだろう。

プログラミングファースト開発の必要性 - ひがやすを blog
http://d.hatena.ne.jp/higayasuo/20080721/1216607451

仕様が固まった後に作成するドキュメントは、プログラムと一対一になるようなドキュメントではない。そんなのはプログラムを見ればすむ話だから。メンテナンスする人が必要になるドキュメントを書く。メンテナンスする人にとってはドキュメントは必要ですよ。全部ソース読めはきつい。



まず、対内部 & 対顧客として
このシステムはなにをするためのものか
がわからないと引き継ぎ困難です。
『概要設計』と呼ばれるレベルのものでしょうか。
・機能リストのようなもの
・(他システムとの接続があれば)接続関係図

があるとメンテナンスが容易になります。
(どのシステムに影響があるかわからないと、事前の影響確認とかしてもらえない)

そう考えると、対外的には
・外部システムとの接続仕様(I/F仕様)
は残しておく必要があるかな。外部システムの担当が他社であれば、接続仕様がないと話にならないかもしれません。
Web画面で済むならこれも不要かも。

あと自社内担当分であれば
・内部の機能配置
・プロセス間通信(機能の間でのデータのやりとり)が発生するならその経路
・機能とソースの関連性
を図示しておけば、いじったときの影響を判断することが可能。
テスト年中まわしていれば気付くだろうしね。

障害発生時の動きを示した文書は、エラーメッセージがしっかりしていれば不要。
ただ、H/W障害発生時や停止したときの復旧方法など示した文書、再構築手順は必要か。

コード仕様書などは、「1=会社員」とか「2=公務員」などという内容にしなければ不要そうだ。
(ダイレクトに「会社員」「公務員」とかエントリーしちゃだめなの? こちらのほうが直感的ではあるんだけど)
現状、ホストのデータの持ちかたをひきずったシステムをどうすればいいのか...
外部から飛んでくるデータもこんなんだしなぁ。