プログラマはドキュメントを作るべき…かな?


先日、レオナルド・ダ・ヴィンチ展を見に行ったんですが、その内容がひどくって、レオナルドさんの絵は一つしかない。大体はレオナルドさんの時代らへんの画家の絵、という展示会なんですよ。

これはレオナルド・ダ・ヴィンチ展ではなくって、レオナルド・ダ・ヴィンチとその他の人たち展 だと思うんですが、唯一よかったのが、レオナルドさんの手稿という、手記が来てたところです。

手帳というか、メモみたいなものらしいのですが、橋を造ったり、城塞を作ったり、なんか機械を作ったり、とにかくこの人は天才だ!ということがすごくよくわかるものでした。

設計図や解説図が、すごく正確できれいなんですよ。

ノートの字も大変きれいです。ものすごく小さい字なんですけどね。

ちゃんと書いている。だからいろんなものが作れたんだな。

となんか改めてすごさを実感しました。

それで、思うのですが、プログラムやソフトウェアを作るときに、ちゃんと設計書を書かないといけないな、と。
もちろん、今までも書いてきてますが、どこか
「仕方ないな」
と思ってやっていたことがあります。

しかし、記述することは、自分の中の思考をまとめられるので、積極的にやったほうがいいんですね。

プログラマの中には、異常にドキュメントを作ることを嫌う人がいます。
「時間のムダ」
「ソースコードと同期ができなくなるからヤダ」
まー、もっともらしいですが、結果的に整理できないから時間がよりかかるとか、メンテナンス性が悪くなるとか、品質が下がるとか、自分の首を絞めることになるんですよね。

レオナルドさんの時代と違って、ソースコードから自動的に設計書を作ってくれるツールがあったり、便利なものがいっぱいあるのですから、そこはなるべく便利に早く、ドキュメントを作りたいもんです!

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です