design-document.md

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?