読者です 読者をやめる 読者になる 読者になる

Some Days You Get the Bear

IT系エンジニアの、日々の気づきや考えたこと。

仕様書とコードの大事な関係

仕様書に書いてあることは、そのままコードに落としたい。

そのためにも、仕様書とコードを1対1で対応させたい、と思う。

つまりは、

「仕様書のここは、このクラス/モジュールに書いてあります」

としておきたい。

そして、その中身は、

「2-3章の機能は、この関数で実現しています」とか
「表12-3のマトリクスは、このテーブルで実現してあります」とか
そんなふうに実装しておきたいのだ。

仕様書は仕様書、プログラムはプログラム、ではなくて、
コードのどこに何が書いてあるのか、ちゃんと整理・分類して、場所としてまとめておきたい、と思う。

あとから見ても追いやすいように。

そしてそれが、仕様書と同じように分類され、対応がとれているとよいと思う。

モノとモノが対応がとれていると非常にわかりやすい。

プログラムはドキュメントなのだ。
ただ単に動けばいい、ではない。

 

広告を非表示にする