やっぱり仕様書は必要かもしれない

Author:

エンジニア、特にweb界隈だと仕様書なんて作らないところも多い。
ちょくちょく変わるし、作っても読まなかったり。
が、やっぱり時として仕様書は必要となるのです。

特に複数モデルにまたがるupdateとか、DBが絡むと厄介。
このカラムにはnullが入ることがある、だからそれを前提にプログラム組まないといけないとか。
ステータスは公開だけど公開日を未来の日付にすれば予約公開扱いになるとか。
そういう細かな事って作った人じゃないと分からないです。

だから不等号で判断してもnullのデータは取れないし、
公開中の記事だけ引っ張ろうとしたら予約公開の記事まで引っ張ったりとかいうバグにつながるのですね。

もちろんwordなんかでしっかり作る必要はないんだけど。
せめて社内wikiとかにはメモっておくべきですよね。
それかコメントを充実させるべき。
当然ながらそのメモした内容は定期的に見直さないといけないですが。

何にしろ、バグが起きたらどこかに原因はあるわけで。
ケアレスミスならともかく、仕様や影響範囲を知らなかったという類のバグは再発防止のためにも必ずメモしましょう。
テスト項目書に追記するとか自動テストに盛り込むのもありかもね。

Facebook にシェア
Pocket