技術・科学

仕様書だけじゃダメなのだ

投稿日:

ソフトウエアの開発に仕様書はつきもの。だけどこの仕様書ってやつ、実にあいまいなものだ。
仕様書をちゃんと書くってのは大事なことなんだけど、これを書けば十分かというとまったくそんなことはない。仕様書があればいいと思っているとしたらそれは大間違い。なのに驚いたことに開発標準がそういう思想で作られているケースが実は多い。
仕様書というのは要するに要件をまとめたものだ。こういう風に動けばよいとか、こういう風にしか動かないということを書く。開発するためにはこれは必須だ。しかし、これがあればモノが作れるかといえばそんなことはない。必ず設計という作業が発生する。どういう風に実現するかは設計して決まるものだ。この時点で作成するのは仕様書じゃなくて設計書というのが正しいと思う。しかもこの設計書というヤツ、仕様書と違って開発中は変わるのが当たり前だ。いわゆる仕様変更だけではない。よりよい設計に作り変えるというのが今の流行なのだ。いわゆるリファクタリング。だから設計書は仕様書のように固定してしまってはいけない。UMLを仕様書に描くなんていうのは実際ナンセンスなのである。
設計をしたら実装する。このときにも描かなければならないものがある。それは説明書だ。設計書にはこうやって実現するということを書くのだが、実装にあたってはその通りにできるわけではないことが多い。そこでなぜそう実装したのか説明が必要なのだ。これは別のドキュメントを起こすよりはソースコード上のコメントにすることが多いだろう。ソースのコメントで大事なのは何をやっているかではなくて、どうしてそう実装しているのかを記述しておくことなのである。
こう考えると、最初に書いた仕様書はあいまいだということがわかると思う。根本があいまいなのだから、中身もあいまいになってしまうのはあたりまえだ。
仕様書、設計書、説明書。この3種類を効果的に記述するのがよいドキュメントということになるのではないか。
これから僕のプロジェクトではこういう風に説明していこうと思っている。







書いた人

nyao

nyao

本を書きたい人にITの基礎から学んでもらって、Kindleで著者デビューするまでをサポートします。 ITってよくわからないという人のために勉強会をやっています。 「読書と編集」という屋号でお仕事をしています。

プロフィールを表示 →

-技術・科学

Copyright© NyaoPress 読書と日常 , 2019 All Rights Reserved.