Skip to content

Instantly share code, notes, and snippets.

@icco

icco/designdoc.md

Last active August 29, 2015 14:03
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save icco/4089b266ba1db4b1c34f to your computer and use it in GitHub Desktop.
Save icco/4089b266ba1db4b1c34f to your computer and use it in GitHub Desktop.
Download ZIP
Design Doc Template
Raw
designdoc.md

Title

Objective

In a few sentences, describe the key system objectives.

Background

Stuff one needs to know to understand this doc: motivating examples, previous versions and problems, links to related projects/design docs, etc. Note: this is background; do not write about your design or ideas to solve problems here.

Overview

One page high-level overview; put details in the next section and background in the previous section. Should be understandable by a software engineer not working on the project.

Detailed Design

...

Dependencies

...

Alternatives Considered

You may need to describe what you did not do or why simpler approaches don't work. Mention other things to watch out for (if any).

Security Considerations

...

Privacy Considerations

...

##Testing Plan

...

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