設計書には何を書くべきなのか - terurouメモ

設計とは、 要求（やりたいこと）をヒアリングする 要求を要件（何を満たさないといけないのか）に落とし込む 要件を実現するために考えられる手段を洗い出す 手段の検証を行う 検証結果を元に、どの手段を使うかを選定する 選定した手段を合意する（一部要件を満たさない事項がある場合は、代替策や妥協ラインについても合意する） 合意内容を元に、実装や設定に落とし込む をやることである。画面設計や機能設計のように、3-5の検証/選定が薄くなったり曖昧になったりするものはあるが、一般化するとこの流れになる。 設計書には、上記の設計でやってきたことを順番に書いていけばよい。これを文章構成のテンプレに落としていくと、 要求 要件 方式 対応案（いわゆる比較表で書いていくのが楽） 検証結果 選定・合意結果（合意した代替策や妥協ラインについても記載する） 詳細設計（どういう実装にするとか、パラメーターにするとか、細

[donchan23]

要求も要件も方式も詳細設計も中途半端にしかないシステムの保守してるけど、機能拡張で設計書書けと言われて元の設計がわかりませんって言うとめちゃくちゃ怒られるの不条理すぎる、、、

[hogeaegxa]

何してるのかはコードが設計書だが、そもそも何がしたいのか？何故したいのか？はコードには情報が残らない。保守とかで設計書みようとするときはまずこのへんを求めてるし、そのへんあるとうれしいね

[jacoby]

Whyは自然言語で書いてないとねぇ

[su_zu_ki_1010]

この手ので言いたいことはただ一つ。サンプルを提示してくれ。

[ku__ra__ge]

Joel on Software - やさしい機能仕様 https://web.archive.org/web/20070216023409/http://japanese.joelonsoftware.com/Articles/PainlessFunctionalSpecifi-2.html

[kyuuuuuji]

「どうなっているのか」は最悪コード読めばわかるから「なぜこうしたのか」を知れると大変助かる

[ken1028-kufc]

システム開発でコア人材(1番中心の自在になるには？)

[teruyastar]

「元々何をやりたくて」「なぜこの方法を選んだのか?」という設計書残していくの大事。

[naglfar]

今までに「なぜ」を書いてるドキュメント、ほとんど見た覚えない。意識的に残していきたい。

[strow0343]

要求からコードまでのトレーサビリティを担保して欲しいけど、メンテのコストがね

[htnmiki]

運用マニュアルがちゃんと作られるの稀なのでもう設計書にエラー発生時のアクションやリカバリ方法を書いといてほしいという自分では何もしないユーザー側のひとりごと

[akabekobeko]

私は仕様に関係する Redmine チケットや GitHub Issues のリンクを掲載している。合意形成の過程を知るのに便利。改めて議論するための踏み台にもなる。

[hatest]

要求（やりたいこと）のヒアリング時に文書にして顧客と合意しないまま進めて最後にもとからひっくり返されるPJをよく見る

[aox]

番付表ですね

[SundayIsEveryday]

以前の職場では、設計検討書(機能の実現方法のしぼりこみ過程が書かれたもの)と設計書(しぼりこんだ結果が書かれたもの)がわかれていて、設計書から検討書へと辿れるようになっていたので、非常によかった

[jaguarsan]

開発に使う設計書と保守に使う設計書を分けるべきなんじゃないかと最近考えてる。前者は使い捨て、後者は自動生成

[Tomato-360]

参考になる

[tumo300-500]

設計書って名前がプライマリなのが悪いのではとふと。企画書の方がしっくりきそう

[reannkara]

意思決定の過程は残しておくと後々メンテする人にとってはありがたい。

[iselegant]

よく結論や決まったことしか書いてなくて、結局なんで当時はその方式にしたのか？が書かれてないと妥当性を説明できないですよね。

[golden_eggg]

Whyの言語化大事

[kei_0000]

自分なりのまとめ 1.要求(やりたいこと) 2.要件(やると決まったこと) 3.方式(実装方法の概要･方針) 4.詳細設計(実装方法の詳細)

[jssei]

本来的な設計。現実としては、手段の洗い出しから選定のあたりの部分が結論ありきで取ってつけたような形になってることが多い印象。

[Wacky]

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