Key Features
SpecWeave provides a comprehensive suite of tools and workflows for building production-grade software with AI assistance.
π Two Ways to Work (Flexibility for All Project Sizes)β
Interactive Quick Buildβ
Perfect for: Small projects, prototypes, learning
Simply describe what you want - SpecWeave guides you through interactive prompts:
- Approach - Quick build or spec-first planning
- Features - Multi-select checkboxes for capabilities
- Tech Stack - Choose your tools
- Review & Submit - Confirm and start building
Result: 2 minutes from idea to working code
Example:
"build a very simple web calculator app"
β Select features: β Basic ops β Keyboard β History
β Choose stack: React
β Build! π
Specification-First Workflowβ
Perfect for: Production features, team projects, complex systems
Professional planning with slash commands and multi-agent coordination:
/sw:increment "user authentication"
# PM, Architect, QA agents create:
# β
spec.md (requirements with AC-IDs)
# β
plan.md (architecture + test strategy)
# β
tasks.md with embedded tests (v0.7.0+)
/sw:do
# Implement with hooks auto-updating docs
Both approaches use the same powerful plugin system and multi-agent architecture under the hood!
π― Specification-First Developmentβ
Append-Only Snapshots + Living Documentationβ
SpecWeave's Core Power: Maintains both historical audit trails and current documentation simultaneously.
The Innovation: Unlike traditional documentation that gets outdated or loses historical context, SpecWeave gives you BOTH:
πΈ Append-Only Increment Snapshots (Historical Context)β
.specweave/increments/
βββ 0001-user-authentication/
β βββ spec.md # What was planned (AC-IDs)
β βββ plan.md # How it was built + test strategy
β βββ tasks.md # What was done + embedded tests (v0.7.0+)
β βββ logs/ # Execution history
βββ 0002-oauth-integration/ # Extends/modifies 0001
βββ 0003-password-reset/ # Related feature
Never modified after completion - Complete audit trail of every feature built.
π Living Up-to-Date Documentation (Current State)β
.specweave/docs/
βββ internal/
β βββ strategy/ # WHAT and WHY (PRDs, user stories)
β βββ architecture/ # HOW (system design, ADRs, RFCs)
β βββ delivery/ # Roadmap, release plans
β βββ operations/ # Runbooks, SLOs, monitoring
β βββ governance/ # Security, compliance
βββ public/ # Customer-facing documentation
Auto-updated after each task - Always reflects current code state.
Why This Mattersβ
| Problem | Traditional Approach | SpecWeave Solution |
|---|---|---|
| "Why did we do it this way?" | Context lost, tribal knowledge | Read historical increment snapshots |
| "What's the current architecture?" | Docs outdated | Living docs auto-updated |
| "What changed in this feature?" | Git commits only | Complete increment snapshot with spec, plan, tests |
| "Prove compliance" | Reconstruct from memory | Complete audit trail in increments |
| "Onboard new developer" | Days of reading code | Read current docs + historical increments |
Real-World Benefitsβ
- Compliance-Ready: SOC 2, HIPAA, FDA audits have complete paper trail
- Context Recovery: Understand decisions made 6 months ago
- Impact Analysis: See all related changes by searching increments
- Rollback Intelligence: Know exactly what to revert
- Knowledge Transfer: No tribal knowledge silos
- Debugging: Trace feature evolution across increments
Think of it as "Git for Specifications":
- Increments = commits (immutable snapshots)
- Living docs = working directory (current state)
- Both essential, both version controlled
5-Pillar Documentation Structureβ
Living documentation organized by purpose:
π§ Context Precision (70%+ Token Reduction)β
Selective Loadingβ
- Context Manifests: Each increment declares what it needs
- Section Anchors: Load specific sections, not entire files
- Glob Patterns: Match multiple related files
- Cache-Friendly: Reuse frequently-loaded context
Example Manifestβ
```yaml spec_sections:
- .specweave/docs/internal/strategy/auth/login-spec.md
- .specweave/docs/internal/strategy/auth/oauth.md#token-flow documentation:
- .specweave/docs/internal/architecture/adr/0001-auth-method.md max_context_tokens: 10000 ```
Result: Load exactly what's needed, save 70%+ on AI costs.
π€ AI Agents & Skillsβ
11 Core Agentsβ
| Agent | Role | Expertise |
|---|---|---|
| PM | Product Manager AI | Requirements, user stories, market research, roadmaps |
| Architect | System Architect | Design, ADRs, component architecture, C4 diagrams |
| Tech Lead | Technical Lead | Code review, best practices, technical guidance |
| QA Lead | Quality Assurance | Test strategy, test cases, coverage validation |
| Security | Security Engineer | Threat modeling, security scanning, vulnerability analysis |
| Performance | Performance Engineer | Optimization, profiling, scalability analysis |
| Docs Writer | Technical Writer | Documentation creation, guides, API references |
| TDD Orchestrator | TDD Master | Red-Green-Refactor workflow, test-first development |
| Test-Aware Planner | Test Planning Specialist | Test case generation, AC-ID mapping, coverage targets |
| Translator | Multilingual Support | Content translation, i18n workflows |
| Code Reviewer | Code Review Specialist | Quality gates, code analysis, review automation |
Auto-Role Routingβ
Skills automatically detect expertise and route requests:
``` User: "Create authentication system" β specweave-detector activates β Routes to increment-planner β Invokes PM, Architect, Tech Lead agents β Generates complete spec + architecture + plan ```
π§ͺ Test-Validated Developmentβ
Test-Aware Planning (v0.7.0+)β
-
Specification Acceptance Criteria (AC-ID format: AC-US1-01)
- Business-level acceptance criteria in spec.md
- Technology-agnostic validation
- Linked to user stories
-
Embedded Test Plans (tasks)
- BDD format (Given/When/Then) per task
- Maps AC-IDs to test implementations
- Coverage targets (80-90% per task)
-
Skill Test Cases (YAML-based)
- Minimum 3 tests per skill
- Structured validation
-
Code Tests (Automated)
- E2E with Playwright (MANDATORY for UI)
- Unit and integration tests
-
80% coverage for critical paths
Truth-Telling Requirementβ
E2E tests MUST tell the truth:
- β If test passes β feature actually works
- β If test fails β exactly what failed
- β No false positives
- β No masking failures
π Mermaid Diagrams (C4 Model)β
Architecture Visualizationβ
SpecWeave uses the C4 Model for architecture diagrams:
- C4-1: Context - System boundaries, external actors
- C4-2: Container - Applications, services, databases
- C4-3: Component - Internal structure
- C4-4: Code - Class diagrams (optional)
Example Diagramβ
```mermaid C4Context title System Context Diagram for SpecWeave
Person(user, "Developer", "Uses SpecWeave to build software") System(specweave, "SpecWeave", "Spec-Driven Development Framework") System_Ext(claude, "Claude Code", "AI coding assistant") System_Ext(github, "GitHub", "Version control and CI/CD")
Rel(user, specweave, "Uses") Rel(specweave, claude, "Invokes agents") Rel(specweave, github, "Syncs increments") ```
π Framework-Agnosticβ
Supports ANY Tech Stackβ
- TypeScript/JavaScript: Next.js, NestJS, Express, React
- Python: FastAPI, Django, Flask
- Go: Gin, Echo, Fiber
- Rust: Actix, Rocket, Axum
- Java: Spring Boot, Quarkus
- C#/.NET: ASP.NET Core, Blazor
Auto-Detectionβ
SpecWeave detects your tech stack from:
package.jsonβ TypeScript/JavaScriptrequirements.txt/pyproject.tomlβ Pythongo.modβ GoCargo.tomlβ Rustpom.xml/build.gradleβ Java*.csprojβ C#/.NET
π Incremental Developmentβ
Auto-Numbered Incrementsβ
``` .specweave/increments/ βββ 0001-user-authentication/ β βββ spec.md # What and Why (with AC-IDs) β βββ plan.md # How (architecture + test strategy) β βββ tasks.md # Checklist + embedded tests (v0.7.0+) β βββ logs/ # Execution logs β βββ scripts/ # Helper scripts β βββ reports/ # Completion reports βββ 0002-payment-processing/ βββ ... ```
WIP Limitsβ
Prevent context-switching:
- Solo/small teams: 1-2 in progress
- Large teams: 3-5 in progress
- Force override: Available but discouraged
π External Tool Sync (GitHub/JIRA/ADO)β
No Tool Lock-in: SpecWeave integrates with your existing project management tools. Keep your workflowβjust add specifications.
Why This Mattersβ
| Problem | Without SpecWeave | With SpecWeave |
|---|---|---|
| Team uses JIRA | Abandon JIRA or maintain two systems | Specs push to JIRA, status reads back |
| GitHub Issues workflow | Manual updates, drift | Auto-sync progress to issues |
| Azure DevOps enterprise | Complex migration | Native integration, no disruption |
| Multiple tools | Constant context switching | SpecWeave syncs to all |
GitHub Issues Syncβ
/sw-github:sync
- Milestones β Release Plans
- Issues β User Stories/Tasks with checkable subtasks
- Progress auto-updates as tasks complete
- Labels auto-generated from increment metadata
JIRA Syncβ
/sw-jira:sync
- Content sync - specs push to JIRA, status reads back
- Epics β Features/Increments
- Stories β User Stories (PRDs/RFCs)
- Tasks β Tasks with AC-ID mapping
Azure DevOps Syncβ
/sw-ado:sync
- 4-level hierarchy support (Epics β Features β User Stories β Tasks)
- Area Paths and Iterations mapping
- Work item synchronization with status updates
- Enterprise-ready with PAT authentication
Key Benefitsβ
- Keep Your Workflow - Teams continue using familiar tools
- Single Source of Truth - Specs drive everything, tools reflect state
- Auto-Sync Progress - Complete a task β issue updates automatically
- Gradual Adoption - Start with one project, expand when ready
- Audit Trail - All syncs logged in increment metadata
π’ Brownfield Excellence (The Hardest Problem Solved)β
Why Brownfield is Most Complicatedβ
Brownfield projects are the ultimate challenge in software development:
-
β Existing codebase with zero or outdated documentation
-
β Tribal knowledge scattered across team members
-
β Risk of breaking production with every change
-
β Need to merge with existing docs, wikis, Confluence pages
-
β Complex architecture that was never properly documented
-
β Living documentation that stays current as code evolves
Most frameworks give up here. SpecWeave excels.
Intelligent Documentation Mergingβ
SpecWeave's brownfield-onboarder skill intelligently consolidates existing documentation:
"Read brownfield-onboarder skill and merge my existing docs/"
What it does:
-
π Extracts knowledge from existing docs, wikis, Confluence, legacy CLAUDE.md
-
π§ Preserves context - historical decisions, team conventions, domain knowledge
-
π Distributes intelligently - routes content to appropriate SpecWeave folders
- Strategy docs β
.specweave/docs/internal/strategy/ - Architecture β
.specweave/docs/internal/architecture/ - Operations β
.specweave/docs/internal/operations/
- Strategy docs β
-
π― No bloat - smart organization without polluting CLAUDE.md
Retroactive Architecture Documentationβ
Create comprehensive architecture for existing systems without disrupting production:
"Analyze authentication module and create complete architecture docs"
SpecWeave generates:
High-Level Design (HLD)β
-
System architecture overview
-
Component relationships
-
Data flow diagrams
-
Integration points
Architecture Decision Records (ADRs)β
-
ADR-0001: Why we chose JWT over sessions
-
ADR-0002: OAuth 2.0 provider selection rationale
-
ADR-0003: Token refresh strategy
-
Status: Accepted (for existing patterns) or Proposed (for changes)
C4 Model Diagramsβ
-
C4-1 Context: System boundaries, external actors
-
C4-2 Container: Services, databases, APIs
-
C4-3 Component: Internal module structure
-
Sequence Diagrams: Login flow, token refresh, logout
-
ER Diagrams: User, Session, Token data models
Example:
"Create complete architecture documentation for auth system"
# Generates:
# - .specweave/docs/internal/architecture/hld-authentication.md
# - .specweave/docs/internal/architecture/adr/0001-jwt-tokens.md
# - .specweave/docs/internal/architecture/adr/0002-oauth-provider.md
# - .specweave/docs/internal/architecture/diagrams/auth-context.c4.mmd
# - .specweave/docs/internal/architecture/diagrams/auth-container.c4.mmd
# - .specweave/docs/internal/architecture/diagrams/auth-component.c4.mmd
# - .specweave/docs/internal/architecture/diagrams/login-sequence.mmd
Living Documentation That Never Gets Staleβ
The killer feature for brownfield: documentation that auto-updates as code evolves.
How it works:
-
Initial Documentation - SpecWeave creates complete specs, HLDs, ADRs, diagrams
-
Code Changes - You modify code using
/sw:do -
Auto-Update - Hooks automatically update:
- Specifications reflect new requirements
- ADRs move from Proposed β Accepted
- Architecture diagrams update with new components
- HLDs reflect current system state
- RFCs document new patterns
-
Always Current - Documentation never drifts from code
Technologies:
-
Claude Hooks - Post-task-completion hook runs after every task
-
Living Docs Sync -
/sw:sync-docs updatepropagates changes -
Version Control - All docs in Git, full history preserved
Structure Evolution and Maintenanceβ
As your brownfield project grows, SpecWeave grows the documentation structure:
Scenario: Adding new payment module
/sw:increment "payment processing module"
SpecWeave automatically:
-
Creates new strategy docs:
.specweave/docs/internal/strategy/payments/ -
Generates architecture docs with ADRs
-
Links to existing auth system (dependency tracking)
-
Updates system-level HLD to include payment module
-
Adds payment module to C4 Container diagram
-
Creates RFCs for new patterns
-
Maintains incremental history in
.specweave/increments/
Result: Your documentation structure organically evolves with your codebase.
Regression Prevention (Safety First)β
Before modifying any existing code, SpecWeave enforces safety:
-
β Analyze current implementation
- Reads existing code
- Maps dependencies
- Identifies integration points
-
β Generate retroactive specifications
- Documents current behavior (WHAT/WHY)
- Creates architecture docs (HOW)
- Maps data flows
-
β Create baseline tests
- Captures current behavior in tests
- Prevents accidental regression
- Serves as living documentation
-
β Impact analysis
- Dependency graph generation
- Affected modules identification
- Risk assessment
-
β User review and approval
- You review generated docs
- Approve changes before implementation
-
β Safe implementation
- Modify code with confidence
- Baseline tests catch regressions
- Living docs stay current
Real-World Brownfield Scenarioβ
Before SpecWeave:
Existing Project Problems:
β 50K+ lines of code, zero documentation
β Original developers left, tribal knowledge lost
β Need to add OAuth, terrified of breaking login
β Scattered docs in Confluence, wikis, old READMEs
β Architecture decisions unknown
β Every change risks production
After SpecWeave:
# Day 1: Initialize and merge
npx specweave init .
"Merge existing Confluence docs and wiki pages"
# β
All knowledge consolidated in SpecWeave structure
# Day 2: Document existing auth
"Analyze authentication module and create full documentation"
# β
HLDs, ADRs, C4 diagrams generated
# β
Current implementation fully documented
# Day 3: Create baseline tests
"Create comprehensive tests for current auth behavior"
# β
Regression prevention in place
# Day 4: Add OAuth safely
/sw:increment "Add OAuth 2.0 support"
/sw:do
# β
OAuth added with:
# - Updated specs and ADRs
# - Extended architecture diagrams
# - Baseline tests prevent regression
# - Living docs auto-updated
# Day 5 onward: Maintain forever
# β
Every change auto-updates documentation
# β
Architecture diagrams always current
# β
ADRs reflect actual decisions
# β
No documentation drift ever
Compliance and Audit Trailβ
Brownfield + SpecWeave = Compliance-Ready
Perfect for regulated industries:
-
π₯ Healthcare (HIPAA) - Complete audit trail, document all changes
-
π¦ Finance (SOC 2, PCI-DSS) - Prove compliance with specifications
-
ποΈ Government (FedRAMP) - Architecture documentation required
-
π Pharmaceutical (FDA) - Validation documentation mandatory
What you get:
-
β Complete change history (increments never deleted)
-
β Decision rationale (ADRs for all choices)
-
β Test validation (4-level testing strategy)
-
β Living documentation (always current)
-
β Traceability (specs β code β tests)
π¨ Documentation Approachesβ
Comprehensive Upfront (Enterprise)β
- 500-600+ page specifications before coding
- Full architecture and ADRs upfront
- Complete API contracts
- Best for: Enterprise, regulated industries
Incremental/Evolutionary (Startup)β
- Start with overview (10-20 pages)
- Build documentation as you go
- Adapt to changing requirements
- Best for: Startups, MVPs, prototypes
Both approaches fully supported!
βοΈ Claude Hooks (Auto-Update)β
Post-Task-Completion Hookβ
Automatically:
- Updates CLAUDE.md when structure changes
- Updates API/CLI reference
- Updates changelog
- Commits doc changes
Pre-Implementation Hookβ
Checks regression risk before modifying existing code.
Human-Input-Required Hookβ
Logs and notifies when AI needs clarification.
π¦ Slash Commandsβ
Framework-agnostic commands:
Core Commands:
/sw:increment "feature"- Plan new increment (PM-led)/sw:do- Execute tasks (smart resume)/sw:progress- Check status and completion/sw:validate 0001- Optional quality assessment/sw:done 0001- Manual close (rarely needed)
Integration Commands:
/sw:sync-github- Sync to GitHub issues/sw:sync-docs- Review specs vs implementation
All commands adapt to detected tech stack.
π― Additional Capabilitiesβ
β Already Implementedβ
-
Multi-language support: Work in 11 languages with FREE LLM-native translation (v0.6.0+)
- Supports: English, Russian, Spanish, Chinese, German, French, Japanese, Korean, Portuguese
- Auto-translates specs, plans, tasks, and living docs to English
- Zero translation costs (uses same LLM session)
-
Cost optimization: 70-98% token reduction through code-first architecture
- Skills load on-demand (not all tools upfront)
- Code execution beats MCP tool calls (Anthropic research)
- Sub-agents isolate context (no bloat accumulation)
- Typical savings: $60-120/month per developer
-
Figma integration: Design sync capabilities via sw-figma plugin
- Import Figma designs into SpecWeave specs
- Track design-to-code alignment
π Roadmapβ
- Vector search: Semantic spec search across all increments (v2.0)
- Enterprise analytics: Advanced compliance tracking and team metrics
Ready to get started?
- Quickstart Guide - Get up and running in 5 minutes
- Installation - Detailed installation instructions
Previous: What is SpecWeave? | Next: Philosophy β