詳細設計書は書きたくない

作成日時：2024-08-26
更新日時：2024-08-26

ただの愚痴。

※詳細設計書はあるべきだと思ってる。

書きたくねぇ

詳細設計書と言う名の日本語コーディング。
時間と金と人の無駄じゃい。
実装と同期することはほぼ無い。

ソース読めソースを。
ソース以上のことは大体書かれていない。

詳細設計書を書くのは下記の場合か。

• 成果物として納品義務がある場合
• レビュアーがソースを読めない
• プロジェクトの規模がデカすぎてソースだけだと分からん場合

“何”をしているかはソース読めばわかるから要らんよ。
概要と大まかなフローだけでいいよ。

その代わり”何故”を書け。基本設計書の脇にでも書け。

• なぜそのアーキテクチャを採用したか(ADR)
• 要件から除外した理由(要件定義書。「やるやら」の定義)
• ソースで何故こういうロジックにしたか(コーディング)
• なぜこういう設計をしたか(設計書)

基本設計書とがっちゃんこしていいよ。

欲しいのは概要と注意点。

ソースが汚すぎる場合、詳細設計があると助かるが、ソースが汚いPJはたいてい設計書も汚いから価値は無い。