Glossary Linking Opportunities Report
Generated: /Users/antonabyzov/Projects/github/specweave/.specweave/docs/public Total Files Scanned: 55
Summary
- Total Linking Opportunities: 1779
- Files with Opportunities: 53
- Already Linked Terms: 227
By File
learn/foundations/software-engineering-roles.md (166 opportunities)
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 68:
- **Output**:tasks.mdwith BDD test plans, AC-ID traceability... - Line 307:
- Ensures AC-ID traceability (spec.md AC → tasks.md tests)... - Line 68:
- **Output**:tasks.mdwith BDD test plans, AC-ID traceability... - Line 157:
PM Agent auto-generates this structure from high-level descriptions, with AC-IDs for test traceabili... - Line 307:
- Ensures AC-ID traceability (spec.md AC → tasks.md tests)... - ...and 3 more occurrences
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 13:
Building modern software requires diverse expertise: product strategy, system architecture, implemen... - Line 19:
- Real-world examples of agents in action... - Line 32:
- **Activates**: When planning features, creating specs, defining acceptance criteria... - Line 32:
- **Activates**: When planning features, creating specs, defining acceptance criteria... - Line 34:
- **Output**:spec.mdwith user stories and acceptance criteria... - ...and 64 more occurrences
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 38:
- **Expertise**: System design, ADRs, technology stack selection, scalability... - Line 40:
- **Output**:plan.md, Architecture Decision Records (ADRs), diagrams... - Line 165:
- Create Architecture Decision Records (ADRs)... - Line 193:
**Example Output** (ADR):... - Line 224:
Architect Agent stores ADRs permanently in living docs, updated via/specweave:sync-docs.... - ...and 12 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 86:
- **Expertise**: Documentation creation, API docs, user guides... - Line 88:
- **Output**: Updated README.md, API documentation, user guides... - Line 466:
- Create API documentation... - Line 632:
2. Generates API docs (Socket.io events)...
BDD (Behavior-Driven Development) (→ /docs/glossary/terms/bdd)
- Line 66:
- **Expertise**: Creating tasks with embedded test plans (BDD format)... - Line 68:
- **Output**:tasks.mdwith BDD test plans, AC-ID traceability... - Line 310:
- Embeds test plans in tasks.md (BDD format: Given/When/Then)... - Line 566:
2. Embeds test plans in tasks.md (BDD format):... - Line 66:
- **Expertise**: Creating tasks with embedded test plans (BDD format)... - ...and 3 more occurrences
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 304:
- Defines test strategy (unit/integration/E2E targets)... - Line 555:
- T-005: E2E tests... - Line 617:
- ✅ E2E tests passing...
Increments (→ /docs/glossary/terms/increments)
- Line 527:
**Output**:.specweave/increments/0009-realtime-chat/spec.md... - Line 558:
**Output**:.specweave/increments/0009-realtime-chat/tasks.md... - Line 527:
**Output**:.specweave/increments/0009-realtime-chat/spec.md... - Line 558:
**Output**:.specweave/increments/0009-realtime-chat/tasks.md...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 87:
- **Activates**: When generating documentation, updating living docs... - Line 224:
Architect Agent stores ADRs permanently in living docs, updated via/specweave:sync-docs.... - Line 634:
4. Syncs living docs...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 32:
- **Activates**: When planning features, creating specs, defining acceptance criteria... - Line 95:
- **Activates**: When translating specs/docs to English (multilingual workflow)... - Line 32:
- **Activates**: When planning features, creating specs, defining acceptance criteria... - Line 95:
- **Activates**: When translating specs/docs to English (multilingual workflow)...
TDD (Test-Driven Development) (→ /docs/glossary/terms/tdd)
- Line 57:
**5. TDD Orchestrator Agent** (tdd-orchestrator)... - Line 57:
**5. TDD Orchestrator Agent** (tdd-orchestrator)... - Line 58:
- **Role**: TDD (Test-Driven Development) Workflow Leader... - Line 60:
- **Activates**: When using TDD workflow... - Line 61:
- **Commands**:/specweave:tdd-cycle,/specweave:tdd-red,/specweave:tdd-green,/specweave:td...` - ...and 25 more occurrences
Test Coverage (→ /docs/glossary/terms/test-coverage)
- Line 53:
- **Activates**: When planning test coverage, validating quality... - Line 67:
- **Activates**: When generatingtasks.mdwith test coverage... - Line 294:
- Ensure test coverage meets requirements... - Line 305:
- Validates test coverage via/specweave:check-tests... - Line 53:
- **Activates**: When planning test coverage, validating quality... - ...and 3 more occurrences
User Stories (→ /docs/glossary/terms/user-stories)
- Line 31:
- **Expertise**: Product strategy, requirements gathering, user stories, feature prioritization... - Line 34:
- **Output**:spec.mdwith user stories and acceptance criteria... - Line 114:
- Write user stories with acceptance criteria... - Line 519:
1. Creates spec.md with user stories:... - Line 31:
- **Expertise**: Product strategy, requirements gathering, user stories, feature prioritization... - ...and 3 more occurrences
learn/foundations/enterprise-app-development.md (135 opportunities)
Already linked: api, database, docker, iac, kubernetes, microservices
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 357:
- AC-ID traceability (spec → task → test)... - Line 276:
- PM agent generates user stories with AC-IDs... - Line 357:
- AC-ID traceability (spec → task → test)...
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 17:
- Handle millions of transactions daily... - Line 23:
- Process financial transactions with strict accuracy... - Line 23:
- Process financial transactions with strict accuracy... - Line 23:
- Process financial transactions with strict accuracy... - Line 31:
- Integrate with insurance, labs, pharmacies... - ...and 63 more occurrences
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 62:
| **Documentation** | README, inline comments | Comprehensive docs, architecture diagrams, ADRs |... - Line 84:
- Architecture decisions documented (ADRs)... - Line 287:
- Architecture Decision Records (ADRs): Document WHY we chose X over Y... - Line 293:
- **ADRs**: Decision rationale (e.g., "Why PostgreSQL over MongoDB")... - Line 295:
**Example ADR**... - ...and 10 more occurrences
Angular (→ /docs/glossary/terms/angular)
- Line 503:
| **Frontend Developer** | Build user interfaces, client-side logic | React, Angular, Vue, TypeScrip... - Line 503:
| **Frontend Developer** | Build user interfaces, client-side logic | React, Angular, Vue, TypeScrip...
BDD (Behavior-Driven Development) (→ /docs/glossary/terms/bdd)
- Line 356:
- Embedded test plans (BDD format)... - Line 406:
- BDD format: Given/When/Then... - Line 356:
- Embedded test plans (BDD format)... - Line 406:
- BDD format: Given/When/Then...
CI/CD (→ /docs/glossary/terms/ci-cd)
- Line 61:
| **Deployment** | Manual deploy, single server | CI/CD pipelines, multiple environments (dev/stagin... - Line 414:
**Modern CI/CD Pipeline**... - Line 504:
| **DevOps Engineer** | CI/CD pipelines, infrastructure, deployment automation | Docker, Kubernetes,...
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 393:
**End-to-End (E2E) Tests**...
FDA (Food and Drug Administration) - Medical Device Software Regulations (→ /docs/glossary/terms/fda)
- Line 708:
- FDA (medical devices): Traceability from requirements to code... - Line 708:
- FDA (medical devices): Traceability from requirements to code...
Git (→ /docs/glossary/terms/git)
- Line 454:
- GitHub Actions integration... - Line 1661:
**Feedback**: [Open an issue](https://github.com/anton-abyzov/specweave/issues) or [join discussions...
GitHub Actions (→ /docs/glossary/terms/github-actions)
- Line 454:
- GitHub Actions integration... - Line 454:
- GitHub Actions integration...
HIPAA (Health Insurance Portability and Accountability Act) (→ /docs/glossary/terms/hipaa)
- Line 30:
- Comply with HIPAA regulations... - Line 56:
| **Security** | Basic authentication | Multi-layer security, compliance (HIPAA, SOC 2) |... - Line 710:
- HIPAA (healthcare): Audit trails for data access... - Line 30:
- Comply with HIPAA regulations... - Line 56:
| **Security** | Basic authentication | Multi-layer security, compliance (HIPAA, SOC 2) |... - ...and 1 more occurrences
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 455:
- Automated living docs sync post-deployment... - Line 490:
- Living docs stay current (post-task completion hook)... - Line 750:
**SpecWeave's Living Documentation**...
Monolith (→ /docs/glossary/terms/monolith)
- Line 156:
As applications grow, the monolithic business logic layer often splits into **microservices**—small,...
Node.js (→ /docs/glossary/terms/nodejs)
- Line 216:
- User service in Node.js, payment service in Java... - Line 502:
| **Backend Developer** | Implement APIs, business logic, database design | Java, Python, Node.js, S...
Playwright (→ /docs/glossary/terms/playwright)
- Line 395:
- Browser automation (Playwright, Cypress)... - Line 505:
| **QA Engineer** | Test planning, automation, quality assurance | Selenium, Playwright, test framew... - Line 395:
- Browser automation (Playwright, Cypress)... - Line 505:
| **QA Engineer** | Test planning, automation, quality assurance | Selenium, Playwright, test framew...
React (→ /docs/glossary/terms/react)
- Line 503:
| **Frontend Developer** | Build user interfaces, client-side logic | React, Angular, Vue, TypeScrip... - Line 503:
| **Frontend Developer** | Build user interfaces, client-side logic | React, Angular, Vue, TypeScrip...
SOC 2 (Service Organization Control 2) (→ /docs/glossary/terms/soc2)
- Line 56:
| **Security** | Basic authentication | Multi-layer security, compliance (HIPAA, SOC 2) |... - Line 709:
- SOC 2 (security): Document access controls, incident response...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 291:
- **API Specifications**: OpenAPI/Swagger docs...
TDD (Test-Driven Development) (→ /docs/glossary/terms/tdd)
- Line 328:
- Writing unit tests (TDD: test-first approach)... - Line 328:
- Writing unit tests (TDD: test-first approach)...
Terraform (→ /docs/glossary/terms/terraform)
- Line 449:
- Define infrastructure in code (Terraform, CloudFormation)... - Line 504:
| **DevOps Engineer** | CI/CD pipelines, infrastructure, deployment automation | Docker, Kubernetes,... - Line 449:
- Define infrastructure in code (Terraform, CloudFormation)... - Line 504:
| **DevOps Engineer** | CI/CD pipelines, infrastructure, deployment automation | Docker, Kubernetes,...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 503:
| **Frontend Developer** | Build user interfaces, client-side logic | React, Angular, Vue, TypeScrip... - Line 503:
| **Frontend Developer** | Build user interfaces, client-side logic | React, Angular, Vue, TypeScrip...
User Stories (→ /docs/glossary/terms/user-stories)
- Line 258:
- **User Stories**: "As a [user], I want [feature] so that [benefit]"... - Line 276:
- PM agent generates user stories with AC-IDs... - Line 258:
- **User Stories**: "As a [user], I want [feature] so that [benefit]"... - Line 276:
- PM agent generates user stories with AC-IDs...
learn/infrastructure/iac-fundamentals.md (112 opportunities)
Already linked: ci-cd, docker, github-actions, kubernetes, microservices, terraform
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 2:
id: iac-fundamentals... - Line 4:
sidebar_label: IaC Fundamentals... - Line 15:
Before diving into Infrastructure as Code (IaC), let's understand what infrastructure means in moder... - Line 46:
- **No version control**: Changes aren't tracked in Git... - Line 48:
- **Snowflake servers**: Each environment is slightly different... - ...and 42 more occurrences
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 2531:
**Example ADR**:... - Line 2711:
- Document infrastructure decisions in ADRs... - Line 2531:
**Example ADR**:...
Git (→ /docs/glossary/terms/git)
- Line 46:
- **No version control**: Changes aren't tracked in Git... - Line 197:
**With IaC**: Infrastructure knowledge is in Git, not people's heads... - Line 213:
### 1. Version Control - Infrastructure in Git... - Line 328:
- Optimize costs over time (Git history shows trends)... - Line 347:
- Automatic backup (Git is the backup)... - ...and 6 more occurrences
IaC (Infrastructure as Code) (→ /docs/glossary/terms/iac)
- Line 3:
title: Infrastructure as Code Fundamentals... - Line 7:
# Infrastructure as Code Fundamentals... - Line 15:
Before diving into Infrastructure as Code (IaC), let's understand what infrastructure means in moder... - Line 54:
### The Modern Way: Infrastructure as Code... - Line 77:
## What is Infrastructure as Code (IaC)?... - ...and 30 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 2469:
### Infrastructure Changes in Increments... - Line 2710:
- Use SpecWeave to track IaC increments... - Line 2469:
### Infrastructure Changes in Increments... - Line 2710:
- Use SpecWeave to track IaC increments...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 2713:
- Maintain living docs for runbooks... - Line 2516:
### Living Documentation...
Monolith (→ /docs/glossary/terms/monolith)
- Line 2409:
### 3. Large Monolithic Files...
Node.js (→ /docs/glossary/terms/nodejs)
- Line 1736:
- Final image: 150 MB (only Node.js runtime + compiled code)...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 380:
| **Language** | HCL (declarative) | JSON/YAML (declarative) | TypeScript/Python/Go | YAML (imperati... - Line 386:
| **Type Safety** | Limited | None | Full (TypeScript, Go) | None |... - Line 404:
- ✅ Team prefers TypeScript/Python/Go over HCL... - Line 1735:
- Builder stage: 800 MB (includes npm, TypeScript, build tools)... - Line 380:
| **Language** | HCL (declarative) | JSON/YAML (declarative) | TypeScript/Python/Go | YAML (imperati... - ...and 3 more occurrences
glossary/categories/CATEGORY-PAGES-COMPLETE.md (97 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 10:
Successfully created **9 comprehensive category landing pages** for the SpecWeave glossary, followin... - Line 19:
| 2 | Backend Development |backend.md| ✅ Complete | ~1,100 words |... - Line 19:
| 2 | Backend Development |backend.md| ✅ Complete | ~1,100 words |... - Line 26:
| 9 | ML/AI & Machine Learning |ml-ai.md| ✅ Complete | ~1,050 words |... - Line 28:
**Total**: ~9,150 words across 9 category pages... - ...and 27 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 126:
- REST API, GraphQL, Node.js, databases... - Line 128:
- API design patterns...
BDD (Behavior-Driven Development) (→ /docs/glossary/terms/bdd)
- Line 138:
- TDD, BDD, unit/integration/E2E testing... - Line 138:
- TDD, BDD, unit/integration/E2E testing...
CI/CD (→ /docs/glossary/terms/ci-cd)
- Line 120:
- Kubernetes, Terraform, Docker, CI/CD... - Line 144:
- Git, GitHub, CI/CD, Docker...
Docker (→ /docs/glossary/terms/docker)
- Line 120:
- Kubernetes, Terraform, Docker, CI/CD... - Line 144:
- Git, GitHub, CI/CD, Docker... - Line 120:
- Kubernetes, Terraform, Docker, CI/CD... - Line 144:
- Git, GitHub, CI/CD, Docker...
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 135:
- E2E testing with Playwright... - Line 138:
- TDD, BDD, unit/integration/E2E testing...
Git (→ /docs/glossary/terms/git)
- Line 144:
- Git, GitHub, CI/CD, Docker... - Line 94:
- Plugin references (specweave-github, specweave-kubernetes, etc.)... - Line 144:
- Git, GitHub, CI/CD, Docker... - Line 144:
- Git, GitHub, CI/CD, Docker... - Line 146:
- GitHub Actions examples... - ...and 1 more occurrences
GitHub Actions (→ /docs/glossary/terms/github-actions)
- Line 146:
- GitHub Actions examples... - Line 146:
- GitHub Actions examples...
GraphQL (→ /docs/glossary/terms/graphql)
- Line 126:
- REST API, GraphQL, Node.js, databases... - Line 126:
- REST API, GraphQL, Node.js, databases...
HIPAA (Health Insurance Portability and Accountability Act) (→ /docs/glossary/terms/hipaa)
- Line 156:
- OWASP, HIPAA, SOC 2, GDPR... - Line 156:
- OWASP, HIPAA, SOC 2, GDPR...
IaC (Infrastructure as Code) (→ /docs/glossary/terms/iac)
- Line 123:
- IaC code snippets (HCL, YAML)... - Line 123:
- IaC code snippets (HCL, YAML)...
Kubernetes (K8s) (→ /docs/glossary/terms/kubernetes)
- Line 94:
- Plugin references (specweave-github, specweave-kubernetes, etc.)... - Line 120:
- Kubernetes, Terraform, Docker, CI/CD... - Line 94:
- Plugin references (specweave-github, specweave-kubernetes, etc.)... - Line 120:
- Kubernetes, Terraform, Docker, CI/CD...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 66:
- Living documentation... - Line 96:
- Living documentation structure...
Microservices (→ /docs/glossary/terms/microservices)
- Line 129:
- Microservices vs Monolith comparison... - Line 129:
- Microservices vs Monolith comparison...
Monolith (→ /docs/glossary/terms/monolith)
- Line 129:
- Microservices vs Monolith comparison... - Line 129:
- Microservices vs Monolith comparison...
Next.js (→ /docs/glossary/terms/nextjs)
- Line 132:
- React, Next.js, SPA/SSR/SSG...
Node.js (→ /docs/glossary/terms/nodejs)
- Line 126:
- REST API, GraphQL, Node.js, databases...
Playwright (→ /docs/glossary/terms/playwright)
- Line 135:
- E2E testing with Playwright... - Line 135:
- E2E testing with Playwright...
React (→ /docs/glossary/terms/react)
- Line 132:
- React, Next.js, SPA/SSR/SSG... - Line 134:
- State management (Context → Zustand → React Query)... - Line 132:
- React, Next.js, SPA/SSR/SSG... - Line 134:
- State management (Context → Zustand → React Query)...
REST (REpresentational State Transfer) (→ /docs/glossary/terms/rest)
- Line 126:
- REST API, GraphQL, Node.js, databases... - Line 126:
- REST API, GraphQL, Node.js, databases...
SOC 2 (Service Organization Control 2) (→ /docs/glossary/terms/soc2)
- Line 156:
- OWASP, HIPAA, SOC 2, GDPR...
SPA (Single Page Application) (→ /docs/glossary/terms/spa)
- Line 132:
- React, Next.js, SPA/SSR/SSG... - Line 132:
- React, Next.js, SPA/SSR/SSG...
SSG (Static Site Generation) (→ /docs/glossary/terms/ssg)
- Line 132:
- React, Next.js, SPA/SSR/SSG... - Line 132:
- React, Next.js, SPA/SSR/SSG...
SSR (Server-Side Rendering) (→ /docs/glossary/terms/ssr)
- Line 132:
- React, Next.js, SPA/SSR/SSG... - Line 132:
- React, Next.js, SPA/SSR/SSG...
TDD (Test-Driven Development) (→ /docs/glossary/terms/tdd)
- Line 138:
- TDD, BDD, unit/integration/E2E testing... - Line 141:
- Real TDD workflow (Red → Green → Refactor)... - Line 138:
- TDD, BDD, unit/integration/E2E testing... - Line 141:
- Real TDD workflow (Red → Green → Refactor)...
Terraform (→ /docs/glossary/terms/terraform)
- Line 120:
- Kubernetes, Terraform, Docker, CI/CD... - Line 120:
- Kubernetes, Terraform, Docker, CI/CD...
Test Pyramid (→ /docs/glossary/terms/test-pyramid)
- Line 139:
- Test pyramid in practice... - Line 139:
- Test pyramid in practice...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 100:
- Code snippets (TypeScript, YAML, SQL, etc.)... - Line 100:
- Code snippets (TypeScript, YAML, SQL, etc.)...
User Stories (→ /docs/glossary/terms/user-stories)
- Line 150:
- Agile, Scrum, Kanban, user stories... - Line 150:
- Agile, Scrum, Kanban, user stories...
learn/backend/backend-fundamentals.md (81 opportunities)
Already linked: api, graphql, microservices, nextjs, nodejs, rest, ssr
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 1262:
- **ACID Transactions**: Guaranteed consistency... - Line 1277:
| **Transactions** | ACID (strong consistency) | Eventual consistency |...
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 2:
id: backend-fundamentals... - Line 3:
title: Backend Development Fundamentals... - Line 4:
sidebar_label: Backend Fundamentals... - Line 5:
description: Complete guide to backend/server-side development - [API](/docs/glossary/terms/api) des... - Line 17:
- **Enforce business logic** - Apply rules (e.g., "users can't overdraw accounts")... - ...and 53 more occurrences
Angular (→ /docs/glossary/terms/angular)
- Line 581:
**Philosophy**: Opinionated, TypeScript-first, inspired by Angular... - Line 581:
**Philosophy**: Opinionated, TypeScript-first, inspired by Angular...
Docker (→ /docs/glossary/terms/docker)
- Line 2368:
**Test Containers** (use Docker for integration tests):... - Line 2368:
**Test Containers** (use Docker for integration tests):...
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 2398:
### E2E Tests...
Git (→ /docs/glossary/terms/git)
- Line 145:
- OAuth (Google, GitHub, etc.)... - Line 3306:
**Questions or feedback?** [Open an issue](https://github.com/anton-abyzov/specweave/issues) or [joi...
Monolith (→ /docs/glossary/terms/monolith)
- Line 1898:
**Monolith vs Microservices:**... - Line 1922:
| Aspect | Monolith | Microservices |... - Line 1898:
**Monolith vs Microservices:**... - Line 1922:
| Aspect | Monolith | Microservices |...
Playwright (→ /docs/glossary/terms/playwright)
- Line 2402:
**Example** (Playwright):... - Line 2402:
**Example** (Playwright):...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 581:
**Philosophy**: Opinionated, TypeScript-first, inspired by Angular... - Line 787:
- ✅ TypeScript-first (type safety)... - Line 1409:
- ✅ Write database queries in your programming language (TypeScript/JavaScript)... - Line 1410:
- ✅ Type safety (TypeScript interfaces match database schema)... - Line 581:
**Philosophy**: Opinionated, TypeScript-first, inspired by Angular... - ...and 3 more occurrences
learn/testing/testing-fundamentals.md (81 opportunities)
Already linked: bdd, e2e, integration-testing, tdd, test-coverage, test-pyramid, unit-testing
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 2437:
- **AC-ID Traceability**: spec.md → tasks.md → tests... - Line 2071:
- ✅ All AC-IDs from spec.md covered in tasks.md... - Line 2078:
- ✅ Tests reference AC-IDs... - Line 2437:
- **AC-ID Traceability**: spec.md → tasks.md → tests...
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 5:
description: Comprehensive guide to software testing covering the testing pyramid, TDD, BDD, test le... - Line 11:
Testing is not just about catching bugs—it's about building confidence in your software, documenting... - Line 59:
**4. Enable Confident Refactoring**... - Line 73:
The testing pyramid is a visual metaphor for **how to distribute your testing effort** across differ... - Line 95:
**Characteristics**:... - ...and 42 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 98:
- **Isolated**: No external dependencies (DB, API, file system)... - Line 135:
**Example**: Testing API endpoint with database... - Line 364:
#### API + Database Integration... - Line 796:
**1. Better Design**: Tests force you to think about API before implementation... - Line 1150:
### API Testing... - ...and 3 more occurrences
CI/CD (→ /docs/glossary/terms/ci-cd)
- Line 5:
description: Comprehensive guide to software testing covering the testing pyramid, TDD, BDD, test le... - Line 1621:
## CI/CD Integration... - Line 2478:
8. **Run Tests in CI/CD**: Automate, every commit...
Docker (→ /docs/glossary/terms/docker)
- Line 487:
- Use Docker containers for dependencies (Testcontainers)... - Line 487:
- Use Docker containers for dependencies (Testcontainers)...
Git (→ /docs/glossary/terms/git)
- Line 1649:
### GitHub Actions Example...
GitHub Actions (→ /docs/glossary/terms/github-actions)
- Line 1649:
### GitHub Actions Example... - Line 1649:
### GitHub Actions Example...
GraphQL (→ /docs/glossary/terms/graphql)
- Line 1152:
**Goal**: Test REST/GraphQL endpoints with request/response validation... - Line 1152:
**Goal**: Test REST/GraphQL endpoints with request/response validation...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 55:
- Tests serve as living documentation... - Line 798:
**3. Living Documentation**: Tests show how to use the code...
Playwright (→ /docs/glossary/terms/playwright)
- Line 1985:
### Playwright Visual Testing... - Line 2449:
- **Playwright**: Modern E2E framework (SpecWeave recommended)... - Line 1985:
### Playwright Visual Testing... - Line 2449:
- **Playwright**: Modern E2E framework (SpecWeave recommended)...
React (→ /docs/glossary/terms/react)
- Line 1246:
### React Component Testing... - Line 1246:
### React Component Testing...
REST (REpresentational State Transfer) (→ /docs/glossary/terms/rest)
- Line 1152:
**Goal**: Test REST/GraphQL endpoints with request/response validation... - Line 1152:
**Goal**: Test REST/GraphQL endpoints with request/response validation...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 2444:
- **Jest**: JavaScript/TypeScript testing framework... - Line 2444:
- **Jest**: JavaScript/TypeScript testing framework...
guides/spec-bidirectional-sync.md (75 opportunities)
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 216:
**Links user stories to commits** (via AC-IDs):... - Line 396:
4. **Use AC-IDs for traceability**: Link tasks to user stories via AC-US\{story\}-\{number\}...
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 11:
| **CONTENT** | SpecWeave → External Tool |.specweave/docs/internal/specs/| Title, Description, ... - Line 15:
**Key Principle**: Specs are the **permanent source of truth** for WHAT we're building. External too... - Line 23:
Traditional approaches force you to choose:... - Line 27:
**Both approaches fail!** One system becomes stale.... - Line 74:
- ✅ PMs/stakeholders track progress in their preferred tool (GitHub/JIRA/ADO manages status)... - ...and 10 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 415:
4. Provider credentials valid (GitHub token, JIRA API token, ADO PAT)...
Bidirectional Sync (→ /docs/glossary/terms/bidirectional-sync)
- Line 7:
SpecWeave implements **bidirectional sync** with different sync directions for different types of da... - Line 29:
### The Solution: Bidirectional Sync... - Line 7:
SpecWeave implements **bidirectional sync** with different sync directions for different types of da... - Line 29:
### The Solution: Bidirectional Sync...
Git (→ /docs/glossary/terms/git)
- Line 13:
| **COMMITS** | SpecWeave → External Tool | Git history | Commit links, PR links, implementation upd... - Line 3:
**Automatic synchronization between SpecWeave specs and external tools (GitHub, JIRA, Azure DevOps).... - Line 12:
| **STATUS** | External Tool → SpecWeave | GitHub/JIRA/ADO | State (Open/Closed), Progress, Assignee... - Line 13:
| **COMMITS** | SpecWeave → External Tool | Git history | Commit links, PR links, implementation upd... - Line 74:
- ✅ PMs/stakeholders track progress in their preferred tool (GitHub/JIRA/ADO manages status)... - ...and 6 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 403:
4. **Don't duplicate specs**: One spec in.specweave/docs/internal/specs/, referenced by increment... - Line 403:
4. **Don't duplicate specs**: One spec in.specweave/docs/internal/specs/, referenced by increment...
Source of Truth (→ /docs/glossary/terms/source-of-truth)
- Line 9:
| Data Type | Sync Direction | Source of Truth | What Syncs |... - Line 15:
**Key Principle**: Specs are the **permanent source of truth** for WHAT we're building. External too... - Line 24:
- **Option A**: External tool (JIRA) is source of truth → Developers must copy changes to docs manua... - Line 25:
- **Option B**: Docs (SpecWeave) is source of truth → PMs must copy changes to JIRA manually... - Line 393:
1. **Keep specs up-to-date**: Treat.specweave/docs/internal/specs/as source of truth for require... - ...and 5 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 3:
**Automatic synchronization between SpecWeave specs and external tools (GitHub, JIRA, Azure DevOps).... - Line 11:
| **CONTENT** | SpecWeave → External Tool |.specweave/docs/internal/specs/| Title, Description, ... - Line 15:
**Key Principle**: Specs are the **permanent source of truth** for WHAT we're building. External too... - Line 73:
- ✅ Specs stay complete and up-to-date (SpecWeave manages content)... - Line 85:
- When spec.md is created in.specweave/docs/internal/specs/... - ...and 17 more occurrences
User Stories (→ /docs/glossary/terms/user-stories)
- Line 11:
| **CONTENT** | SpecWeave → External Tool |.specweave/docs/internal/specs/| Title, Description, ... - Line 128:
**User Stories**:... - Line 216:
**Links user stories to commits** (via AC-IDs):... - Line 396:
4. **Use AC-IDs for traceability**: Link tasks to user stories via AC-US\{story\}-\{number\}... - Line 11:
| **CONTENT** | SpecWeave → External Tool |.specweave/docs/internal/specs/| Title, Description, ... - ...and 3 more occurrences
faq.md (74 opportunities)
Already linked: [microservices](/docs/glossary/terms/microservices, adr, api, brownfield, git
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 9:
### Why do I have specs in two places?... - Line 18:
- **Complete** - Contains ALL user stories, requirements, acceptance criteria... - Line 240:
- ✅ Existing docs remain authoritative for legacy code... - Line 461:
- [ ] Feature is small/focused (add button, fix bug, refactor file)... - Line 462:
- [ ] No PM tool needed (local tracking only)... - ...and 2 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 11:
**Short Answer**: You might not! Most features only need increment specs. Living docs specs are OPTI... - Line 16:
- **Optional** - Only for major features (3+ increments)... - Line 21:
2. **Increment Spec** (.specweave/increments/####-name/spec.md)... - Line 58:
After all 3 increments complete:... - Line 91:
- **Source of Truth**:.specweave/increments/0009-add-dark-mode/spec.md... - ...and 15 more occurrences
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 11:
**Short Answer**: You might not! Most features only need increment specs. Living docs specs are OPTI... - Line 15:
1. **Living Docs Spec** (.specweave/docs/internal/specs/spec-####-name/spec.md)... - Line 25:
- **References** - May reference living docs spec: "See SPEC-0005 for complete requirements"... - Line 59:
- ✅ Living docs spec REMAINS (permanent knowledge base)... - Line 66:
**Living Docs Spec** = Source of truth (if it exists)... - ...and 12 more occurrences
Microservices (→ /docs/glossary/terms/microservices)
- Line 373:
**2. [Microservices](/docs/glossary/terms/[microservices](/docs/glossary/terms/microservices)) (Mult... - Line 373:
**2. [Microservices](/docs/glossary/terms/[microservices](/docs/glossary/terms/microservices)) (Mult...
Source of Truth (→ /docs/glossary/terms/source-of-truth)
- Line 64:
### Which one is the source of truth?... - Line 66:
**Living Docs Spec** = Source of truth (if it exists)... - Line 86:
- **Source of Truth**:.specweave/docs/internal/specs/spec-0005-authentication/spec.md... - Line 91:
- **Source of Truth**:.specweave/increments/0009-add-dark-mode/spec.md... - Line 64:
### Which one is the source of truth?... - ...and 3 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 9:
### Why do I have specs in two places?... - Line 11:
**Short Answer**: You might not! Most features only need increment specs. Living docs specs are OPTI... - Line 11:
**Short Answer**: You might not! Most features only need increment specs. Living docs specs are OPTI... - Line 15:
1. **Living Docs Spec** (.specweave/docs/internal/specs/spec-####-name/spec.md)... - Line 60:
- ⏳ Increment specs can be deleted (optional)... - ...and 13 more occurrences
User Stories (→ /docs/glossary/terms/user-stories)
- Line 18:
- **Complete** - Contains ALL user stories, requirements, acceptance criteria... - Line 18:
- **Complete** - Contains ALL user stories, requirements, acceptance criteria...
guides/intelligent-living-docs-sync.md (64 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 30:
4. Cross-linked for traceability... - Line 35:
**Problem**: Traditional approach copies entirespec.mdto living docs as a single file:... - Line 66:
- ✅ **Multi-project support**: Separate docs for backend/frontend/mobile... - Line 117:
| **User Story** | US-XXX pattern, "As a" format, Acceptance Criteria | US-001, US-002 | specs/\{pro... - Line 129:
Intelligent sync detects which project (backend/frontend/mobile) an increment belongs to:... - ...and 11 more occurrences
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 120:
| **ADR** | ADR-XXX pattern, decision structure | ADR-001, "Context/Decision/Consequences" |archit...` - Line 120:
| **ADR** | ADR-XXX pattern, decision structure | ADR-001, "Context/Decision/Consequences" |archit...` - Line 120:
| **ADR** | ADR-XXX pattern, decision structure | ADR-001, "Context/Decision/Consequences" |archit...` - Line 120:
| **ADR** | ADR-XXX pattern, decision structure | ADR-001, "Context/Decision/Consequences" |archit...` - Line 610:
**ADRs**:... - ...and 4 more occurrences
CI/CD (→ /docs/glossary/terms/ci-cd)
- Line 122:
| **Delivery** | Test strategy, release plans, CI/CD | "Test Strategy", "Release Plan" |delivery/...
Docusaurus Frontmatter (→ /docs/glossary/terms/docusaurus-frontmatter)
- Line 31:
5. Enriched with Docusaurus frontmatter... - Line 268:
### 1. Docusaurus Frontmatter... - Line 31:
5. Enriched with Docusaurus frontmatter... - Line 268:
### 1. Docusaurus Frontmatter...
Git (→ /docs/glossary/terms/git)
- Line 726:
**Issues**: https://github.com/anton-abyzov/specweave/issues... - Line 727:
**Discussions**: https://github.com/anton-abyzov/specweave/discussions...
Increments (→ /docs/glossary/terms/increments)
- Line 705:
**Q: Does this work with existing increments?**... - Line 708:
**Q: Can I disable for specific increments?**... - Line 705:
**Q: Does this work with existing increments?**... - Line 708:
**Q: Can I disable for specific increments?**...
Intelligent Living Docs Sync (→ /docs/glossary/terms/intelligent-living-docs-sync)
- Line 1:
# Intelligent Living Docs Sync - User Guide... - Line 33:
## What Is Intelligent Living Docs Sync?... - Line 725:
**Documentation**: https://spec-weave.com/docs/intelligent-living-docs-sync... - Line 1:
# Intelligent Living Docs Sync - User Guide... - Line 33:
## What Is Intelligent Living Docs Sync?...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 1:
# Intelligent Living Docs Sync - User Guide... - Line 33:
## What Is Intelligent Living Docs Sync?... - Line 35:
**Problem**: Traditional approach copies entirespec.mdto living docs as a single file:... - Line 405:
**Result**: Living docs sync automatically after task completion!... - Line 495:
### Issue: Living docs not syncing... - ...and 1 more occurrences
Project Detection (→ /docs/glossary/terms/project-detection)
- Line 127:
### Project Detection... - Line 127:
### Project Detection...
SOC 2 (Service Organization Control 2) (→ /docs/glossary/terms/soc2)
- Line 124:
| **Governance** | Security policies, compliance | "Security Policy", GDPR, SOC 2 |governance/|...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 117:
| **User Story** | US-XXX pattern, "As a" format, Acceptance Criteria | US-001, US-002 | specs/\{pro... - Line 118:
| **NFR** | NFR-XXX pattern, performance metrics, SLAs | NFR-001, "99.9% uptime" | specs/\{project\}/... - Line 125:
| **Overview** | Introduction, summary sections | "Quick Overview", "Executive Summary" | specs/\{pr... - Line 432:
**Result**: Simple copy of spec.md to docs/internal/specs/spec-\{id\}.md (legacy behavior)... - Line 694:
**Step 4 - Keep legacy specs** (optional):... - ...and 5 more occurrences
User Stories (→ /docs/glossary/terms/user-stories)
- Line 28:
2. Classified by content type (user stories, architecture, operations, etc.)... - Line 604:
**User Stories**:... - Line 28:
2. Classified by content type (user stories, architecture, operations, etc.)... - Line 604:
**User Stories**:...
learn/frontend/frontend-fundamentals.md (52 opportunities)
Already linked: api, backend-fundamentals, nextjs, react, ssr, typescript
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 6:
keywords: [frontend, react, nextjs, javascript, typescript, components, state management, css, respo... - Line 6:
keywords: [frontend, react, nextjs, javascript, typescript, components, state management, css, respo... - Line 18:
- **[API](/docs/glossary/terms/api) Communication**: Fetching and sending data to backend services... - Line 19:
- **State Management**: Tracking application data and user interactions... - Line 19:
- **State Management**: Tracking application data and user interactions... - ...and 28 more occurrences
Angular (→ /docs/glossary/terms/angular)
- Line 567:
### Angular... - Line 569:
Angular is a full-featured TypeScript framework by Google.... - Line 571:
#### Angular Component Example... - Line 567:
### Angular... - Line 569:
Angular is a full-featured TypeScript framework by Google.... - ...and 1 more occurrences
CI/CD (→ /docs/glossary/terms/ci-cd)
- Line 2012:
### CI/CD Pipeline (GitHub Actions)...
Docker (→ /docs/glossary/terms/docker)
- Line 1993:
**Dockerfile for React App**:...
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 1726:
### E2E Tests (Playwright)... - Line 2146:
### E2E Test Plans...
Git (→ /docs/glossary/terms/git)
- Line 2012:
### CI/CD Pipeline (GitHub Actions)...
GitHub Actions (→ /docs/glossary/terms/github-actions)
- Line 2012:
### CI/CD Pipeline (GitHub Actions)... - Line 2012:
### CI/CD Pipeline (GitHub Actions)...
GraphQL (→ /docs/glossary/terms/graphql)
- Line 326:
- **Flexible**: Works with any backend (REST, GraphQL, etc.)... - Line 326:
- **Flexible**: Works with any backend (REST, GraphQL, etc.)...
Playwright (→ /docs/glossary/terms/playwright)
- Line 1726:
### E2E Tests (Playwright)... - Line 1726:
### E2E Tests (Playwright)...
REST (REpresentational State Transfer) (→ /docs/glossary/terms/rest)
- Line 326:
- **Flexible**: Works with any backend (REST, GraphQL, etc.)... - Line 326:
- **Flexible**: Works with any backend (REST, GraphQL, etc.)...
commands/status.md (50 opportunities)
Already linked: abandon, status-management
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 7:
Show comprehensive increment status overview with progress tracking and suggestions.... - Line 19:
- **Active increments** (currently working)... - Line 23:
- **WIP limit status** (are you at capacity?)... - Line 25:
- **Suggestions** (next actions)... - Line 34:
Runspecweave statusat the start of each day to understand current work and identify any issues e... - ...and 17 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 17:
Thestatuscommand displays a comprehensive overview of all increments in your project, including:... - Line 18:
- **Overall progress** (X/Y increments complete)... - Line 19:
- **Active increments** (currently working)... - Line 20:
- **Paused increments** (temporarily blocked)... - Line 21:
- **Completed increments** (done and shipped)... - ...and 21 more occurrences
WIP Limits (Work In Progress) (→ /docs/glossary/terms/wip-limits)
- Line 456:
Configure WIP limits and staleness thresholds in.specweave/config.json:... - Line 456:
Configure WIP limits and staleness thresholds in.specweave/config.json:...
guides/multi-project-setup.md (49 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 32:
- **Legacy** - Brownfield imported documentation per project... - Line 64:
- Different tech stacks per team... - Line 87:
**Interactive prompts**:... - Line 192:
Each project has:... - Line 196:
**Purpose**: Feature specifications with user stories and acceptance criteria... - ...and 10 more occurrences
Brownfield Development (→ /docs/glossary/terms/brownfield)
- Line 32:
- **Legacy** - Brownfield imported documentation per project... - Line 254:
#### 5.legacy/- Brownfield Imports... - Line 475:
**After brownfield import**:... - Line 545:
- **Brownfield Import Guide** (coming soon) - Import existing docs from external sources...
Git (→ /docs/glossary/terms/git)
- Line 407:
> **Note**: If you used the-sharedflag duringspecweave init, ensure your git remote also incl... - Line 335:
Multi-project mode integrates with external sync (GitHub, JIRA, ADO):... - Line 407:
> **Note**: If you used the-sharedflag duringspecweave init, ensure your git remote also incl...
Increments (→ /docs/glossary/terms/increments)
- Line 133:
### Step 3: Create Increments (As Usual)... - Line 133:
### Step 3: Create Increments (As Usual)...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 194:
#### 1.specs/- Living Documentation Specs...
Microservices (→ /docs/glossary/terms/microservices)
- Line 34:
**Key Benefit**: Clean separation for multiple teams, repos, or microservices while sharing cross-cu... - Line 62:
- Microservices architecture... - Line 310:
### Workflow 3: Microservices... - Line 312:
**Scenario**: 5 microservices, each with its own project... - Line 34:
**Key Benefit**: Clean separation for multiple teams, repos, or microservices while sharing cross-cu... - ...and 3 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 28:
- **Specs** - Feature specifications per project... - Line 139:
**Result**: Spec created inspecs/web-app/spec-001-user-auth.md... - Line 194:
#### 1.specs/- Living Documentation Specs... - Line 194:
#### 1.specs/- Living Documentation Specs... - Line 435:
Specs are numbered per project:... - ...and 9 more occurrences
User Stories (→ /docs/glossary/terms/user-stories)
- Line 196:
**Purpose**: Feature specifications with user stories and acceptance criteria... - Line 196:
**Purpose**: Feature specifications with user stories and acceptance criteria...
guides/spec-commit-sync.md (49 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 1:
# Spec Commit Sync: Automatic Traceability from Specs to Code... - Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe... - Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe... - Line 113:
- Acceptance criteria status... - Line 123:
If commits go to different repos, multiple comments can be posted (one per repo). Each comment shows... - ...and 7 more occurrences
Git (→ /docs/glossary/terms/git)
- Line 130:
- **From code to spec**: Git commit references spec user story... - Line 242:
**Solution**: Verify git remote... - Line 261:
-src/utils/git-utils.ts- Git commit/PR detection (398 lines)... - Line 261:
-src/utils/git-utils.ts- Git commit/PR detection (398 lines)... - Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe... - ...and 17 more occurrences
Node.js (→ /docs/glossary/terms/nodejs)
- Line 220:
3. Node.js installed?...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 1:
# Spec Commit Sync: Automatic Traceability from Specs to Code... - Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe... - Line 1:
# Spec Commit Sync: Automatic Traceability from Specs to Code... - Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 278:
**Total**: ~2,102 lines of TypeScript + bash integration... - Line 278:
**Total**: ~2,102 lines of TypeScript + bash integration...
User Stories (→ /docs/glossary/terms/user-stories)
- Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe... - Line 106:
### Completed User Stories... - Line 117:
If commits exist but no user stories are fully completed, a short update is posted:... - Line 9:
SpecWeave automatically posts commit and PR links to external tools (GitHub, JIRA, Azure DevOps) whe... - Line 106:
### Completed User Stories... - ...and 1 more occurrences
WIP Limits (Work In Progress) (→ /docs/glossary/terms/wip-limits)
- Line 115:
### Work in Progress... - Line 118:
- Summary (e.g., "Work in progress: 3 commits")...
integrations/issue-trackers.md (48 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 2:
sidebar_label: Issue Tracker Integration... - Line 6:
# Issue Tracker Integration... - Line 8:
SpecWeave integrates with Jira, GitHub Issues, and Azure DevOps to sync your increments with externa... - Line 36:
**Use when**: Each team owns separate repositories (microservices, multi-repo architecture).... - Line 38:
**Example**: Frontend team ownsfrontend-app, Backend team ownsbackend-api.... - ...and 18 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 38:
**Example**: Frontend team ownsfrontend-app, Backend team ownsbackend-api.... - Line 101:
**Example**: Platform team ownsapi-gateway+auth-service, Frontend team ownsweb-app+mobi...` - Line 381:
### Jira API Token... - Line 383:
1. Go to: https://id.atlassian.com/manage-profile/security/api-tokens... - Line 384:
2. Click "Create API token"...
Git (→ /docs/glossary/terms/git)
- Line 8:
SpecWeave integrates with Jira, GitHub Issues, and Azure DevOps to sync your increments with externa... - Line 30:
## GitHub Integration... - Line 32:
GitHub supports **3 strategies** for organizing teams and repositories.... - Line 282:
| Aspect | GitHub | Jira | Azure DevOps |... - Line 327:
### GitHub... - ...and 3 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 8:
SpecWeave integrates with Jira, GitHub Issues, and Azure DevOps to sync your increments with externa... - Line 8:
SpecWeave integrates with Jira, GitHub Issues, and Azure DevOps to sync your increments with externa...
Microservices (→ /docs/glossary/terms/microservices)
- Line 36:
**Use when**: Each team owns separate repositories (microservices, multi-repo architecture).... - Line 58:
- ✅ Microservices architecture... - Line 288:
| **Best For** | Microservices, Monorepos, Platform teams | Agile teams, Kanban boards, Sprint plann... - Line 331:
| Microservices (each team owns services) | **Repository-per-team** |... - Line 36:
**Use when**: Each team owns separate repositories (microservices, multi-repo architecture).... - ...and 3 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 353:
All strategies map to **.specweave/docs/specs/** folders for consistency:... - Line 353:
All strategies map to **.specweave/docs/specs/** folders for consistency:...
guides/sync-strategies.md (39 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 5:
**Status**: User-Facing Documentation... - Line 28:
**Why this matters**: SpecWeave keeps your specs local and version-controlled. External tools reflec... - Line 81:
- ❌ All-or-nothing approach... - Line 87:
**Use when**: You work across MULTIPLE projects/repos and want board-level control... - Line 91:
- ✅ "I manage frontend across 3 repos (web, mobile, shared), need to track all"... - ...and 12 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 76:
- ✅ Fast sync (one API call to get everything)... - Line 143:
- ❌ More API calls (can hit rate limits if not careful)... - Line 287:
**Result**: Issues from 3 specific boards with labels "platform", "infrastructure", or "api"...
Git (→ /docs/glossary/terms/git)
- Line 25:
- 🪞 **External tools are MIRRORS** (GitHub, Jira, ADO sync FROM.specweave/)... - Line 28:
**Why this matters**: SpecWeave keeps your specs local and version-controlled. External tools reflec... - Line 34:
When you connect SpecWeave to external tools (Jira, GitHub, Azure DevOps), you need to choose **HOW*... - Line 52:
- ✅ "I have one GitHub repo (myorg/web-app), sync all issues"... - Line 128:
| Concept | Jira | GitHub | Azure DevOps |... - ...and 4 more occurrences
GraphQL (→ /docs/glossary/terms/graphql)
- Line 180:
- ❌ Requires learning query language (JQL/GraphQL/WIQL)... - Line 238:
- ✅ You're comfortable with JQL/GraphQL/WIQL... - Line 180:
- ❌ Requires learning query language (JQL/GraphQL/WIQL)... - Line 238:
- ✅ You're comfortable with JQL/GraphQL/WIQL...
Source of Truth (→ /docs/glossary/terms/source-of-truth)
- Line 9:
## 🎯 IMPORTANT: SpecWeave's Source of Truth... - Line 24:
- 📁 **.specweave/is your source of truth** (local, permanent, version-controlled)... - Line 9:
## 🎯 IMPORTANT: SpecWeave's Source of Truth... - Line 24:
- 📁 **.specweave/is your source of truth** (local, permanent, version-controlled)...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 28:
**Why this matters**: SpecWeave keeps your specs local and version-controlled. External tools reflec... - Line 28:
**Why this matters**: SpecWeave keeps your specs local and version-controlled. External tools reflec...
guides/ado-multi-project-migration.md (38 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 11:
**When to use**: Your organization is growing and each team needs its own ADO project.... - Line 66:
### Step 1: Backup Current Configuration... - Line 139:
**Interactive Process**:... - Line 227:
### Pattern 3: Hybrid Approach... - Line 264:
### Legacy Work Items... - ...and 3 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 320:
**Problem**: ADO API rate limits hit....
Bidirectional Sync (→ /docs/glossary/terms/bidirectional-sync)
- Line 402:
- [ ] Test bidirectional sync... - Line 402:
- [ ] Test bidirectional sync...
CI/CD (→ /docs/glossary/terms/ci-cd)
- Line 364:
### 4. Update CI/CD... - Line 404:
- [ ] Update CI/CD pipelines...
Git (→ /docs/glossary/terms/git)
- Line 464:
**Feedback**: [GitHub Issues](https://github.com/specweave/specweave/issues)...
Project Detection (→ /docs/glossary/terms/project-detection)
- Line 289:
### Issue 1: Project Detection Confidence Low... - Line 289:
### Issue 1: Project Detection Confidence Low...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 133:
The migration tool will analyze your existing specs and suggest project mappings:... - Line 173:
### Step 6: Re-sync Specs to New Structure... - Line 175:
After migration, sync your specs to the new ADO structure:... - Line 213:
Migrate everything at once (recommended for <20 specs):... - Line 229:
Keep some specs in root, migrate others:... - ...and 17 more occurrences
guides/multilingual-guide.md (36 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 50:
|translation.autoTranslateLivingDocs| boolean | false | Auto-translate documentation after each ... - Line 67:
After each task completion, changed documentation files are automatically translated while preservin... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 146:
3. Translates each file using LLM... - Line 148:
5. Updates files in place...
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 105:
✅ **Framework Terms**: increment, spec.md, plan.md, tasks.md, COMPLETION-SUMMARY.md, living docs, PM... - Line 105:
✅ **Framework Terms**: increment, spec.md, plan.md, tasks.md, COMPLETION-SUMMARY.md, living docs, PM...
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre...
Docker (→ /docs/glossary/terms/docker)
- Line 52:
|translation.keepTechnicalTerms| boolean | true | Keep technical terms in English (TypeScript, n... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 52:
|translation.keepTechnicalTerms| boolean | true | Keep technical terms in English (TypeScript, n... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre...
Git (→ /docs/glossary/terms/git)
- Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 145:
2. Detects changed.mdfiles viagit diff... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 145:
2. Detects changed.mdfiles viagit diff... - Line 701:
- [Discussions](https://github.com/anton-abyzov/specweave/discussions)...
Increments (→ /docs/glossary/terms/increments)
- Line 173:
-all- Everything (increments + docs + skills + agents + commands)... - Line 174:
-increments- All increment folders (spec.md, plan.md, tasks.md, etc.)... - Line 173:
-all- Everything (increments + docs + skills + agents + commands)... - Line 174:
-increments- All increment folders (spec.md, plan.md, tasks.md, etc.)...
Kubernetes (K8s) (→ /docs/glossary/terms/kubernetes)
- Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 66:
**Living Docs Auto-Translation**:... - Line 105:
✅ **Framework Terms**: increment, spec.md, plan.md, tasks.md, COMPLETION-SUMMARY.md, living docs, PM... - Line 127:
### Method 1: Automatic Living Docs Translation...
React (→ /docs/glossary/terms/react)
- Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre...
REST (REpresentational State Transfer) (→ /docs/glossary/terms/rest)
- Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre...
RFC (Request for Comments) (→ /docs/glossary/terms/rfc)
- Line 105:
✅ **Framework Terms**: increment, spec.md, plan.md, tasks.md, COMPLETION-SUMMARY.md, living docs, PM... - Line 105:
✅ **Framework Terms**: increment, spec.md, plan.md, tasks.md, COMPLETION-SUMMARY.md, living docs, PM...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 52:
|translation.keepTechnicalTerms| boolean | true | Keep technical terms in English (TypeScript, n... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre... - Line 52:
|translation.keepTechnicalTerms| boolean | true | Keep technical terms in English (TypeScript, n... - Line 107:
✅ **Technical Terms**: TypeScript, npm, git, Docker, Kubernetes, API, CLI, REST, JSON, HTTP, Postgre...
guides/cost-optimization.md (34 opportunities)
Already linked: model-selection
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 41:
Each agent knows its optimal model:... - Line 55:
### 3. Real-Time Cost Tracking... - Line 57:
Every agent invocation is tracked:... - Line 154:
### Scenario 1: Full-Stack Feature... - Line 162:
- Backend implementation: $15.00... - ...and 21 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 191:
**Task**: Generate API documentation... - Line 198:
- API reference: $2.00 (Haiku - execution) 💰 **saves $5**... - Line 330:
- API keys (never touch this)...
Git (→ /docs/glossary/terms/git)
- Line 420:
**Feedback?** [Start a discussion](https://github.com/anton-abyzov/specweave/discussions)...
Increments (→ /docs/glossary/terms/increments)
- Line 369:
- Planning-heavy increments naturally use more Sonnet... - Line 369:
- Planning-heavy increments naturally use more Sonnet...
TDD (Test-Driven Development) (→ /docs/glossary/terms/tdd)
- Line 44:
- **Hybrid agents** → Auto-detect (Test-Aware Planner, TDD Orchestrator)... - Line 44:
- **Hybrid agents** → Auto-detect (Test-Aware Planner, TDD Orchestrator)...
guides/meta-capability.md (33 opportunities)
Already linked: creating-custom-agents, creating-custom-skills
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 16:
**In other words**: The factory builds factories, and you're the architect.... - Line 16:
**In other words**: The factory builds factories, and you're the architect.... - Line 50:
✅ **Solution**: Infinite extensibility tailored to your exact requirements.... - Line 60:
**Traditional approach**:... - Line 67:
**SpecWeave approach**:... - ...and 16 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 88:
**Scenario**: Your company has strict API conventions that every service must follow....
Git (→ /docs/glossary/terms/git)
- Line 451:
- ✅ Use.gitignore→ Don't even commit to git... - Line 451:
- ✅ Use.gitignore→ Don't even commit to git... - Line 451:
- ✅ Use.gitignore→ Don't even commit to git...
HIPAA (Health Insurance Portability and Accountability Act) (→ /docs/glossary/terms/hipaa)
- Line 138:
### Example 1: Healthcare SaaS with HIPAA Compliance... - Line 170:
**Result**: Healthcare SaaS with built-in HIPAA expertise!... - Line 251:
- Healthcare? Createhipaa-complianceagent... - Line 138:
### Example 1: Healthcare SaaS with HIPAA Compliance... - Line 170:
**Result**: Healthcare SaaS with built-in HIPAA expertise!... - ...and 1 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 317:
- ✅ Can remove SpecWeave entirely (your specs remain intact)... - Line 317:
- ✅ Can remove SpecWeave entirely (your specs remain intact)...
guides/core-concepts/what-is-an-increment.md (33 opportunities)
Already linked: fda, hipaa, soc2
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 21:
**Each increment contains:**... - Line 22:
- 📋 **spec.md** - What and Why (requirements, user stories, acceptance criteria)... - Line 23:
- 🏗️ **plan.md** - How (architecture, test strategy, implementation approach)... - Line 96:
- Requirement-to-code traceability... - Line 107:
| Documentation scattered | **Everything in one place** |... - ...and 6 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 119:
| **change-request** | Stakeholder request | No | UI redesign, API changes |...
Git (→ /docs/glossary/terms/git)
- Line 5:
## Think of Increments as "Git Commits for Features"... - Line 7:
Just like Git commits capture code changes with messages and history, **increments capture feature d... - Line 5:
## Think of Increments as "Git Commits for Features"... - Line 7:
Just like Git commits capture code changes with messages and history, **increments capture feature d...
Increments (→ /docs/glossary/terms/increments)
- Line 5:
## Think of Increments as "Git Commits for Features"... - Line 7:
Just like Git commits capture code changes with messages and history, **increments capture feature d... - Line 54:
## Why Increments?... - Line 103:
| Without Increments | With Increments |... - Line 103:
| Without Increments | With Increments |... - ...and 5 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 3:
An **increment** is SpecWeave's fundamental unit of work—a complete, self-contained feature with spe...
Test Coverage (→ /docs/glossary/terms/test-coverage)
- Line 97:
- Test coverage proof... - Line 97:
- Test coverage proof...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 120:
| **refactor** | Code improvement | No | Extract service layer, TypeScript migration |... - Line 120:
| **refactor** | Code improvement | No | Extract service layer, TypeScript migration |...
User Stories (→ /docs/glossary/terms/user-stories)
- Line 22:
- 📋 **spec.md** - What and Why (requirements, user stories, acceptance criteria)... - Line 22:
- 📋 **spec.md** - What and Why (requirements, user stories, acceptance criteria)...
guides/github-action-setup.md (32 opportunities)
Already linked: adr, api, e2e
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 1:
# GitHub Actions Integration Setup Guide... - Line 3:
**Complete guide to integrating SpecWeave with GitHub Actions for automated spec-driven development*... - Line 518:
- TC-0001 traceability (spec → tests)... - Line 563:
5. Syncs with JIRA/Slack if configured... - Line 645:
- Workflow runs (check **Actions** tab)... - ...and 6 more occurrences
Brownfield Development (→ /docs/glossary/terms/brownfield)
- Line 471:
### 3. Brownfield Protection... - Line 682:
### Test 3: Brownfield Protection... - Line 685:
1. Create branch:test-brownfield... - Line 692:
- Brownfield check triggered... - Line 697:
- Check PR comments for brownfield report... - ...and 2 more occurrences
Git (→ /docs/glossary/terms/git)
- Line 1:
# GitHub Actions Integration Setup Guide... - Line 3:
**Complete guide to integrating SpecWeave with GitHub Actions for automated spec-driven development*... - Line 739:
- Check:.github/workflows/specweave-*.ymlexists... - Line 777:
- Update GitHub secret...
GitHub Actions (→ /docs/glossary/terms/github-actions)
- Line 1:
# GitHub Actions Integration Setup Guide... - Line 3:
**Complete guide to integrating SpecWeave with GitHub Actions for automated spec-driven development*... - Line 1:
# GitHub Actions Integration Setup Guide... - Line 3:
**Complete guide to integrating SpecWeave with GitHub Actions for automated spec-driven development*...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 478:
- Specs indocs/internal/strategy/... - Line 854:
- Create specs indocs/internal/strategy/... - Line 478:
- Specs indocs/internal/strategy/... - Line 854:
- Create specs indocs/internal/strategy/...
Test Coverage (→ /docs/glossary/terms/test-coverage)
- Line 511:
### 4. Test Coverage Validation... - Line 511:
### 4. Test Coverage Validation...
learn/ml-ai/ml-fundamentals.md (30 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 29:
Artificial Intelligence and Machine Learning have transformed from research curiosities to essential... - Line 31:
This guide teaches you:... - Line 83:
- ✅ Extraction (entities, relationships)... - Line 86:
- ❌ Access real-time data (unless via API calls)... - Line 89:
- ❌ Access private data (unless provided in context)... - ...and 13 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 86:
- ❌ Access real-time data (unless via API calls)... - Line 94:
### Pattern 1: Direct API Calls... - Line 96:
**Simplest approach**: Call LLM API directly... - Line 579:
**Llama 3.1**: Privacy-sensitive data, no API costs, offline usage, customization... - Line 619:
**Using pre-trained models via API:**... - ...and 4 more occurrences
Git (→ /docs/glossary/terms/git)
- Line 29:
Artificial Intelligence and Machine Learning have transformed from research curiosities to essential...
GraphQL (→ /docs/glossary/terms/graphql)
- Line 836:
| **Weaviate** | Self-hosted | Open source, GraphQL API |... - Line 836:
| **Weaviate** | Self-hosted | Open source, GraphQL API |...
glossary/categories/backend.md (30 opportunities)
Already linked: event-driven, graphql, microservices, mongodb, monolith, nestjs, nodejs, postgresql, redis
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 2:
id: backend-category... - Line 3:
title: Backend Development... - Line 4:
sidebar_label: Backend Development... - Line 7:
# Backend Development... - Line 15:
Backend development terms cover server-side logic, API design, database management, and business log... - ...and 9 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 15:
Backend development terms cover server-side logic, API design, database management, and business log... - Line 19:
### API Design... - Line 21:
**REST API**... - Line 25:
- SpecWeave generates REST API specs in increment planning... - Line 105:
| **REST API** | Standard CRUD operations, simple resources | Real-time updates, complex data fetchi... - ...and 1 more occurrences
REST (REpresentational State Transfer) (→ /docs/glossary/terms/rest)
- Line 21:
**REST API**... - Line 25:
- SpecWeave generates REST API specs in increment planning... - Line 105:
| **REST API** | Standard CRUD operations, simple resources | Real-time updates, complex data fetchi... - Line 118:
**Phase 1: MVP (0-3 months)** - Monolith + REST API... - Line 21:
**REST API**... - ...and 3 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 25:
- SpecWeave generates REST API specs in increment planning... - Line 25:
- SpecWeave generates REST API specs in increment planning...
glossary/categories/frontend.md (28 opportunities)
Already linked: angular, context-api, css-modules, nextjs, react, redux, spa, ssg, ssr, styled-components, tailwind, zustand
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 15:
Frontend development terms cover client-side logic, UI frameworks, state management, and user interf... - Line 15:
Frontend development terms cover client-side logic, UI frameworks, state management, and user interf... - Line 104:
- Best for: React apps, complex theming... - Line 112:
| **React** | Component reusability, large ecosystem | Simple websites, SEO-critical |... - Line 239:
- ✅ React Query for server state (caching, background updates)... - ...and 10 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 162:
- ✅ Simple state management (Context API)...
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 361:
- Suggests testing strategy (Playwright for E2E)... - Line 396:
### 5. E2E Testing with Playwright... - Line 398:
SpecWeave mandates E2E tests for UI features:...
Increments (→ /docs/glossary/terms/increments)
- Line 350:
When creating frontend increments:... - Line 382:
Frontend increments include embedded tests:... - Line 350:
When creating frontend increments:... - Line 382:
Frontend increments include embedded tests:...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 363:
### 3. Living Documentation...
Playwright (→ /docs/glossary/terms/playwright)
- Line 361:
- Suggests testing strategy (Playwright for E2E)... - Line 396:
### 5. E2E Testing with Playwright... - Line 361:
- Suggests testing strategy (Playwright for E2E)... - Line 396:
### 5. E2E Testing with Playwright...
guides/github-integration.md (26 opportunities)
Already linked: api, git, github-actions
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 231:
### Step 5: Track Progress... - Line 417:
**Use when**: Solo developer or small team, simple tracking needs... - Line 442:
**Use when**: Team collaboration, granular tracking, GitHub Projects integration... - Line 446:
- Each task gets individual issue linked to epic... - Line 496:
---dry-run- Show what would be created without actually creating... - ...and 11 more occurrences
Bidirectional Sync (→ /docs/glossary/terms/bidirectional-sync)
- Line 728:
2. SpecWeave detects checkbox changes (future: bidirectional sync)... - Line 728:
2. SpecWeave detects checkbox changes (future: bidirectional sync)...
Increments (→ /docs/glossary/terms/increments)
- Line 3:
**SpecWeave GitHub Integration** - Seamless task-level synchronization between SpecWeave increments ... - Line 256:
SpecWeave maps increments to GitHub using a three-level hierarchy:... - Line 1159:
### Q: Can I sync existing increments?... - Line 1205:
### Q: How do I sync multiple increments at once?... - Line 3:
**SpecWeave GitHub Integration** - Seamless task-level synchronization between SpecWeave increments ... - ...and 3 more occurrences
commands/status-management.md (24 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 11:
The/statuscommand provides a **high-level overview** of all your increments, showing what's acti... - Line 62:
- **Active work**: What you're currently working on... - Line 65:
- **WIP limits**: Are you at capacity?... - Line 81:
- ✅ See all active work... - Line 90:
| **active** | Currently being worked on | ✅ Yes |... - ...and 3 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 11:
The/statuscommand provides a **high-level overview** of all your increments, showing what's acti... - Line 135:
### Workflow 2: Monitor Multiple Paused Increments... - Line 314:
- ✅ Use/statusto **monitor** all increments... - Line 11:
The/statuscommand provides a **high-level overview** of all your increments, showing what's acti... - Line 135:
### Workflow 2: Monitor Multiple Paused Increments... - ...and 1 more occurrences
WIP Limits (Work In Progress) (→ /docs/glossary/terms/wip-limits)
- Line 65:
- **WIP limits**: Are you at capacity?... - Line 75:
- ❌ No visibility into WIP limits... - Line 83:
- ✅ Monitor WIP limits... - Line 95:
## WIP Limits... - Line 316:
- ✅ Displays **WIP limits** and **smart suggestions**... - ...and 5 more occurrences
glossary/categories/testing.md (21 opportunities)
Already linked: bdd, integration-testing, jest, playwright, pytest, tdd, test-coverage, test-pyramid, unit-testing
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 277:
- ✅ AC-ID traceability (AC-US1-01, AC-US1-02)... - Line 299:
- ✅ AC-ID traceability... - Line 277:
- ✅ AC-ID traceability (AC-US1-01, AC-US1-02)... - Line 299:
- ✅ AC-ID traceability...
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 15:
Testing and quality terms cover the practices, tools, and methodologies for verifying software corre... - Line 85:
- Best for: Python backend testing... - Line 149:
**Step 3: REFACTOR - Improve Implementation**... - Line 179:
Run test:npm test→ ✅ STILL PASSES (refactored without breaking tests)... - Line 181:
### Test Pyramid in Practice... - ...and 6 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 97:
| **Integration Testing** | Testing API endpoints, database operations | Testing pure functions |...
E2E (End-to-End Testing) (→ /docs/glossary/terms/e2e)
- Line 98:
| **E2E Testing** | Testing critical user flows (login, checkout) | Testing internal utilities |... - Line 210:
- ✅ E2E tests are SLOW (minutes), run before deployment... - Line 212:
- ✅ Reserve E2E for critical user flows only... - Line 356:
### 4. Mandatory E2E Testing... - Line 358:
**SpecWeave enforces E2E tests for UI features**:...
workflows/brownfield.md (20 opportunities)
Already linked: adr, brownfield
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 31:
## The SpecWeave Brownfield Approach... - Line 48:
3. **Retroactive architecture** (understand before changing)... - Line 150:
- ✅ All knowledge in one place... - Line 588:
- Knowledge transfer before refactor... - Line 613:
- Refactoring legacy code... - ...and 9 more occurrences
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 542:
**As you implement**, living docs auto-update:... - Line 50:
5. **Living documentation** (keep current forever)...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 708:
- ✅ Team velocity improved (clear specs)... - Line 708:
- ✅ Team velocity improved (clear specs)...
Test Coverage (→ /docs/glossary/terms/test-coverage)
- Line 707:
- ✅ 85% test coverage (was 0%)... - Line 707:
- ✅ 85% test coverage (was 0%)...
glossary/categories/devops.md (20 opportunities)
Already linked: ci-cd, docker, eslint, git, github-actions, npm, prettier, yarn
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 15:
DevOps and tools terms cover the practices, workflows, and technologies that bridge development and ... - Line 97:
- Consistent code style across team... - Line 109:
| **GitHub Actions** | GitHub-hosted projects, simple CI/CD | Complex enterprise pipelines, self-hos... - Line 380:
- ✅ Increment history tracked in Git... - Line 382:
- ✅ Traceability (Git blame shows who/when/why)...
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 381:
- ✅ Architecture decisions (ADRs) versioned...
Bidirectional Sync (→ /docs/glossary/terms/bidirectional-sync)
- Line 403:
- Bidirectional sync (increment tasks ↔ GitHub issues)... - Line 403:
- Bidirectional sync (increment tasks ↔ GitHub issues)...
Increments (→ /docs/glossary/terms/increments)
- Line 405:
- Link PRs to increments... - Line 410:
SpecWeave increments include CI/CD examples:... - Line 405:
- Link PRs to increments... - Line 410:
SpecWeave increments include CI/CD examples:...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 365:
SpecWeave requires Git for living docs:... - Line 379:
- ✅ Living docs sync uses Git hooks...
Microservices (→ /docs/glossary/terms/microservices)
- Line 110:
| **Docker** | Deployment consistency, microservices | Simple single-server apps, static sites |... - Line 110:
| **Docker** | Deployment consistency, microservices | Simple single-server apps, static sites |...
Test Coverage (→ /docs/glossary/terms/test-coverage)
- Line 216:
4. ✅ Upload test coverage to Codecov... - Line 216:
4. ✅ Upload test coverage to Codecov...
TypeScript (→ /docs/glossary/terms/typescript)
- Line 112:
| **ESLint** | JavaScript/TypeScript projects | Configuration files, markdown |... - Line 112:
| **ESLint** | JavaScript/TypeScript projects | Configuration files, markdown |...
workflows/planning.md (17 opportunities)
Already linked: bdd, brownfield, tdd
AC-ID (Acceptance Criteria Identifier) (→ /docs/glossary/terms/ac-id)
- Line 80:
**Output**:spec.mdwith user stories and AC-IDs... - Line 516:
- [ ] Acceptance criteria with AC-IDs (AC-US1-01, ...)... - Line 530:
- [ ] All AC-IDs mapped to tasks...
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 59:
**Example interaction:**... - Line 80:
**Output**:spec.mdwith user stories and AC-IDs... - Line 516:
- [ ] Acceptance criteria with AC-IDs (AC-US1-01, ...)... - Line 516:
- [ ] Acceptance criteria with AC-IDs (AC-US1-01, ...)... - Line 516:
- [ ] Acceptance criteria with AC-IDs (AC-US1-01, ...)... - ...and 4 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 3:
The planning phase transforms a feature idea into a **complete, executable implementation plan** wit...
User Stories (→ /docs/glossary/terms/user-stories)
- Line 80:
**Output**:spec.mdwith user stories and AC-IDs... - Line 515:
- [ ] User stories written (US-001, US-002, ...)... - Line 80:
**Output**:spec.mdwith user stories and AC-IDs... - Line 515:
- [ ] User stories written (US-001, US-002, ...)...
guides/mobile/react-native-setup-guide.md (17 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 1:
# React Native & Expo Setup Guide... - Line 3:
Complete guide for setting up a React Native development environment for iOS and Android development... - Line 593:
3. Ask in [Reactiflux Discord](https://www.reactiflux.com/) #react-native channel... - Line 593:
3. Ask in [Reactiflux Discord](https://www.reactiflux.com/) #react-native channel... - Line 599:
**Tested With**: React Native 0.73, Expo SDK 50...
Git (→ /docs/glossary/terms/git)
- Line 594:
4. File an issue on your project's GitHub repository...
Node.js (→ /docs/glossary/terms/nodejs)
- Line 11:
#### 1. Node.js & npm... - Line 13:
**Version Required**: Node.js 18.x or later...
React (→ /docs/glossary/terms/react)
- Line 1:
# React Native & Expo Setup Guide... - Line 3:
Complete guide for setting up a React Native development environment for iOS and Android development... - Line 593:
3. Ask in [Reactiflux Discord](https://www.reactiflux.com/) #react-native channel... - Line 599:
**Tested With**: React Native 0.73, Expo SDK 50... - Line 1:
# React Native & Expo Setup Guide... - ...and 4 more occurrences
commands/pause.md (17 opportunities)
Already linked: abandon, status, status-management
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 21:
Thepausecommand temporarily suspends work on an active increment. SpecWeave calls this automatic... - Line 101:
- ✅ Suggested next action... - Line 168:
-active→paused✅... - Line 199:
### WIP Limit Impact... - Line 263:
## Best Practices... - ...and 3 more occurrences
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 24:
- 🚧 Missing dependencies (API keys, credentials, configuration)...
Increments (→ /docs/glossary/terms/increments)
- Line 7:
System command used by SpecWeave to pause increments when blocked.... - Line 312:
**Rule of thumb**: Max 2-3 paused increments... - Line 314:
If you have 5+ paused increments, something is wrong:... - Line 413:
- ✅ Paused increments don't count toward WIP limit... - Line 7:
System command used by SpecWeave to pause increments when blocked.... - ...and 3 more occurrences
glossary/categories/infrastructure.md (16 opportunities)
Already linked: ci-cd, docker, github-actions, iac, kubernetes, terraform
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 19:
### Infrastructure as Code (IaC)... - Line 55:
**[GitHub Actions](/docs/glossary/terms/github-actions)**... - Line 59:
- SpecWeave provides Action examples in increment planning... - Line 65:
- Three pillars: logs, metrics, traces... - Line 77:
| **Docker** | Packaging applications, development consistency | Monolithic apps with simple deploym... - ...and 4 more occurrences
Git (→ /docs/glossary/terms/git)
- Line 89:
- Deployment: SSH + git pull... - Line 55:
**[GitHub Actions](/docs/glossary/terms/github-actions)**... - Line 56:
- GitHub's built-in CI/CD platform... - Line 89:
- Deployment: SSH + git pull... - Line 97:
- Deployment: GitHub Actions + Docker Compose... - ...and 1 more occurrences
Monolith (→ /docs/glossary/terms/monolith)
- Line 77:
| **Docker** | Packaging applications, development consistency | Monolithic apps with simple deploym...
commands/abandon.md (15 opportunities)
Already linked: status, status-management
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 21:
- ❌ Approach was wrong (discovered better solution)... - Line 22:
- 🔀 Superseded (replaced by different increment)... - Line 25:
:::warning Permanent Action... - Line 88:
### Example 2: Abandon Without Reason (Interactive)... - Line 153:
-active→abandoned✅... - ...and 6 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 26:
Abandon is **permanent** and moves the increment to_abandoned/. Unlike pause, abandoned increment... - Line 549:
- ✅ Cannot abandon completed increments... - Line 26:
Abandon is **permanent** and moves the increment to_abandoned/. Unlike pause, abandoned increment... - Line 549:
- ✅ Cannot abandon completed increments...
README.md (14 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 3:
**This documentation IS published publicly.** It is customer-facing and should contain no secrets or... - Line 25:
- **Contents**: How-to guides, tutorials, best practices... - Line 95:
- **Serves** alldocs/public/content as public-facing documentation...
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 36:
❌ Architecture Decision Records (ADR)... - Line 36:
❌ Architecture Decision Records (ADR)... - Line 36:
❌ Architecture Decision Records (ADR)...
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 18:
###/api/- API Documentation... - Line 18:
###/api/- API Documentation... - Line 19:
- **Purpose**: API reference for developers... - Line 21:
- **Audience**: Developers integrating with your API... - Line 40:
❌ Secrets, credentials, API keys... - ...and 1 more occurrences
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 20:
- **Contents**: OpenAPI specs, authentication, rate limits, examples... - Line 20:
- **Contents**: OpenAPI specs, authentication, rate limits, examples...
metrics.md (14 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 12:
<a href="https://github.com/anton-abyzov/specweave/actions/workflows/dora-metrics.yml" target="_blan... - Line 13:
<img src="https://img.shields.io/github/actions/workflow/status/anton-abyzov/specweave/dora-metrics.... - Line 167:
Track our progress over time as we optimize SpecWeave's delivery performance:... - Line 173:
- 🔧 MTTR: Track once we have incidents (target: <1 hour)...
Git (→ /docs/glossary/terms/git)
- Line 12:
<a href="https://github.com/anton-abyzov/specweave/actions/workflows/dora-metrics.yml" target="_blan... - Line 13:
<img src="https://img.shields.io/github/actions/workflow/status/anton-abyzov/specweave/dora-metrics.... - Line 22:
<img src="https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/anton-abyz... - Line 24:
<img src="https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/anton-abyz... - Line 40:
<img src="https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/anton-abyz... - ...and 3 more occurrences
Increments (→ /docs/glossary/terms/increments)
- Line 161:
**Architecture Decision**: [Why No Database](https://github.com/anton-abyzov/specweave/blob/develop/... - Line 161:
**Architecture Decision**: [Why No Database](https://github.com/anton-abyzov/specweave/blob/develop/...
workflows/implementation.md (11 opportunities)
Already linked: tdd, typescript
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 92:
**[TDD](/docs/glossary/terms/tdd) approach** (optional but recommended):... - Line 193:
#### 2e. Refactor (Optional)... - Line 230:
**Hook actions:**... - Line 233:
- ✅ Updates ADRs (Proposed → Accepted)... - Line 469:
1. **Follow [TDD](/docs/glossary/terms/tdd)** (Red → Green → Refactor)... - ...and 1 more occurrences
Architecture Decision Record (ADR) (→ /docs/glossary/terms/adr)
- Line 233:
- ✅ Updates ADRs (Proposed → Accepted)...
Git (→ /docs/glossary/terms/git)
- Line 480:
3. **Don't bypass hooks** (use/specweave:do, not raw git)... - Line 480:
3. **Don't bypass hooks** (use/specweave:do, not raw git)...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 3:
The implementation phase is where specs and plans become **working code**—with SpecWeave handling th... - Line 3:
The implementation phase is where specs and plans become **working code**—with SpecWeave handling th...
overview/features.md (9 opportunities)
Already linked: adr, api, bdd, brownfield, ci-cd, e2e, fda, git, hipaa, nextjs, react, soc2, typescript
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 7:
### Interactive Quick Build... - Line 11:
Simply describe what you want - SpecWeave guides you through interactive prompts:... - Line 13:
1. **Approach** - Quick build or spec-first planning... - Line 15:
3. **Tech Stack** - Choose your tools... - Line 45:
**Both approaches** use the same powerful plugin system and multi-agent architecture under the hood!... - ...and 2 more occurrences
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 90:
| **"What's the current architecture?"** | Docs outdated | Living docs auto-updated |... - Line 51:
### Append-Only Snapshots + Living Documentation...
guides/model-selection.md (8 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 9:
SpecWeave uses a three-layer intelligent system to automatically choose the best AI model for each t... - Line 10:
1. **Agent Preferences** - Each agent declares its optimal model... - Line 29:
**Characteristics**:... - Line 33:
- High accuracy... - Line 33:
- High accuracy... - ...and 2 more occurrences
Git (→ /docs/glossary/terms/git)
- Line 63:
**See full content at**: https://github.com/anton-abyzov/specweave/blob/develop/.specweave/docs/publ...
commands/resume.md (8 opportunities)
Already linked: abandon, status, status-management
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 88:
- ✅ Continued from exact point where paused... - Line 396:
- ✅ **WIP limits enforced**: Can't exceed focus capacity...
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 24:
- ✅ API keys/credentials become available... - Line 84:
- ✅ Monitored IT ticket and API key availability...
Increments (→ /docs/glossary/terms/increments)
- Line 7:
System command used by SpecWeave to resume paused increments when blockages are resolved.... - Line 7:
System command used by SpecWeave to resume paused increments when blockages are resolved....
WIP Limits (Work In Progress) (→ /docs/glossary/terms/wip-limits)
- Line 396:
- ✅ **WIP limits enforced**: Can't exceed focus capacity... - Line 396:
- ✅ **WIP limits enforced**: Can't exceed focus capacity...
glossary/categories/ml-ai.md (7 opportunities)
Already linked: context-window, fine-tuning, inference, llm, model-training, prompt-engineering, pytorch, rag, scikit-learn, tensorflow, token, vector-database
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 3:
title: ML/AI & Machine Learning... - Line 7:
# ML/AI & Machine Learning... - Line 9:
Understanding machine learning, artificial intelligence, and LLM-powered applications.... - Line 15:
ML/AI terms cover machine learning models, training, inference, and AI-powered application developme... - Line 19:
### Machine Learning Fundamentals... - ...and 2 more occurrences
overview/introduction.md (7 opportunities)
Already linked: adr, brownfield, e2e, github-actions, greenfield, hipaa, integration-testing, soc2, tdd, test-pyramid, typescript, unit-testing
Source of Truth (→ /docs/glossary/terms/source-of-truth)
- Line 3:
**SpecWeave** is a specification-first AI development framework that transforms how you build produc... - Line 3:
**SpecWeave** is a specification-first AI development framework that transforms how you build produc...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 18:
- No specs = unclear requirements... - Line 18:
- No specs = unclear requirements... - Line 3:
**SpecWeave** is a specification-first AI development framework that transforms how you build produc... - Line 3:
**SpecWeave** is a specification-first AI development framework that transforms how you build produc... - Line 51:
Create comprehensive specifications in.specweave/docs/internal/strategy/:...
guides/core-concepts/living-documentation.md (6 opportunities)
Already linked: adr, api, git
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 25:
**Result**: Documentation becomes **worse than useless**—it actively misleads developers.... - Line 88:
- [API](/docs/glossary/terms/api) contracts match implemented endpoints...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 29:
SpecWeave's living docs **auto-update after every task completion**:... - Line 1:
# Living Documentation... - Line 3:
**Living documentation** is documentation that automatically stays synchronized with your code—no ma... - Line 27:
## The Solution: Living Documentation...
overview/philosophy.md (6 opportunities)
Already linked: brownfield, e2e, fda, git, greenfield, hipaa, soc2, typescript
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 27:
**SpecWeave's revolutionary approach**: Most documentation systems force you to choose between histo... - Line 32:
- Each increment is an immutable snapshot of a feature...
Increments (→ /docs/glossary/terms/increments)
- Line 31:
**Append-Only Increments** (Never Modified)... - Line 31:
**Append-Only Increments** (Never Modified)...
Living Documentation (→ /docs/glossary/terms/living-docs)
- Line 23:
### 2. Append-Only Snapshots + Living Documentation...
Specifications (Specs) (→ /docs/glossary/terms/specs)
- Line 11:
Traditional development often jumps straight to implementation without clear specifications. This le...
guides/getting-started/installation.md (5 opportunities)
Already linked: ci-cd, git, nodejs
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 248:
- ✅ Keeps your git history intact... - Line 267:
Each project gets its own independent SpecWeave installation.... - Line 623:
- **npm Package:** [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)...
Brownfield Development (→ /docs/glossary/terms/brownfield)
- Line 231:
### Existing Project (Brownfield)...
Greenfield Development (→ /docs/glossary/terms/greenfield)
- Line 210:
### New Project (Greenfield)...
api/README.md (5 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 3:
API documentation is being built. Check back soon!...
API (Application Programming Interface) (→ /docs/glossary/terms/api)
- Line 1:
# API Reference... - Line 3:
API documentation is being built. Check back soon!... - Line 8:
- Skills API Documentation... - Line 9:
- Agents API Documentation...
glossary/categories/collaboration.md (4 opportunities)
Already linked: backlog, epic, github-issues, jira, kanban, scrum, spike, sprint-planning, story-points, task, user-story, velocity
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 9:
Understanding agile methodologies, project management, and team collaboration practices.... - Line 15:
Collaboration and management terms cover the methodologies, practices, and tools that enable teams t... - Line 22:
- Iterative, incremental approach to software development... - Line 25:
- When to use: uncertainty, changing requirements, need for feedback...
glossary/categories/performance.md (4 opportunities)
Already linked: apm, cdn, connection-pooling, database-indexing, horizontal-scaling, load-balancing, metrics, profiling, query-optimization, redis, vertical-scaling
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 15:
Performance and scalability terms cover the practices, patterns, and technologies for building syste... - Line 19:
### Caching Strategies... - Line 21:
**Caching**... - Line 22:
- Store frequently accessed data in fast storage...
commands/overview.md (4 opportunities)
Already linked: adr, api, e2e, graphql, iac, microservices, nodejs, rest, rfc
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 10:
All commands MUST use the/specweave:*namespace prefix. Shortcuts like/inc,/do,/pause,...` - Line 10:
All commands MUST use the/specweave:*namespace prefix. Shortcuts like/inc,/do,/pause,...` - Line 380:
> SpecWeave commands are designed for **intelligent automation**. The system detects intent, suggest...
Git (→ /docs/glossary/terms/git)
- Line 375:
- **GitHub Integration**: [GitHub Sync Guide](/docs/guides/github-sync)...
workflows/overview.md (3 opportunities)
Already linked: brownfield, greenfield, tdd
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 25:
**Each phase has:**... - Line 317:
## Interactive Decision Tree... - Line 496:
- Best Practices...
guides/getting-started/quickstart.md (2 opportunities)
Already linked: brownfield, e2e, fda, git, github-actions, hipaa, iac, nodejs, playwright, soc2, tdd, terraform
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 28:
- ✅ **SpecWeave Skills** - 17 auto-activating capabilities (planning, [TDD](/docs/glossary/terms/tdd... - Line 261:
**SpecWeave** - Replace vibe coding with spec-driven development....
reference/cost-tracking.md (2 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 1:
# Cost Tracking Reference... - Line 3:
**Technical reference for SpecWeave cost tracking system**...
glossary/README.md (1 opportunities)
Acceptance Criteria (AC) (→ /docs/glossary/terms/acceptance-criteria)
- Line 9:
Welcome to the SpecWeave Technical Glossary! This comprehensive reference explains all technical ter...