仕様書の書き方、第2弾です。
漏れ抜けのないようにと、あれもこれもと盛り込みたくて、
ついつい長文になってしまうこと、けっこう多いように感じています。
しかし、仕様書は、
まずは「箇条書き」です!
要素をきちんと分解し、1つのことを1つの項目として書き表すこと、
これがすごく大事な観点だと思っています。
なぜならば! 我々は仕様書を書いているのだから。
なんだそりゃ!? とお思いでしょうが、仕様書ならではの以下の役割があるからです。
■よい設計の観点から
- 機能ブロックや入力情報等がきちんと整理・分解されることは、そのままわかりやすい設計につながります
- どんな機能、どんな情報があるかをきちんと把握できることは、システムの登場人物を正しく把握でき、概要の理解を助けます
■トレーサビリティの観点から
- 次工程のインプットとして、仕様書どうし・仕様どうしの各項目の対応付けが明確になります
- 特に仕様が「実装項目」「テスト項目」に1つ1つひも付けできる点は重要です!
■数量・規模の観点から
- 明確に数えることができることで、作業項目数、作業量、規模として捉えることができます
- 例えば「何箇所変えないといけないの?」「いくつの作業をするの?」というふうに
■オジサンのために 読みやすさ・わかりやすさの観点から
- 長いと「入ってこない」んです。読んでてしんどい。何が主語?どこにかかる?と探しながら読まなければならなくって。
長くて難しそうに書いてないと、
もの足りなく感じてしまったり、かしこそうに見えないんじゃないかと気になってみたり、
でもそんなことはぜーんぜんありません! ま、あたりまえだがな
仕様書の一番の目的は 「仕様をひとに伝えること」 です。
気持ちよく読んでもらって、わかってもらうこと以上に、気にすることは何もないのです。
ところで、いつも「登場人物」ってことばを使ってしまうんですが、何か他にいい言い方はないんでしょうか?
人でもないものを「誰が」と言ってみたりする擬人化は、システム屋さんのわるい習慣とも聞いたことがあります。
でも「艦これ」とか流行ってるし、時代はいま擬人化なのかもw。ま、いいか。
seichi23.hatenablog.comseichi23.hatenablog.comseichi23.hatenablog.comseichi23.hatenablog.comseichi23.hatenablog.com