Skip to content

Instantly share code, notes, and snippets.

@davecheney

davecheney/design-document.md

Created February 13, 2019 20:23
Show Gist options
  • Save davecheney/48c3271283211f4bfb557aedbc4dcae2 to your computer and use it in GitHub Desktop.
Save davecheney/48c3271283211f4bfb557aedbc4dcae2 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. davecheney created this gist Feb 13, 2019.
    34 changes: 34 additions & 0 deletions design-document.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,34 @@
    # Title

    _Status_: {draft,in review, approved/declined}

    ## Goals

    - goal one
    - goal two (optional)
    - goal three (pushing it, don't try to boil all the oceans in one sitting)

    ## Non-goals

    - what doesn't it do
    - what is also out of scope

    ## Background

    _why do we need to do this_

    ## High-Level Design

    _what needs to be changed_

    ## Detailed Design

    _how is it going to change_

    ## Alternatives Considered

    _what seemed like the right answer, but was flawed_

    ## Security Considerations

    _does this introduce a security risk, how is it mitigated?_