Skip to content

Latest commit

 

History

History
268 lines (209 loc) · 8.36 KB

YYYY-MM-design-template.md

File metadata and controls

268 lines (209 loc) · 8.36 KB

Title

  • Author: Your name (@YourGitHubUserName)

Overview

Terms and definitions

Objectives

Issue Reference:

Goals

Non goals

User scenarios (optional)

User story 1

User story 2

User Experience (if applicable)

Sample Input:

Sample Output:

Sample Recipe Contract:

Design

High Level Design

Architecture Diagram

Detailed Design

Advantages (of each option considered)

Disadvantages (of each option considered)

Proposed Option

API design (if applicable)

CLI Design (if applicable)

Implementation Details

UCP (if applicable)

Bicep (if applicable)

Deployment Engine (if applicable)

Core RP (if applicable)

Portable Resources / Recipes RP (if applicable)

Error Handling

Test plan

Security

Compatibility (optional)

Monitoring and Logging

Development plan

Open Questions

Alternatives considered

Design Review Notes