Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Design Document Template

Design Document

Design Document Template Title: Date: Status: (draft, in review, approved, in progress)

Executive Summary

(2–4 sentences explaining the project)

Press/Release Note Summary

(2-4 sentences describing the deliverable from the customer's perspective)


(bullet list describing the problem being solved)


(bullet list describing the limits of the project)


(terminology and history one needs to know to understand the design)

High-Level Design

(a brief, high-level description of the design; diagrams are helpful)

Detailed Design

(the design in detail; usually a top-down description)

Alternatives Considered

(alternatives considered and rejected; include pros and cons of each)

Security Concerns

(security/ privacy ramifications and how those concerns are mitigated)

Open Issues

(security/ privacy ramifications and how those concerns are mitigated)

Limoncelli, Thomas A.; Chalup, Strata R.; Hogan, Christina J. (2014-09-01). The Practice of Cloud System Administration: Designing and Operating Large Distributed Systems, Volume 2 (p. 481). Pearson Education. Kindle Edition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.