Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 669 Bytes

template.md

File metadata and controls

26 lines (18 loc) · 669 Bytes

Executive Summary

(2-4 sentences explaining the project)

Goals

(bullet list describing the problem being solved)

Non-goals

(bullet list describing the limits of the project)

Background

(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)

Security Concerns

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

Open Issues

(questions regarding requirements, mockups, etc)