2003/12/18

新しいことをする場合、最適な仕様というものが、 作ってみるまでわからないということはままある。 実際に作って、動かして、使ってみて、直して…と、粘土をこねるみたいにして 形を作ってゆかざるを得ない。 ただ、どちらに向かうべきかがはっきり見えなくなることが時々ある。 こういう作り方をしている時は、 テストもコードに合わせてどんどん変化してゆくので、 テストドリブンというのも(方向を決めるのには)あまり役に立たない。

そんな時は、ドキュメントを書いてみると役に立つ。 ある程度形が出来てきたところで、そのAPIのマニュアルを書き下してみるのだ。 すると、自分の中で整理がついていないところは、綺麗に説明が出来ない。 不必要に長い説明を必要とする場合は、方向がおかしいと判断できる。 逆に、APIをこう変えれば説明しやすい、というアイディアを得ることもある。

最初にちゃんとした仕様を書いて…という形式との違いは、 既に動くものが手元にある状態で、それを説明するために書く、ということ。

Tag: Programming