Skip to main content

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:

  1. Approach - Quick build or spec-first planning
  2. Features - Multi-select checkboxes for capabilities
  3. Tech Stack - Choose your tools
  4. 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​

ProblemTraditional ApproachSpecWeave Solution
"Why did we do it this way?"Context lost, tribal knowledgeRead historical increment snapshots
"What's the current architecture?"Docs outdatedLiving docs auto-updated
"What changed in this feature?"Git commits onlyComplete increment snapshot with spec, plan, tests
"Prove compliance"Reconstruct from memoryComplete audit trail in increments
"Onboard new developer"Days of reading codeRead 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​

AgentRoleExpertise
PMProduct Manager AIRequirements, user stories, market research, roadmaps
ArchitectSystem ArchitectDesign, ADRs, component architecture, C4 diagrams
Tech LeadTechnical LeadCode review, best practices, technical guidance
QA LeadQuality AssuranceTest strategy, test cases, coverage validation
SecuritySecurity EngineerThreat modeling, security scanning, vulnerability analysis
PerformancePerformance EngineerOptimization, profiling, scalability analysis
Docs WriterTechnical WriterDocumentation creation, guides, API references
TDD OrchestratorTDD MasterRed-Green-Refactor workflow, test-first development
Test-Aware PlannerTest Planning SpecialistTest case generation, AC-ID mapping, coverage targets
TranslatorMultilingual SupportContent translation, i18n workflows
Code ReviewerCode Review SpecialistQuality 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+)​

  1. Specification Acceptance Criteria (AC-ID format: AC-US1-01)

    • Business-level acceptance criteria in spec.md
    • Technology-agnostic validation
    • Linked to user stories
  2. Embedded Test Plans (tasks)

    • BDD format (Given/When/Then) per task
    • Maps AC-IDs to test implementations
    • Coverage targets (80-90% per task)
  3. Skill Test Cases (YAML-based)

    • Minimum 3 tests per skill
    • Structured validation
  4. 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/JavaScript
  • requirements.txt / pyproject.toml β†’ Python
  • go.mod β†’ Go
  • Cargo.toml β†’ Rust
  • pom.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​

ProblemWithout SpecWeaveWith SpecWeave
Team uses JIRAAbandon JIRA or maintain two systemsSpecs push to JIRA, status reads back
GitHub Issues workflowManual updates, driftAuto-sync progress to issues
Azure DevOps enterpriseComplex migrationNative integration, no disruption
Multiple toolsConstant context switchingSpecWeave 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​

  1. Keep Your Workflow - Teams continue using familiar tools
  2. Single Source of Truth - Specs drive everything, tools reflect state
  3. Auto-Sync Progress - Complete a task β†’ issue updates automatically
  4. Gradual Adoption - Start with one project, expand when ready
  5. 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/
  • 🎯 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:

  1. Initial Documentation - SpecWeave creates complete specs, HLDs, ADRs, diagrams

  2. Code Changes - You modify code using /sw:do

  3. 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
  4. Always Current - Documentation never drifts from code

Technologies:

  • Claude Hooks - Post-task-completion hook runs after every task

  • Living Docs Sync - /sw:sync-docs update propagates 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:

  1. Creates new strategy docs: .specweave/docs/internal/strategy/payments/

  2. Generates architecture docs with ADRs

  3. Links to existing auth system (dependency tracking)

  4. Updates system-level HLD to include payment module

  5. Adds payment module to C4 Container diagram

  6. Creates RFCs for new patterns

  7. 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:

  1. βœ… Analyze current implementation

    • Reads existing code
    • Maps dependencies
    • Identifies integration points
  2. βœ… Generate retroactive specifications

    • Documents current behavior (WHAT/WHY)
    • Creates architecture docs (HOW)
    • Maps data flows
  3. βœ… Create baseline tests

    • Captures current behavior in tests
    • Prevents accidental regression
    • Serves as living documentation
  4. βœ… Impact analysis

    • Dependency graph generation
    • Affected modules identification
    • Risk assessment
  5. βœ… User review and approval

    • You review generated docs
    • Approve changes before implementation
  6. βœ… 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?

Previous: What is SpecWeave? | Next: Philosophy β†’