spec-authoring
Author ADR, PRD, and SDS specifications following SEA™ templates with full traceability. Use when creating architecture decision records (ADRs), product requirement documents (PRDs), or software design specifications (SDS) that require proper spec-to-code traceability and document relationships.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Specification Authoring Skill
Creates properly structured ADR, PRD, and SDS documents with full traceability.
Document Types
ADR (Architecture Decision Record)
Purpose: Capture architecture decisions with context, options, and consequences.
Template Fields:
- ADR-ID (e.g., ADR-031)
- Status (Proposed, Accepted, Deprecated)
- Context & Problem Statement
- Decision Drivers
- Considered Options
- Decision Outcome
- Consequences (positive, negative, neutral)
- Links to follow-up PRDs/SDS
PRD (Product Requirement Document)
Purpose: Define product requirements and acceptance criteria.
Template Fields:
- PRD-ID (e.g., PRD-020)
- Problem Statement
- User Stories (EARS format)
- Functional Requirements (FR-###)
- Non-Functional Requirements (NFR-###)
- Acceptance Criteria
- Traceability to ADRs
SDS (Software Design Specification)
Purpose: Detailed technical design with SEA-DSL flows.
Format: YAML frontmatter + Markdown content
Template Fields:
- SDS-ID (e.g., SDS-045)
- Bounded Context
- Service/Component name
- Implements (ADR/PRD references)
- SEA-DSL specification
- API contracts
- Invariants
Traceability Chain
ADR → PRD → SDS → SEA-DSL → Generated Code
Each document MUST reference its upstream documents:
- SDS must reference PRD and/or ADR it implements
- PRD must reference ADR it satisfies
Workflow
- Identify what decision/requirement/design to document
- Choose appropriate document type (ADR/PRD/SDS)
- Use
/specworkflow to create from template - Fill in all required fields
- Add traceability links
- Validate with
just spec-guard
File Locations
| Type | Path Pattern |
|---|---|
| ADR | docs/specs/<context>/adr/<###>-<name>.md |
| PRD | docs/specs/<context>/prd/<###>-<name>.md |
| SDS | docs/specs/<context>/sds/<###>-<name>.sds.yaml or .md |
Related Skills
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!