Eyes, JAPAN Blog > ドキュメントを描く

ドキュメントを描く

beko

この記事は1年以上前に書かれたもので、内容が古い可能性がありますのでご注意ください。

お仕事としてプログラムをしていると、自分の作ったソフトウェアのきちんとしたドキュメントを残す必要があります。
昔からコメントもろくに書かずにいた私のようなプログラマにとっては、ドキュメントの作成はプログラミングよりも大変です。

というのも、いろいろな要素が相互に関連しているため、個々の要素の説明だけでは不十分で、それの関連し得る要素についても書く必要があることがあるからです。 大抵、正確に書こうとすればするほど分かりにくく、分かりやすく書こうとすると細部が曖昧になってしまいます。

どうにかしようとして最近考えたのが、図で大ざっぱな構造を表現して、細部は文章で表す、という (ありがちな) 方法です。
ここで、独自の図示法を持ち出して自分しか分からないとなると本末転倒なので、UML で図を表現しようと考えました。
UML は汎用的なモデリング言語で、結構よく使われているらしいのですが、何となく今までは触れるのを避けてきました。
が、一念発起して最近コソコソと勉強し始めました。

実際に、何回かクラス図を猫こうと試みているのですが、頭の中にあるものをうまく表現できず、思考停止してしまうことが多いです。
私はどちらかというと設計をキチッと決めてから作るより、頭の中にある感覚に沿って作ると全体が見えてくるということが多いので、これは設計のいい訓練になるかもしれません。

使用しているツールは、Jude
の無料のバージョンの Jude/Community というもので、使い勝手は結構いいと思います。

担当:齋藤 (画像はディレクトリ構造から階層化されたドキュメントを生成するスクリプトのクラス図。 何か違うんだよなぁ…。)

  • このエントリーをはてなブックマークに追加

Comments are closed.