specky-sdd 3.2.0 → 3.2.2

package/dist/templates/templates/analysis.md

@@ -0,0 +1,55 @@
+<!-- markdownlint-disable -->
+# {{project_name}} — Analysis
+
+> Traceability matrix, coverage report, gap analysis, and quality gate decision.
+
+---
+
+## Gate Decision
+
+**Decision:** {{gate_decision}}
+**Coverage:** {{coverage_percent}}%
+**Date:** {{date}}
+
+---
+
+## Traceability Matrix
+
+| Requirement | Design Component | Task | Test | Status |
+|-------------|-----------------|------|------|--------|
+{{traceability_matrix}}
+
+---
+
+## Coverage Report
+
+- **Requirements with design mapping:** {{design_coverage}}
+- **Requirements with task mapping:** {{task_coverage}}
+- **Requirements with test mapping:** {{test_coverage}}
+- **Overall coverage:** {{coverage_percent}}%
+
+---
+
+## Gap Analysis
+
+{{#each gaps}}
+- {{this}}
+{{/each}}
+
+---
+
+## Recommendations
+
+{{#each recommendations}}
+- {{this}}
+{{/each}}
+
+---
+
+## Quality Metrics
+
+| Metric | Value | Target | Status |
+|--------|-------|--------|--------|
+| EARS compliance | {{ears_compliance}} | 100% | {{ears_status}} |
+| Requirement coverage | {{coverage_percent}}% | ≥90% | {{coverage_status}} |
+| Orphan requirements | {{orphan_count}} | 0 | {{orphan_status}} |

package/dist/templates/templates/api-docs.md

@@ -0,0 +1,40 @@
+<!-- markdownlint-disable -->
+# API Documentation: {{title}}
+
+**Feature**: {{feature_id}}
+**Version**: {{version}}
+**Base URL**: `{{base_url}}`
+**Date**: {{date}}
+
+---
+
+{{#each endpoints}}
+## {{method}} `{{path}}`
+
+{{description}}
+
+### Request
+
+```json
+{{request}}
+```
+
+### Response
+
+```json
+{{response}}
+```
+
+### Status Codes
+
+| Code | Description |
+|------|-------------|
+| 200 | Success |
+| 400 | Bad Request |
+| 401 | Unauthorized |
+| 404 | Not Found |
+| 500 | Internal Server Error |
+
+---
+
+{{/each}}

package/dist/templates/templates/bugfix.md

@@ -0,0 +1,46 @@
+<!-- markdownlint-disable -->
+# Bugfix Spec: {{bug_title}}
+
+> Structured specification for bug investigation and resolution.
+
+---
+
+## 1. Current Behavior
+
+{{current_behavior}}
+
+---
+
+## 2. Expected Behavior
+
+{{expected_behavior}}
+
+---
+
+## 3. Unchanged Behavior
+
+The following behaviors must remain unchanged after the fix:
+
+{{#each unchanged_behavior}}
+- {{this}}
+{{/each}}
+
+---
+
+## 4. Root Cause Analysis
+
+{{root_cause}}
+
+---
+
+## 5. Test Plan
+
+{{test_plan}}
+
+---
+
+## Metadata
+
+- **Reported:** {{date}}
+- **Severity:** {{severity}}
+- **Related Requirements:** {{related_requirements}}

package/dist/templates/templates/checklist.md

@@ -0,0 +1,29 @@
+<!-- markdownlint-disable -->
+# Quality Checklist: {{title}}
+
+**Feature**: {{feature_id}}
+**Domain**: {{domain}}
+**Date**: {{date}}
+**Mandatory Pass Rate**: {{mandatory_pass_rate}}
+
+---
+
+## Checklist Items
+
+| ID | Check | Mandatory | Status | Evidence |
+|----|-------|-----------|--------|----------|
+{{#each items}}
+| {{id}} | {{check}} | {{mandatory}} | {{status}} | {{evidence}} |
+{{/each}}
+
+## Summary
+
+- **Total**: {{total_items}}
+- **Passed**: {{pass_count}}
+- **Failed**: {{fail_count}}
+- **Pending**: {{pending_count}}
+- **Mandatory Pass Rate**: {{mandatory_pass_rate}}%
+
+## Gate Decision
+
+{{gate_decision}}

package/dist/templates/templates/compliance.md

@@ -0,0 +1,28 @@
+<!-- markdownlint-disable -->
+# Compliance Report: {{title}}
+
+**Feature**: {{feature_id}}
+**Framework**: {{framework}}
+**Date**: {{date}}
+**Overall Status**: {{overall_status}}
+
+---
+
+## Controls Assessment
+
+| Control ID | Name | Status | Evidence | Remediation |
+|-----------|------|--------|----------|-------------|
+{{#each findings}}
+| {{control_id}} | {{control_name}} | {{status}} | {{evidence}} | {{remediation}} |
+{{/each}}
+
+## Summary
+
+- **Controls Checked**: {{controls_checked}}
+- **Passed**: {{controls_passed}}
+- **Failed**: {{controls_failed}}
+- **N/A**: {{controls_na}}
+
+## Recommendation
+
+{{recommendation}}

package/dist/templates/templates/constitution.md

@@ -0,0 +1,57 @@
+<!-- markdownlint-disable -->
+# {{project_name}} — Constitution
+
+> The foundational charter for the **{{project_name}}** project, establishing principles, constraints, and success criteria.
+
+---
+
+## Article 1: Project Identity
+
+- **Name:** {{project_name}}
+- **Description:** {{description}}
+- **Creator:** {{author}}
+- **License:** {{license}}
+
+---
+
+## Article 2: Principles
+
+{{#each principles}}
+- {{this}}
+{{/each}}
+
+---
+
+## Article 3: Constraints
+
+{{#each constraints}}
+- {{this}}
+{{/each}}
+
+---
+
+## Article 4: Success Criteria
+
+| ID | Criterion | Measure |
+|----|-----------|---------|
+| SC-001 | Project compiles without errors | `npm run build` exits 0 |
+| SC-002 | All requirements traceable | Every REQ has design + task mapping |
+| SC-003 | Quality gates pass | Analysis gate returns APPROVE |
+
+---
+
+## Article 5: Scope
+
+### In Scope
+- {{scope_in}}
+
+### Out of Scope
+- {{scope_out}}
+
+---
+
+## Amendment Log
+
+| # | Date | Author | Rationale | Articles Affected |
+|---|------|--------|-----------|-------------------|
+| — | — | — | Initial version | All |

package/dist/templates/templates/cross-analysis.md

@@ -0,0 +1,46 @@
+<!-- markdownlint-disable -->
+# Cross-Artifact Analysis: {{title}}
+
+**Feature**: {{feature_id}}
+**Date**: {{date}}
+**Consistency Score**: {{consistency_score}}%
+
+---
+
+## Spec → Design Alignment
+
+| Requirement | In Design? | Detail |
+|-------------|-----------|--------|
+{{#each spec_design_alignment}}
+| {{source_id}} | {{status}} | {{detail}} |
+{{/each}}
+
+## Design → Tasks Alignment
+
+| Requirement | Has Tasks? | Detail |
+|-------------|-----------|--------|
+{{#each design_tasks_alignment}}
+| {{source_id}} | {{status}} | {{detail}} |
+{{/each}}
+
+## Orphaned Requirements
+
+{{#each orphaned_requirements}}
+- {{this}} — No design or task coverage
+{{/each}}
+
+## Orphaned Tasks
+
+{{#each orphaned_tasks}}
+- {{this}} — Not traced to any requirement
+{{/each}}
+
+## Traceability Diagram
+
+```mermaid
+{{diagram}}
+```
+
+## Recommendation
+
+{{recommendation}}

package/dist/templates/templates/data-model.md

@@ -0,0 +1,35 @@
+<!-- markdownlint-disable -->
+# Data Model: {{title}}
+
+**Feature**: {{feature_id}}
+**Date**: {{date}}
+
+---
+
+## Entities
+
+{{#each entities}}
+### {{name}}
+
+**Description**: {{description}}
+
+| Attribute | Type | Required | Description |
+|-----------|------|----------|-------------|
+{{#each attributes}}
+| {{name}} | {{type}} | {{required}} | {{description}} |
+{{/each}}
+
+{{/each}}
+
+## Relationships
+
+```mermaid
+erDiagram
+{{mermaid_erd}}
+```
+
+## Constraints
+
+{{#each constraints}}
+- {{this}}
+{{/each}}

package/dist/templates/templates/design.md

@@ -0,0 +1,104 @@
+<!-- markdownlint-disable -->
+# {{project_name}} — Design
+
+> Complete system design covering architecture, data, APIs, security, infrastructure, and decisions.
+
+---
+
+## 1. System Context (C4 Level 1)
+
+> Who uses the system and what external systems does it integrate with?
+
+{{system_context}}
+
+---
+
+## 2. Container Architecture (C4 Level 2)
+
+> What are the deployable units (APIs, databases, queues, frontends) and how do they communicate?
+
+{{container_architecture}}
+
+---
+
+## 3. Component Design (C4 Level 3)
+
+> What are the internal modules/services within each container and their responsibilities?
+
+{{component_design}}
+
+---
+
+## 4. Code-Level Design (C4 Level 4)
+
+> Key classes, interfaces, patterns, and their relationships.
+
+{{code_level_design}}
+
+---
+
+## 5. System Diagrams
+
+{{#each diagrams}}
+### {{this}}
+{{/each}}
+
+---
+
+## 6. Data Model
+
+> Entities, relationships, storage strategy, and data flow.
+
+{{data_models}}
+
+---
+
+## 7. API Contracts
+
+> Endpoints, request/response schemas, authentication, and error codes.
+
+{{api_contracts}}
+
+---
+
+## 8. Infrastructure & Deployment
+
+> How the system is deployed, scaled, monitored, and operated.
+
+{{infrastructure}}
+
+---
+
+## 9. Security Architecture
+
+> Authentication, authorization, encryption, secrets management, and threat model.
+
+{{security_architecture}}
+
+---
+
+## 10. Architecture Decision Records
+
+{{#each adrs}}
+### {{this}}
+{{/each}}
+
+---
+
+## 11. Error Handling Strategy
+
+> How errors are detected, logged, propagated, and recovered from.
+
+{{error_handling}}
+
+---
+
+## 12. Cross-Cutting Concerns
+
+> Logging, monitoring, caching, configuration, feature flags, and observability.
+
+{{cross_cutting}}
+
+---
+
+**Covers:** {{requirement_references}}

package/dist/templates/templates/devcontainer.md

@@ -0,0 +1,36 @@
+<!-- markdownlint-disable -->
+# Dev Container: {{title}}
+
+**Feature**: {{feature_id}}
+**Base Image**: {{base_image}}
+**Date**: {{date}}
+
+---
+
+## Configuration
+
+```json
+{{devcontainer_json}}
+```
+
+## Included Features
+
+{{#each features}}
+- {{this}}
+{{/each}}
+
+## VS Code Extensions
+
+{{#each extensions}}
+- {{this}}
+{{/each}}
+
+## Getting Started
+
+1. Open VS Code in the project root
+2. Press `Ctrl+Shift+P` → "Dev Containers: Reopen in Container"
+3. Wait for the container to build
+4. Start developing!
+
+Alternatively, use GitHub Codespaces:
+- Run `sdd_setup_codespaces` to create a cloud environment

package/dist/templates/templates/dockerfile.md

@@ -0,0 +1,34 @@
+<!-- markdownlint-disable -->
+# Container Configuration: {{title}}
+
+**Feature**: {{feature_id}}
+**Language**: {{language}}
+**Framework**: {{framework}}
+**Date**: {{date}}
+
+---
+
+## Dockerfile
+
+```dockerfile
+{{dockerfile_content}}
+```
+
+## Docker Compose
+
+```yaml
+{{compose_content}}
+```
+
+## .dockerignore
+
+```
+{{dockerignore_content}}
+```
+
+## Build & Run
+
+```bash
+docker build -t {{image_name}} .
+docker run -p {{port}}:{{port}} {{image_name}}
+```

package/dist/templates/templates/journey.md

@@ -0,0 +1,73 @@
+<!-- markdownlint-disable -->
+# {{project_name}} — SDD Journey
+
+> Complete documentation of the Spec-Driven Development process for this project.
+
+---
+
+## 1. Methodology Overview
+
+This project was built using **Spec-Driven Development (SDD)**, a methodology that enforces traceability between requirements, design, implementation, and tests. SDD uses a 10-phase pipeline where each phase builds on the previous one, and every artifact is traceable to a requirement.
+
+### The 10 Phases
+
+| # | Phase | Purpose | Required Artifact |
+|---|-------|---------|-------------------|
+| 1 | Init | Establish project constitution | CONSTITUTION.md |
+| 2 | Discover | Explore problem space | Discovery Q&A |
+| 3 | Specify | Write EARS requirements | SPECIFICATION.md |
+| 4 | Clarify | Resolve ambiguity | Clarification Q&A |
+| 5 | Design | Architecture & system design | DESIGN.md |
+| 6 | Tasks | Implementation breakdown | TASKS.md |
+| 7 | Analyze | Quality gate | ANALYSIS.md |
+| 8 | Implement | Build following the plan | CHECKLIST.md |
+| 9 | Verify | Validate against spec | VERIFICATION.md |
+| 10 | Release | Documentation & deployment | PR + Docs |
+
+---
+
+## 2. Phase-by-Phase Journey
+
+{{phase_journey}}
+
+---
+
+## 3. Quality Gate Results
+
+{{gate_results}}
+
+---
+
+## 4. Diagrams Generated
+
+{{diagrams_summary}}
+
+---
+
+## 5. Architecture Decisions
+
+{{architecture_decisions}}
+
+---
+
+## 6. Traceability Matrix
+
+{{traceability_matrix}}
+
+---
+
+## 7. Metrics & Coverage
+
+{{metrics_summary}}
+
+---
+
+## 8. Lessons & Observations
+
+{{lessons}}
+
+---
+
+**Generated by:** SDD Pipeline v{{version}}
+**Date:** {{date}}
+**Total Phases Completed:** {{phases_completed}}/10

package/dist/templates/templates/onboarding.md

@@ -0,0 +1,49 @@
+<!-- markdownlint-disable -->
+# Developer Onboarding: {{title}}
+
+**Feature**: {{feature_id}}
+**Date**: {{date}}
+
+---
+
+## Welcome
+
+> This guide helps you understand and contribute to **{{title}}**.
+
+## What This Feature Does
+
+{{feature_description}}
+
+## Architecture Overview
+
+{{architecture_overview}}
+
+## Getting Started
+
+1. Clone the repository
+2. Install dependencies
+3. Read `.specs/{{feature_id}}/SPECIFICATION.md`
+4. Review `.specs/{{feature_id}}/DESIGN.md`
+5. Check `.specs/{{feature_id}}/TASKS.md` for open tasks
+
+## Key Concepts
+
+| Concept | Description |
+|---------|-------------|
+| EARS Notation | Requirements follow the Easy Approach to Requirements Syntax |
+| SDD Pipeline | Spec → Design → Tasks → Implement → Verify |
+| Traceability | Every task traces to a requirement (REQ-XXX-NNN) |
+| Quality Gates | Each phase requires validation before advancing |
+
+## Where to Find Things
+
+| What | Where |
+|------|-------|
+| Requirements | `.specs/{{feature_id}}/SPECIFICATION.md` |
+| Architecture | `.specs/{{feature_id}}/DESIGN.md` |
+| Tasks | `.specs/{{feature_id}}/TASKS.md` |
+| Quality Report | `.specs/{{feature_id}}/ANALYSIS.md` |
+
+## How to Contribute
+
+{{contribution_guide}}

package/dist/templates/templates/research.md

@@ -0,0 +1,39 @@
+<!-- markdownlint-disable -->
+# Research: {{title}}
+
+**Feature**: {{feature_id}}
+**Date**: {{date}}
+**Status**: {{status}}
+
+---
+
+## Open Questions
+
+{{#each questions}}
+### {{id}}: {{question}}
+
+**Context**: {{context}}
+
+**Findings**: {{findings}}
+
+**Sources**: {{sources}}
+
+**Recommendation**: {{recommendation}}
+
+**Status**: {{status}}
+
+---
+
+{{/each}}
+
+## Summary
+
+| Question | Status | Recommendation |
+|----------|--------|---------------|
+{{#each questions}}
+| {{id}} | {{status}} | {{recommendation}} |
+{{/each}}
+
+## Next Steps
+
+[TODO: next_steps]