Skip to main content
Version: v2

High-Level Design: [Feature Name]

FieldDetail
Author(s)[Name(s)]
Reviewers[Name(s)]
StatusDraft / In Review / Approved
Last UpdatedYYYY-MM-DD
Version1.0
Disclaimer

This is a high-level design document intended for planning and alignment purposes. All numbers, statuses, thresholds, and timelines mentioned are illustrative and subject to change during implementation. This document is not a specification or implementation contract.

1. Overview​

A short paragraph (3–5 sentences) explaining what this feature is and why it matters. Write it so that someone with no prior context can understand the purpose.

2. Problem Statement​

  • What problem are we solving?
  • Who is affected by this problem today?
  • What happens if we do nothing?

3. Goals & Non-Goals​

Goals​

  • Clearly state what this design aims to achieve.

Non-Goals​

  • Explicitly state what is out of scope to prevent misunderstandings.

4. Target Audience & Stakeholders​

StakeholderInterest / Concern
ProductBusiness value, user experience, success metrics
EngineeringFeasibility, system impact, dependencies, effort
QATestability, edge cases, acceptance criteria
ConsumersAPI contracts, integration steps, breaking changes

5. Current State (Before)​

Describe how things work today. Use a simple diagram if helpful.

6. Proposed Design (After)​

Describe the new flow at a high level. Focus on the "what" and "how it connects," not code-level details.

Key Components​

ComponentResponsibility

7. Data Flow​

Describe what data moves between systems and in what order. Keep it simple.

8. Key Decisions​

#DecisionReasoning

9. Dependencies​

DependencyTypeOwnerRisk Level

10. Success Metrics​

caution

Targets below are illustrative and subject to change during implementation.

MetricIndicative Target

11. Risks & Mitigations​

RiskImpactMitigation
  • Link to existing business docs, API docs, or engineering guides.