設定の仕様をドキュメントに書くのではなく、テストにしてしまう - $shibayu36->blog;

以前開発のドキュメントをどこに置くか問題 - $shibayu36->blog;という記事を書いた。まだよい方法はちゃんと考えられてないが、少しずつケースバイケースでいろいろな手法を試してみている。今回は設定項目の仕様のドキュメントという観点で考えたときに、テストを作ることで解決できないか、ということについて書く。 設定項目の仕様 例えば以下の様な設定があったとする*1。 [ { "blog_url" : "http://shibayu36.hatenablog.com/", "permission" : "public", "can_be_edited_by" : [ "shiba_yu36" ] }, { "blog_url" : "http://shibayu36-private.hatenablog.com/", "permission" : "private", "can_be_

[shiba_yu36]

仕様テストの話を書きました

[t-wada]

例えば serverspec も「動くドキュメント」としての側面を持っていると思います。

[FunnyBunnyDizzy]

サーバの振る舞いテスト駆動な話

[yukimemi]

いいなー

[Rinta]

コードそのものを自然言語の仕様として表現しようとするから無理が生じる。外部仕様(大抵はインタフェースデータの編集仕様)だけキッチリ書いて、あとはプログラマの裁量ってのがハッピーなんじゃないかと思う。

[nobusue]

パターンマッチとかで自動テストするのがいいかもしれませんね。

[sonota88]

ドキュメントには強制力がない

[karronoli]

あるある．ドキュメントを元に自分以外が変更，確認し得るところはコアモジュール縛りしてた．

[lesamoureuses]

ドキュメント書いても自分がどこに書いたか忘れるので、こういうテストよく書く。あとその時に議論あったりしたらチケット番号コメントで書いてる。ただ、ドキュメントのURLをコメントに書く場合もある