Skip to content

Instantly share code, notes, and snippets.

@captainsafia

captainsafia/design-doc.md

Last active November 21, 2019 16:51
Show Gist options
  • Save captainsafia/0e25d622b1b1cc0ba5e3be77b02e2391 to your computer and use it in GitHub Desktop.
Save captainsafia/0e25d622b1b1cc0ba5e3be77b02e2391 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
design-doc.md

Template for longer design doc

I use this when I feel that I need more structure to organize my thinking around a problem.

Problem

Goals

Proposed Solution

Implementation

Note: This is different from proposed solution because it will go into technical details.

Testing and Perf

Template for one-pager design doc

I use this when I am confident in the design for something and want to quickly communicate the approach to managers/team members.

Problem and Goals

Proposed Solution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment