ドキュメント化の重要性

最近ドキュメント化の重要性を痛感したので、備忘として書き記しておこうと思います。

と言いつつ、正確に言うと、ドキュメント化とテンプレート化の2つだったりします。

システム開発において、ドキュメントって大事ですよね。

そのシステムがどのようなものなのか、データフロー図であったり、データベースの設計書であったり。

クラウドサービスが主流となる中、自社開発を行わないのであれば、実はあまり意識をしなくても良い所かもしれません。

そして、ドキュメント化なんて当たり前のことで、何を今更って感じですよね。

では、なぜ今回、その当たり前を書き記しておこうと思ったのか？

それは素晴らしいコンセプトも形になっていなければ全く意味がないと思ったからです。

データの流れとかデータベースって、放っておくと、どんどん肥大化、複雑化していきます。

そうならないような素晴らしいコンセプト、思想、方針があったとします。

が、この方針も、ドキュメントを作って、形に残していかないと結局、肥大化、複雑化していってしまう。

（肥大化、複雑化していくってことは、そもそものコンセプトがいけてないからじゃない？と言う疑問もあるかもしれないですが・・・。）

ということで、様々な人が形に残していくのですが、ドキュメントがテンプレート化して共有されていないと、十人十色のドキュメントが出てきて、どれが正しいのかわからなくなってしまう。

システムってゼロイチの世界で曖昧さがない世界のはずなのに、何だかわからない。。。

と言う興味深い現象が起こったりします。

そうなると、どうなるか？

ドキュメントではなく、それを知っている（担当している）人達が、正しい（内容が理解できる）人となり、開発・保守がベンダー固定になってしまったり、その人がいなくなった途端、誰も理解できない状態になり、バグ潰しや、アップグレードの難易度が上がってしまったり・・・みたいな未来が想像されます。

ということで、当たり前を当たり前に行なっていく大切さを改めて書き残しておきました。