Skip to content

Instantly share code, notes, and snippets.

@orvyl
Created February 23, 2026 10:31
Show Gist options
  • Select an option

  • Save orvyl/87824b88767cb2f95ba016e4c270e1a5 to your computer and use it in GitHub Desktop.

Select an option

Save orvyl/87824b88767cb2f95ba016e4c270e1a5 to your computer and use it in GitHub Desktop.

Design Note: <Feature / Integration / Enhancement Name>

  • Author:
  • Date:
  • Status: Draft / In Review / Approved
  • Stakeholders:
  • Target Release:

1. Problem Statement

What problem are we solving?

Clear, measurable description.

Who is impacted?

  • End users:
  • Internal teams:
  • External systems:

Why Now?

Urgency, regulatory need, scaling issue, performance degradation, etc.


2. Goals

Functional Goals

Non-Functional Goals

  • Performance:
  • Availability:
  • Security:
  • Scalability:
  • Compliance:

3. Non-Goals

Clarify what this design will NOT address.


4. Assumptions


5. High-Level Architecture

Insert diagram link (C1/C2/C3 if applicable)

Systems Involved:

Data Flow Summary: 1. 2. 3.


6. Detailed Design

6.1 API Design (If Applicable)

Endpoint:

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