設計書には何を書くべきなのか

設計とは、

  1. 要求(やりたいこと)をヒアリングする
  2. 要求を要件(何を満たさないといけないのか)に落とし込む
  3. 要件を実現するために考えられる手段を洗い出す
  4. 手段の検証を行う
  5. 検証結果を元に、どの手段を使うかを選定する
  6. 選定した手段を合意する(一部要件を満たさない事項がある場合は、代替策や妥協ラインについても合意する)
  7. 合意内容を元に、実装や設定に落とし込む

をやることである。画面設計や機能設計のように、3-5の検証/選定が薄くなったり曖昧になったりするものはあるが、一般化するとこの流れになる。

設計書には、上記の設計でやってきたことを順番に書いていけばよい。これを文章構成のテンプレに落としていくと、

  1. 要求
  2. 要件
  3. 方式
    1. 対応案(いわゆる比較表で書いていくのが楽)
    2. 検証結果
    3. 選定・合意結果(合意した代替策や妥協ラインについても記載する)
  4. 詳細設計(どういう実装にするとか、パラメーターにするとか、細かい話)

という感じで書いていけばよい。

ありがちな失敗としては、4.詳細設計しか書かないことである。これだと、後から読んだ際に「なんでこれ使うことにしたんや…」がわからないという事態が発生してしまう。前述のとおり、画面設計や機能設計では方式を選ぶという事が薄いので、普段このあたりを多くやっている人ほど、3.方式を書くという意識が飛びがちになる。

あと、2.要件はまあまあ書かれるのだが、それに対して 1.要求は「ちゃんとした設計書」ですら書かれていないことがあり、やはり「なんでこの要件になったんだっけ?」が発生しがちになる。