Skip to content

Epic Template

A blank template to get started with spectryn.

Copy & Customize

Copy this template and replace the placeholders with your content.

markdown
# 📋 [Epic Title]

> **Epic: [Short Epic Description]**

---

## Epic Summary

| Field | Value |
|-------|-------|
| **Epic Name** | [Epic Name] |
| **Status** | 📋 Planned / 🔄 In Progress / ✅ Done |
| **Priority** | 🔴 Critical / 🟡 High / 🟢 Medium |
| **Start Date** | [Month Year] |
| **Target Release** | [Version] |

### Summary

[One paragraph summary of the epic - what is being built and why]

### Description

[Detailed description of the epic, including context and scope]

**Key Areas:**
- **Area 1**: Brief description
- **Area 2**: Brief description
- **Area 3**: Brief description

### Business Value

- **Value 1**: Description of business impact
- **Value 2**: Description of business impact
- **Value 3**: Description of business impact

---

## User Stories

---

### 🔧 US-001: [Story Title]

| Field | Value |
|-------|-------|
| **Story Points** | [1-13] |
| **Priority** | 🔴 Critical / 🟡 High / 🟢 Medium |
| **Status** | 📋 Planned / 🔄 In Progress / ✅ Done |

#### Description

**As a** [role/persona]
**I want** [feature/capability]
**So that** [benefit/value]

[Optional: Additional context about the story]

#### Acceptance Criteria

- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3
- [ ] Criterion 4

#### Technical Notes

[Optional: Technical details, code examples, architecture notes]

```typescript
// Example code if relevant
```

#### Subtasks

| # | Subtask | Description | SP | Status |
|---|---------|-------------|:--:|--------|
| 1 | [Subtask Name] | [Brief description of the work] | 1 | 📋 Planned |
| 2 | [Subtask Name] | [Brief description of the work] | 1 | 🔄 In Progress |
| 3 | [Subtask Name] | [Brief description of the work] | 1 | ✅ Done |

#### Related Commits

| Commit | Message |
|--------|---------|
| `abc1234` | feat: description of change |
| `def5678` | fix: description of fix |

#### Comments

> **@reviewer** (2025-01-15):
> Initial review feedback - looks good overall.
> Consider adding error handling for edge cases.

> **@developer** (2025-01-16):
> Good point! I'll add try/catch blocks in the next iteration.

---

### 🚀 US-002: [Next Story Title]

[Repeat the same structure for each user story...]

---

## Notes

- Stories should be ordered by dependency or priority
- Use consistent emoji indicators for status
- Keep subtask descriptions concise but actionable
- Story points should follow Fibonacci sequence (1, 2, 3, 5, 8, 13)

Quick Reference

Story Type Emojis

EmojiUse For
🔧Technical/Infrastructure
🚀New Feature
🎨UI/Design
🐛Bug Fix
📚Documentation
🔒Security
Performance
♻️Refactoring

Status Emojis

EmojiStatusJira
📋PlannedOpen
🔄In ProgressIn Progress
DoneResolved

Priority Emojis

EmojiPriority
🔴Critical
🟡High
🟢Medium/Low

Story Points (Fibonacci)

PointsComplexity
1Trivial - hours
2Simple - half day
3Moderate - 1-2 days
5Complex - 3-4 days
8Very complex - 1 week
13Epic-level - break down further

Minimal Template

For quick starts, use this minimal structure:

markdown
# 🚀 [Project Name]

## User Stories

---

### 🔧 US-001: [Title]

| Field | Value |
|-------|-------|
| **Story Points** | 3 |
| **Priority** | 🟡 High |
| **Status** | 📋 Planned |

#### Description

**As a** user
**I want** feature
**So that** benefit

#### Subtasks

| # | Subtask | Description | SP | Status |
|---|---------|-------------|:--:|--------|
| 1 | Task 1 | Description | 1 | 📋 Planned |
| 2 | Task 2 | Description | 2 | 📋 Planned |

---

Story ID Prefixes

Spectra supports flexible story ID prefixes. Use any uppercase letters followed by a dash and numbers:

Common Prefixes

PrefixExampleUse Case
US-US-001User Stories (default)
STORY-STORY-123Alternative story format
FEAT-FEAT-001Feature requests
BUG-BUG-042Bug tracking
TASK-TASK-001General tasks
SPIKE-SPIKE-003Technical spikes

Project-Based Prefixes

Match your issue tracker's project key:

PrefixExampleUse Case
PROJ-PROJ-789Project-based
ENG-ENG-123Engineering team
MOBILE-MOBILE-456Mobile team
API-API-100API team
INFRA-INFRA-050Infrastructure

Example with Mixed Prefixes

markdown
# Q4 Sprint Planning

## User Stories

### 🚀 FEAT-001: New Dashboard
**As a** user **I want** a dashboard **So that** I can see metrics

### 🐛 BUG-123: Fix Memory Leak
**As a** developer **I want** this fixed **So that** app is stable

### 🔧 INFRA-050: Upgrade Database
**As a** ops team **I want** newer version **So that** we get patches

Released under the MIT License.