Guide · Intermediate · 10 min
Writing a technical design document that gets read
A one-to-two page design doc format that surfaces the decisions and gets review before the code is written.
- development
- guide
Inside this guide
- A design document exists to get a decision reviewed before it is expensive to change. Most are too long to read or too vague to disagree with. This guide is a format that fits in two pages and invites the disagreement that saves the rework.
- Problem, not solution, first
- The decision and the alternatives
- What changes and what could go wrong
- Open questions and the ask
The full guide opens with a membership that covers Developer Implementation Guides.
Sign in if you already subscribe.
Sign in