Quick start
Get started with the SDD plugin by running a complete pipeline from requirements to code.Before you begin
Make sure you’ve installed the plugin and run/sdd:setup in your project directory.
The SDD plugin supports both greenfield (new) and brownfield (existing) projects. Choose the path that matches your situation.
New project (greenfield)
Start from zero and build a complete system with full traceability.Initialize the pipeline
Set up pipeline tracking:This creates
pipeline-state.json and verifies all components are ready.Gather requirements
Begin interactive requirements elicitation:The skill will guide you through:
- Stakeholder identification
- Elicitation techniques (interviews, prototypes, observation)
- Requirements writing in EARS syntax
- Quality validation
requirements/REQUIREMENTS.mdExample requirement format:Generate specifications
Transform requirements into formal technical specs:This generates:
- Domain model with entities and relationships
- Use cases (UC) with structured workflows
- API contracts with input/output schemas
- Behavior-driven development scenarios (BDD)
- System invariants (INV)
- Architecture decision records (ADR)
- Non-functional requirements (NFR)
spec/ directory with multiple filesAudit specifications
Automated quality review of all specs:Detects defects like:
- Ambiguous language
- Missing preconditions
- Untestable assertions
- Inconsistent workflows
- Security gaps
audits/AUDIT-BASELINE.mdPlan testing
Generate comprehensive test strategy:Creates:
- Test plan with scope and approach
- Traceability matrix (REQ → UC → BDD → Test)
- Performance scenarios with load profiles
- Edge case coverage analysis
test/ directoryDesign architecture
Create architecture with C4 diagrams:Generates:
- C4 Context, Container, and Component diagrams
- FASE files (Functional Architecture Specification Episodes)
- Implementation plan with phases
- Technology stack decisions
plan/ directoryGenerate tasks
Decompose architecture into atomic tasks:Each task:
- Maps to exactly one commit
- References source artifacts (FASE, UC, ADR)
- Includes acceptance criteria
- Specifies files to modify
task/ directory with TASK-F0-001.md, TASK-F0-002.md, etc.Existing project (brownfield)
Adopt SDD in a project that already has code.Diagnose your project
Get an adoption plan tailored to your codebase:The skill analyzes your project and classifies it into one of 8 scenarios:
- Code-only (no docs)
- Code + informal docs
- Code + formal specs but stale
- And 5 more scenarios
onboarding/ONBOARDING-REPORT.md with:- Health score (0-100)
- Detection signals (what was found)
- Recommended action plan
- Estimated effort per step
Import existing docs (optional)
Convert external documentation to SDD format:Supported formats:
- OpenAPI / Swagger (YAML, JSON)
- Jira exports (CSV, JSON)
- Markdown documents
- Notion pages
- Excel/CSV spreadsheets
requirements/REQUIREMENTS.md and spec/ filesReverse engineer from code
Extract specs from existing codebase:Analyzes code to generate:
- Requirements (inferred from behavior)
- Use cases (from API endpoints and functions)
- Domain model (from classes and types)
- Invariants (from validation logic)
- Architecture decisions (from patterns used)
- Dead code
- Technical debt
- Workarounds and infrastructure issues
requirements/REQUIREMENTS.mdspec/directoryfindings/FINDINGS-REPORT.md
Reconcile specs with code
Detect and fix drift between specs and implementation:Finds divergences classified as:
- New functionality (in code, not in specs)
- Removed features (in specs, not in code)
- Behavioral changes
- Refactorings
- Bugs or defects
reconciliation/RECONCILIATION-REPORT.md with alignment percentageMonitor and maintain
Once the pipeline is running, use these utilities:Check pipeline status
See where you are and what’s next:- Current stage
- Completed stages
- Pending stages
- Staleness warnings (if upstream artifacts changed)
View traceability
Generate an interactive HTML dashboard:- Pipeline — Progress through 7 stages
- Requirements — All REQs with coverage indicators
- Graph — Interactive network visualization
- Coverage — Gap analysis by domain/layer
- Search — Find any artifact by ID or text
The dashboard includes code and commit traceability if you have
src/ and .git/ in your project.Verify traceability chain
Check for broken links and orphans:- Orphaned artifacts (nothing references them)
- Broken references (reference non-existent IDs)
- Coverage gaps (REQs without UCs, UCs without TASKs, etc.)
Change a requirement
Update requirements with cascading changes:- Identifies all downstream artifacts affected
- Updates specs, tests, tasks, and code
- Maintains full traceability
- Creates an audit trail
Real-world example
Here’s what a complete trace looks like:Next steps
Pipeline skills
Deep dive into each of the 7 pipeline steps
Utility skills
Learn about security auditor and requirements change management
Traceability
Understand how artifacts connect from requirements to code
MCP tools
Use the traceability API for queries and impact analysis