Monday, July 27, 2020

Design Docs at Google article

This is a really good article on design doc in thinking and in practice.
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.

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

  1. Creation & rapid iteration
  2. Review
  3. Implementation & iteration
  4. Maintenance & learning



1 comment: