ビジネスでのIT活用術（IT初心者向け）－１８：システム開発・運用はドキュメントが大切
システムはそれ自体を目で見ることはできません。もちろん、PC・スマホやコンピュータ端末でシステムの画面を見ることはできますが、システムがデータを処理しているところ自体を見ることはできません。そこで、システムがどのようにデータを処理しているかを、文書で記録しておくことが大切です。すなわち、システムにはドキュメントが重要になります。
基本的には、システムを作成した本人以外は、システムがどのようにプログラミングされているか、どのように使用するべきかなどは、第三者にはわかりません。そこで、それらを記述したドキュメントが必要になります。
ドキュメントには大別して、システムの機能や処理手順などを記述するシステム仕様書（設計書）と、システムの操作手順や運用手順を記述したマニュアルがあります。
システム仕様書を見れば、そのシステムがどのような機能を持っていて、データをどのように処理しているかを理解することができますし、プログラムがどのようなロジックを持っているかもわかります。そして、プログラムがどのような処理をしているかを、プログラムソース内にコメントとして記述しておけば、第三者がプログラムを理解するのに役に立ちます。
また、マニュアルに関しては、記述してあるとおりに操作や運用をしないと、想定どおりに動作しないばかりか、想定しない結果を招くことさえもあります。私も経験がありますが、マニュアルとは異なるデータ操作をしてしまったために、予期せぬデータを作成してしまい、業務に大きな支障を与えることもあります。
つまり、そのドキュメントに記述されていることをもとに、システムのことを理解して必要な対応をしますので、もしそこに記述されたこととシステムの実態とに齟齬があれば、問題になります。例えば、ドキュメントの記述をもとにシステム変更やシステム操作をしても、システムが想定どおりに機能しないということが起こったりします。
そのようなことを防ぐためにも、ドキュメントはシステムの最新の状況を反映させておく必要があり、システムを変更するたびにドキュメントを更新することが必要になります。また、これまでどのような変更してきたかという変更ログも、過去の経緯を確認したりするのに役立ちます。
このように、システムにはドキュメントがどれくらい充実しているかも、そのシステムを開発・運用していく上では重要になります。
