LiorCohen/sdd / plugin/core/skills/spec-writing
spec-writing
VerifiedTemplates and validation for writing product specifications.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.2 KB |
| resources/epic-spec-template.md | markdown | 1.9 KB |
| resources/feature-spec-template.md | markdown | 4.4 KB |
| resources/frontmatter-validation.md | markdown | 3.3 KB |
| resources/other-templates.md | markdown | 2.0 KB |
| schemas/input.schema.json | config | 1.1 KB |
| schemas/output.schema.json | config | 1.3 KB |
resources/feature-spec-template.md
View on GitHub# Feature Spec Template (Tech Spec)
```markdown
---
title: [Feature Name]
spec_type: tech
type: feature
status: active
domain: [Domain Name]
issue: [PROJ-XXX or GitHub issue URL]
created: YYYY-MM-DD
updated: YYYY-MM-DD
sdd_version: [X.Y.Z]
---
# Feature: [Feature Name]
## Overview
[1-2 sentences: what this feature does and why it matters]
## Domain Concepts
**Definitions:**
- [Definition](../../domain/definitions/definition.md) - how it's used here
**New concepts introduced:**
- [Concept]: [Definition]
## User Stories
### [Story Group]
- As a [role], I want [capability] so that [benefit]
## Acceptance Criteria
### [Capability Group]
- [ ] **AC1:** Given [precondition], when [action], then [result]
- [ ] **AC2:** Given [precondition], when [action], then [result]
## API Contract
### [METHOD] [/path]
**Description:** [What this endpoint does]
**Request:**
```json
{ "field": "type" }
```
**Response (2XX):**
```json
{ "data": { "field": "type" } }
```
**Errors:**
| Status | Code | Condition |
|--------|------|-----------|
| 400 | `validation_error` | Invalid input |
| 404 | `not_found` | Resource not found |
## Edge Cases
| Case | Expected Behavior |
|------|-------------------|
| [Edge case] | [How it's handled] |
## Security Considerations
- [Security requirement or constraint]
## Domain Model
> Comprehensive domain knowledge extracted from this change.
### Entities
| Entity | Definition | Spec Path | Status |
|--------|------------|-----------|--------|
| [Entity] | [What it represents] | specs/domain/[entity].md | New/Existing |
### Relationships
```text
[Entity A] ──── [relationship] ───→ [Entity B]
```
### Glossary
| Term | Definition | First Defined In |
|------|------------|------------------|
| [Term] | [Definition] | This spec |
### Bounded Contexts
- **[Context Name]**: [Entities in this context]
## Specs Directory Changes
> **REQUIRED**: Every change to `specs/` must be declared here.
### Before
```text
specs/
└── [current structure]
```
### After
```text
specs/
└── [new structure with comments: # NEW, # MODIFIED]
```
### Changes Summary
| Path | Action | Description |
|------|--------|-------------|
| [path] | Create/Modify | [What changes] |
## Components
### New Components
| Component | Type | Purpose |
|-----------|------|---------|
| [Name] | [service/component] | [Purpose] |
### Modified Components
| Component | Changes |
|-----------|---------|
| [Name] | [What changes] |
## System Analysis
### Inferred Requirements
- [System-inferred requirements beyond explicit spec]
### Gaps & Assumptions
- [Identified gaps or assumptions]
## Requirements Discovery
> Complete Q&A trail from spec solicitation. Never delete entries.
### Transformation Phase
| # | Question | Answer | Source |
|---|----------|--------|--------|
| T1 | [Question about gaps/ambiguities] | [User's answer] | User |
| T2 | [Question about undefined behavior] | [Default used] | Assumption |
### Component Discovery Phase
| # | Question | Answer | Source |
|---|----------|--------|--------|
| D1 | Does data need persistence? | [Answer] | User |
| D2 | Are there external API consumers? | [Answer] | User |
### Solicitation Phase
| # | Question | Answer | Source |
|---|----------|--------|--------|
| S1 | [Deep-dive question for component] | [Answer] | User |
| S2 | [Follow-up] [Clarification question] | [Answer] | User |
### User Feedback & Corrections
- [YYYY-MM-DD] [Feedback or correction captured during review]
### Open Questions
> Questions that must be resolved before spec approval. BLOCKING questions prevent approval.
| # | Question | Status | Blocker For |
|---|----------|--------|-------------|
| O1 | [Unresolved question] | OPEN | [Section affected] |
**Question Status Legend:**
- `OPEN` - Not yet answered, blocks approval
- `ANSWERED` - User provided answer
- `ASSUMED` - User said "I don't know", default documented
- `DEFERRED` - Moved to later phase (requires justification)
## Testing Strategy
### Unit Tests
| Component | Test Case | Expected Behavior |
|-----------|-----------|-------------------|
| [Component] | [Scenario] | [Expected result] |
### Integration Tests
| Scenario | Components | Expected Outcome |
|----------|------------|------------------|
| [Scenario] | [A → B] | [Result] |
### E2E Tests
| User Flow | Steps | Expected Result |
|-----------|-------|-----------------|
| [Flow] | [Steps] | [Outcome] |
## Out of Scope
- [What this feature explicitly does NOT cover]
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |