🏗️Technical Design Document
Also known as Design Doc, Software Design Document, Tech Spec, Technical Specification
A written plan for a new part of an app. The team reads it before coding.
Think of it like
It is like a plan for a tree house. You draw it before you pick up a hammer.
Example
Before building search, Jack writes a six-page design doc. A reviewer sees the index will not fit in memory. The plan changes in a day, not a month.
Why it matters
Mistakes are cheapest to fix on paper. The doc also tells later readers what was built and why.
Definition
Common mistake
Key takeaways
- 1Before the code. Plan, then build.
- 2Options weighed. Say what was turned down.
- 3Reviewed. Others comment first.