Magnolia Tech

いつもコードのことばかり考えている人のために。

設計書には何が書かれてるべきか

Noteからの転載

—-

設計書になにが書かれているべきか、コードの世界と違ってあまりコンセンサスが得られた回答を見たことが無い気がする。

かなり大きめの書店に行っても、「リーダブルコード」に代表される”良いコードの書き方”はかなりプラクティスとしてまとまってきている一方で、”良い設計書の書き方”みたいな本はほとんど見かけない(ごくたまに見かけるけど…それほど印象に残るものは…無かった気がする)。

なぜだろう…と思ったのだけど、結局冒頭のツイートに有るような、「設計書はコミュニケーションツールである」という視点が抜けたまま議論されることが多く、「割と多くの人に納得感が得られる」ところまで到達していないのではないかな。

つまりコンテキスト依存が大きいにも関わらず、オレオレベストプラクティスがその場その場で語られすぎた結果、誰もそれを組織を超えて積極的に流通させていないのではないか？みたいなことを考えていたら🍺飲みたくなってきた。

Excel方眼紙的な設計書があれこれ言われるけれど、それ以上に必要なコミュニケーションが取れないことが一番問題なので、設計書の様式や記載内容は常に「これで必要なコミュニケーションは取れるのか？」という視点を持ち続けたいですね。