https://www.industrialempathy.com/posts/design-docs-at-google/
I wonder how other tech giants go about design docs.
- Quick Outline (in article) -
For new readers to catch up and (for everyone to) link up to detailed information when necessary.
Since design docs are overhead, know the trade-offs with whether a design doc is necessary or not.
Since design docs are overhead, know the trade-offs with whether a design doc is necessary or not.
Anatomy of a Design Doc
Context & Scope
Goal & non-goals
Actual Design: One Overview & One Detailed
System-context diagram
APIs
Data Storage
Code & Pseudocode
Degree of constraint
Alternatives Considered
Cross-Cutting Concerns
Length of Design Doc
Design Doc Lifecycle
- Creation & rapid iteration
- Review
- Implementation & iteration
- Maintenance & learning
This comment has been removed by the author.
ReplyDelete