トレーサビリティということ: 設計書とコードの間

トレーサビリティとは、 「追跡できること」 です。

ソフトウェア開発においては、 最初に作った成果物 ( 一般には、 要件定義書 ) と最後に作成したもの ( プログラムやマニュアル ) との間を追跡することができることです。 要件定義書に書かれているある一文は、 設計書のここに書かれており、 それはこのソースコードのこの部分に実装されている、 と追跡できること。 あるいは、 逆に、 プログラムで不具合が出た場所は、 ソースコードではここで、 それは設計書のここに書かれていて、 それは要件定義書にここに基づいている、 と辿れることです。

さて。 設計書には、 どんな処理をするかを日本語などの自然言語で書きます。 それを、 一言一句そのまま書けとはいいませんが、 コード中のロジック部分の核の部分には、 設計書に書かれた処理が素直にたどれるような形でコーディングしてあるべきでしょう。

そうせずに、 この方が処理効率がいいとか、 こっちの書き方の方がカッコ良いとか、 まぁようするに自分の趣味でロジックの核の部分をコーディングされちゃうと、 どうなるか…

…デバッグするときに、 コードのどこを見ればいいのかワカリマセン orz ← いまココ (;;