山下寛人オフィシャルブログ

オイシックス株式会社 執行役員 システム本部長 山下寛人の公式ブログです。

現代のシステムにおけるドキュメント

また繰り返しドキュメント不要論を書きます。

なぜ一般的にシステム開発ではあまり存在意義が

あると思えないドキュメントを書くのか。

これには歴史的な背景があると思います。

ずっと昔はコンピュータは極めて高価なものでした。

1人1台PCがあるなんて夢の世界です。

端末は台数が限られているのでキーパンチャー

入力します。

1本コンパイルするのも時間がかかります。

私が新人だった頃のマシンでも5分くらいかかって

いました。

小規模メインフレームでしたが。

もっと前はもっと時間がかかっていたでしょう。

そんな時代は紙でプログラムを書いて

机上でレビューをしてできるだけ一発で

動くようにしないと効率が悪すぎます。

だから何段階にも紙でドキュメントを書いて

レビューを繰り返し、ソースコードも紙に書いて

いました。

そんな時代にはソースコードとほぼ同値の

フローチャートを書いていたのも理解できます。


逆に言えば今はコンピューターリソースが豊富だから

今に適したやり方を考えたほうがよいと思います。

最初からプロトタイプを作ったほうが仕様を決める

のももっとも齟齬がないし、最も仕様を的確に

表現できるのがソースコードなのでフローチャート

いりません。

システムの目的など意図に関する部分、アーキテクチャー、

クラス設計などをドキュメントにするのがよいと

思います。