Design Create

Create design documents for features or systems. Use when architecture planning, API design, or technical decisions are needed before implementation.

LuizEduPP cc033be 1.1 KB Updated

File contents

Create Design Document

Create comprehensive design documents that guide implementation.

Workflow

  1. Analyze - Understand the requirement
  2. Research - Check existing patterns
  3. Design - Create architecture
  4. Document - Write design doc
  5. Review - Get approval

Template

# Design: [Feature Name]

## Overview
[What this covers]

## Goals
- Goal 1
- Goal 2

## Non-Goals
- What this does NOT cover

## Architecture

### Components
| Component | Responsibility |
|-----------|----------------|
| A | Does X |
| B | Does Y |

### API Design (if applicable)
#### POST /api/example
- Request: `{ "field": "value" }`
- Response: `{ "result": "value" }`

## Alternatives Considered
| Option | Pros | Cons |
|--------|------|------|
| A | ... | ... |

## Risks
| Risk | Mitigation |
|------|------------|
| Risk 1 | How to handle |

Storage

Save to design/[feature-name].md

LuizEduPP/skills/tree/main/design-create commit cc033be5e4

Frequently asked questions

npx skillmds@latest add luizedupp/design-create