teamspec 3.2.0 → 4.1.0

package/teamspec-core/templates/products-index-template.md

@@ -0,0 +1,46 @@
+# Products Index
+
+Master index of all products in this workspace.
+
+## Overview
+
+Products represent the **AS-IS** state of your systems. They contain:
+- Feature Canon (source of truth for behavior)
+- Business Analysis documents
+- Solution Designs
+- Technical Architecture decisions
+
+Projects propose **TO-BE** changes to products via Feature Increments.
+
+## Product Registry
+
+| Prefix | ID | Name | Status | Active Projects |
+|--------|-----|------|--------|-----------------|
+| _(none yet)_ | | | | |
+
+---
+
+## Adding Products
+
+Use one of these methods:
+
+1. **CLI:** `teamspec init --product <name>`
+2. **Copilot:** `ts:po product`
+3. **Manual:** Copy `/.teamspec/templates/product-template.yml`
+
+## Product Structure
+
+Each product folder contains:
+
+```
+products/<product-id>/
+├── product.yml                 # Product configuration (includes PRX prefix)
+├── README.md                   # Product overview
+├── business-analysis/          # BA documents (ba-PRX-XXX)
+├── features/                   # Feature Canon (f-PRX-XXX)
+│   ├── features-index.md
+│   └── story-ledger.md
+├── solution-designs/           # Solution designs (sd-PRX-XXX)
+├── technical-architecture/     # Tech architecture (ta-PRX-XXX)
+└── decisions/                  # Product decisions (dec-PRX-XXX)
+```

package/teamspec-core/templates/project-template.yml

@@ -0,0 +1,70 @@
+# Project Configuration Template
+# TeamSpec 4.0 - Product/Project Operating Model
+#
+# Usage: Copy this template to projects/<project-id>/project.yml
+# Replace placeholders marked with <...>
+
+project:
+  # Unique slug identifier (lowercase, hyphens)
+  id: "<project-id>"
+  
+  # Human-readable name
+  name: "<Project Name>"
+  
+  # Project description (TO-BE goals)
+  description: |
+    # TODO: Describe what this project will CHANGE
+    # - What business outcomes are targeted?
+    # - What products will be modified?
+    # - What is the expected timeline?
+  
+  # Project lifecycle status
+  status: active  # Options: planning, active, paused, completed, archived
+  
+  # Target products this project will modify
+  # Each entry creates a feature-increment link
+  target_products:
+    - product_id: "<product-id>"
+      prefix: "<PRX>"          # Product prefix for artifact naming
+      # epic_id: "epic-PRX-001"  # Optional: link to specific epic
+
+# Team configuration
+team:
+  # Stakeholders and their roles
+  stakeholders:
+    - name: "<Product Owner>"
+      role: "PO"
+    - name: "<Team Lead>"
+      role: "DEV"
+  
+  # Active roles in this project
+  roles:
+    - BA
+    - FA
+    - SA
+    - DEV
+    - QA
+    - SM
+    - DES  # Optional: Designer role
+
+# Sprint configuration (if using Scrum)
+sprints:
+  # Sprint duration in weeks
+  length: 2
+  
+  # Current sprint number (auto-updated by SM)
+  current: 1
+
+# Optional: Project metadata
+metadata:
+  # Project start date
+  start_date: "<YYYY-MM-DD>"
+  
+  # Target completion date
+  target_date: "<YYYY-MM-DD>"
+  
+  # Project priority
+  priority: medium  # Options: low, medium, high, critical
+  
+  # Related projects (for cross-references)
+  related_projects: []

package/teamspec-core/templates/ri-template.md

@@ -0,0 +1,225 @@
+# Regression Impact: `ri-fi-{PRX}-{NNN}`
+
+<!--
+  ⚠️ REGRESSION IMPACT RECORD (REQUIRED AT DEPLOYMENT GATE)
+
+  This document records the regression test impact assessment for a Feature-Increment.
+
+  NAMING PATTERN: ri-fi-{PRX}-{NNN}.md
+  EXAMPLE: ri-fi-ACME-001.md
+
+  REQUIRED FIELDS (per registry.yml):
+  - fi_id: Reference to Feature-Increment
+  - assessment: 'update-required' | 'no-impact'
+  - rationale: Explanation of impact assessment
+  - regression_tests: List of rt-f-* files created/updated (if update-required)
+
+  TEAMSPEC RULES ENFORCED:
+  - TS-QA-003: Regression impact record required at deployment gate (BLOCKER)
+-->
+
+> **Template Version**: 4.0
+> **Last Updated**: 2026-01-11
+
+---
+
+**Document Owner:** QA (QA Engineer)
+**Artifact Type:** Regression Impact Record (Post-Deployment)
+**Lifecycle:** Created at deployment verification gate, referenced during Canon sync
+
+---
+
+## Required Fields (TS-QA-003)
+
+> ⚠️ **BLOCKER**: All fields below must be completed before deployment gate can pass.
+
+| Field | Value |
+| :--- | :--- |
+| **fi_id** | fi-{PRX}-{NNN} |
+| **assessment** | `update-required` / `no-impact` |
+| **rationale** | [Explanation of why this assessment was chosen] |
+| **regression_tests** | [List of rt-f-* files - REQUIRED if assessment = update-required] |
+
+---
+
+## Metadata
+
+| Field | Value |
+| :--- | :--- |
+| **RI ID** | ri-fi-{PRX}-{NNN} |
+| **Product** | {product-id} ({PRX}) |
+| **Project** | {project-id} |
+| **Created** | YYYY-MM-DD |
+| **Author** | [QA Name] |
+| **Feature Increment** | [fi-{PRX}-{NNN}](../feature-increments/fi-{PRX}-{NNN}-*.md) |
+| **Deployment Date** | YYYY-MM-DD |
+| **Verification Status** | ✅ Passed / ⚠️ Conditional / ❌ Failed |
+
+---
+
+## 1. Assessment Decision
+
+> ⚠️ **Select exactly ONE assessment type:**
+
+### [ ] Assessment: `update-required`
+
+**Rationale:** [Explain why regression test updates are needed]
+
+**Regression Tests Updated/Created:**
+
+| Regression Test | Target Feature | Action | Status |
+|-----------------|----------------|--------|--------|
+| [rt-f-{PRX}-{NNN}](../../products/{product-id}/qa/regression-tests/rt-f-{PRX}-{NNN}-*.md) | f-{PRX}-{NNN} | Created / Updated | ✅ Complete |
+
+### [ ] Assessment: `no-impact`
+
+**Rationale:** [Explain why no regression test updates are needed - REQUIRED]
+
+_Examples of valid rationales:_
+- _"This FI only affects internal refactoring with no user-observable behavior change"_
+- _"Existing regression tests rt-f-ACME-001 and rt-f-ACME-002 already cover this behavior"_
+- _"Feature toggle disabled in production; regression tests deferred until toggle enabled"_
+
+---
+
+## 2. Overview
+
+_High-level summary of what was deployed and any regression considerations._
+
+---
+
+## 3. Deployment Verification Summary
+
+### 3.1 What Was Deployed
+
+_Brief description of the Feature Increment deployed._
+
+### 3.2 Deployment Date/Time
+
+- **Deployment Date:** YYYY-MM-DD
+- **Deployment Time:** HH:MM UTC
+- **Environment:** Production
+- **Feature Toggles:** [Enabled/Disabled/N/A]
+
+---
+
+## 4. Regression Testing Results
+
+### 4.1 Test Coverage
+
+| Test Area | Test Cases | Passed | Failed | Notes |
+|-----------|------------|--------|--------|-------|
+| [Module 1] | [Count] | [✅] | [❌] | |
+| [Module 2] | [Count] | [✅] | [❌] | |
+
+### 4.2 Known Issues
+
+| Issue | Severity | Status | Workaround |
+|-------|----------|--------|-----------|
+| [Issue 1] | [P1/P2/P3] | [Open/Tracking] | [Workaround] |
+
+### 4.3 Affected Features
+
+| Feature | Impact | Verified? | Notes |
+|---------|--------|-----------|-------|
+| [f-PRX-XXX] | [Impact] | ✅/⚠️/❌ | [Details] |
+| [f-PRX-YYY] | [Impact] | ✅/⚠️/❌ | [Details] |
+
+---
+
+## 5. Behavior Changes
+
+### 5.1 User-Observable Changes
+
+_What end users might notice after this deployment._
+
+### 5.2 Performance Impact
+
+_Any performance characteristics affected by this deployment._
+
+### 5.3 Data Impact
+
+_Any data model or data characteristics changed by this deployment._
+
+---
+
+## 6. Canon Sync Readiness
+
+### 6.1 Feature Canon Updates Needed
+
+_What sections of Feature Canon need updates to reflect deployed changes._
+
+### 6.2 Breaking Changes
+
+_Any breaking changes for users or downstream systems._
+
+### 6.3 Deprecations
+
+_Any deprecated APIs or behaviors._
+
+---
+
+## 7. Rollback Considerations
+
+### 7.1 Rollback Risk Level
+
+- [ ] **Low** — Can rollback safely, no data implications
+- [ ] **Medium** — Rollback possible but with data considerations
+- [ ] **High** — Rollback difficult or impossible, has data implications
+
+### 7.2 Rollback Plan
+
+_If needed, how would we revert this deployment?_
+
+---
+
+## 8. Post-Deployment Monitoring
+
+### 8.1 Key Metrics to Monitor
+
+| Metric | Normal Range | Alert Threshold |
+|--------|--------------|-----------------|
+| [Metric 1] | [Range] | [Threshold] |
+| [Metric 2] | [Range] | [Threshold] |
+
+### 8.2 Support Notes
+
+_Any documentation or communications needed for support team._
+
+---
+
+## 9. Sign-Off
+
+| Role | Name | Status | Date |
+|------|------|--------|------|
+| QA (Author) | [Name] | ✅ | YYYY-MM-DD |
+| QA Lead | [Name] | ⏳ | |
+| SM (Gate Owner) | [Name] | ⏳ | |
+
+---
+
+## 10. Canon Sync Record
+
+_Completed after PO runs `ts:po sync`_
+
+| Field | Value |
+|-------|-------|
+| **Canon Sync Date** | YYYY-MM-DD |
+| **Synced By** | [PO Name] |
+| **Canon Sync Status** | ✅ Complete |
+
+---
+
+## Linter Rules Enforced
+
+| Rule | Description | Severity |
+|------|-------------|----------|
+| TS-QA-003 | Regression impact record required at deployment gate | BLOCKER |
+
+---
+
+## Change Log
+
+| Date | Author | Change |
+|------|--------|--------|
+| YYYY-MM-DD | @author | Initial assessment (post-deployment) |

package/teamspec-core/templates/rt-template.md

@@ -0,0 +1,104 @@
+# Regression Test: rt-f-{PRX}-{NNN}-{description}
+
+> **Product:** {product-id}  
+> **Feature:** [f-{PRX}-{NNN}-{name}](../features/f-{PRX}-{NNN}-{name}.md)  
+> **Owner:** QA  
+> **Created:** {YYYY-MM-DD}  
+> **Last Updated:** {YYYY-MM-DD}
+
+---
+
+## Overview
+
+Brief description of the regression test coverage for this feature.
+
+---
+
+## Feature Summary
+
+| Aspect | Value |
+|--------|-------|
+| Feature ID | f-{PRX}-{NNN} |
+| Feature Name | {Feature Name} |
+| Core Behavior | {One-line summary of what the feature does} |
+
+---
+
+## Regression Scenarios
+
+### Scenario 1: {Scenario Name}
+
+**Purpose:** {What this scenario validates}
+
+**Preconditions:**
+- {Precondition 1}
+- {Precondition 2}
+
+**Steps:**
+1. {Step 1}
+2. {Step 2}
+3. {Step 3}
+
+**Expected Result:**
+- {Expected outcome}
+
+**Criticality:** High | Medium | Low
+
+---
+
+### Scenario 2: {Scenario Name}
+
+**Purpose:** {What this scenario validates}
+
+**Preconditions:**
+- {Precondition 1}
+
+**Steps:**
+1. {Step 1}
+2. {Step 2}
+
+**Expected Result:**
+- {Expected outcome}
+
+**Criticality:** High | Medium | Low
+
+---
+
+## Edge Cases
+
+| Case | Input | Expected Behavior |
+|------|-------|-------------------|
+| {Edge case 1} | {Input} | {Behavior} |
+| {Edge case 2} | {Input} | {Behavior} |
+
+---
+
+## Integration Points
+
+| System/Feature | Integration Type | Regression Risk |
+|----------------|------------------|-----------------|
+| {Related feature} | {API/Data/UI} | High | Medium | Low |
+
+---
+
+## Automation Status
+
+| Scenario | Automated | Test ID | Notes |
+|----------|-----------|---------|-------|
+| Scenario 1 | Yes / No / Partial | {test-id} | {Notes} |
+| Scenario 2 | Yes / No / Partial | {test-id} | {Notes} |
+
+---
+
+## Change History
+
+| Date | FI Reference | Change | Author |
+|------|--------------|--------|--------|
+| {YYYY-MM-DD} | fi-{PRX}-{NNN} | Initial creation | {name} |
+
+---
+
+## Related
+
+- Feature: [f-{PRX}-{NNN}](../features/f-{PRX}-{NNN}-{name}.md)
+- Product: [product.yml](../product.yml)

package/teamspec-core/templates/sd-template.md

@@ -0,0 +1,132 @@
+# Solution Design: `<sd-PRX-XXX-description>`
+
+> **ID:** sd-PRX-XXX  
+> **Product:** `<product-id>` (PRX)  
+> **Target Feature:** `<f-PRX-XXX-feature-name>`  
+> **Status:** draft | proposed | approved | implemented
+
+---
+
+**Document Owner:** SA (Solution Architect)  
+**Artifact Type:** Solution Design (Canonical)  
+**Lifecycle:** Permanent, versioned
+
+---
+
+## Metadata
+
+| Field | Value |
+| :--- | :--- |
+| **SD ID** | sd-{PRX}-{NNN} |
+| **Status** | Proposed / Accepted / Deprecated / Superseded |
+| **Date** | YYYY-MM-DD |
+| **Author** | [SA Name] |
+| **Related Feature** | [f-{PRX}-{NNN}](../features/f-{PRX}-{NNN}-*.md) |
+| **Related TA** | [ta-{PRX}-{NNN}](../technical-architecture/ta-{PRX}-{NNN}-*.md) (if applicable) |
+
+---
+
+## 1. Overview
+
+_Brief description of the solution design and what it accomplishes._
+
+---
+
+## 2. Business Context
+
+> Reference to Feature Canon and business requirements that drove this design.
+
+_What business need or requirement triggered this design?_
+
+---
+
+## 3. Solution Architecture
+
+### 3.1 Components
+
+| Component | Purpose | Technology |
+|-----------|---------|-----------|
+| [Component A] | [Purpose] | [Tech Stack] |
+| [Component B] | [Purpose] | [Tech Stack] |
+
+### 3.2 Data Model
+
+_ERD or conceptual data model showing entities and relationships._
+
+### 3.3 Integration Points
+
+_How this solution integrates with existing systems._
+
+---
+
+## 4. Design Rationale
+
+### 4.1 Why This Design?
+
+_Explain the reasoning behind design decisions._
+
+### 4.2 Alternatives Considered
+
+_What other approaches were evaluated and why they were rejected._
+
+---
+
+## 5. Trade-offs and Constraints
+
+| Trade-off | Impact | Mitigation |
+|-----------|--------|-----------|
+| [Trade-off 1] | [Impact] | [How we handle it] |
+| [Trade-off 2] | [Impact] | [How we handle it] |
+
+---
+
+## 6. Behavior Impact Assessment
+
+> ⚠️ Does this design affect user-observable behavior?
+
+### 6.1 User-Facing Changes
+
+_What users will observe as a result of this design._
+
+### 6.2 Feature Canon Updates Needed
+
+_What sections of Feature Canon need updates to reflect this design._
+
+---
+
+## 7. Implementation Notes
+
+### 7.1 Development Guidelines
+
+_Key implementation guidance for the development team._
+
+### 7.2 Testing Strategy
+
+_How the design will be validated._
+
+---
+
+## 8. Related Documents
+
+| Document | Purpose |
+|----------|---------|
+| [f-{PRX}-{NNN}](../features/f-{PRX}-{NNN}-*.md) | Feature Canon |
+| [ta-{PRX}-{NNN}](../technical-architecture/ta-{PRX}-{NNN}-*.md) | Technical Architecture (if applicable) |
+
+---
+
+## Review & Approval
+
+| Role | Name | Status | Date |
+|------|------|--------|------|
+| SA (Author) | [Name] | ✅ | YYYY-MM-DD |
+| FA | [Name] | ⏳ | |
+| Tech Lead | [Name] | ⏳ | |
+
+---
+
+## Change Log
+
+| Date | Author | Change |
+|------|--------|--------|
+| YYYY-MM-DD | @author | Initial draft |

package/teamspec-core/templates/sdi-template.md

@@ -0,0 +1,119 @@
+# Solution Design Increment: `<sdi-PRX-XXX-description>`
+
+> **ID:** sdi-PRX-XXX  
+> **Product:** `<product-id>` (PRX)  
+> **Project:** `<project-id>`  
+> **Target SD Feature:** `<sd-PRX-XXX-name>`  
+> **Target Feature:** `<f-PRX-XXX-feature-name>`  
+> **Status:** draft | proposed | approved | implemented | synced
+
+---
+
+**Document Owner:** SA (Solution Architect)  
+**Artifact Type:** Solution Design Increment (Project)  
+**Lifecycle:** Project-scoped, merged to Product SD after approval
+
+---
+
+## Metadata
+
+| Field | Value |
+| :--- | :--- |
+| **SDI ID** | sdi-PRX-XXX |
+| **Status** | Proposed / Accepted / Implemented / Synced |
+| **Date** | YYYY-MM-DD |
+| **Author** | [SA Name] |
+| **Target SD** | [sd-PRX-XXX](../../products/PRX/solution-designs/sd-PRX-XXX-*.md) |
+| **Feature Increment** | [fi-PRX-XXX](../feature-increments/fi-PRX-XXX-*.md) |
+
+---
+
+## 1. Overview
+
+_Brief description of the solution design increment specific to this project._
+
+---
+
+## 2. AS-IS (Current Product SD)
+
+> _Auto-populated from Product Solution Design. DO NOT EDIT unless correcting errors._
+
+_Copy relevant sections from the Product SD._
+
+---
+
+## 3. TO-BE (Project Solution Design)
+
+### 3.1 New/Changed Design Elements
+
+_Describe what the project-specific solution design includes that product design doesn't._
+
+### 3.2 Design Specifications
+
+_Detailed specifications for this increment._
+
+### 3.3 Out of Scope
+
+_Explicitly state what this increment does NOT include._
+
+---
+
+## 4. Impact Analysis
+
+### 4.1 Feature Implications
+
+| Feature | Impact Type | Description |
+|---------|-------------|-------------|
+| [f-PRX-XXX] | Modified | _What design changes affect this feature_ |
+
+### 4.2 Technical Architecture Dependencies
+
+_Links to required Technical Architecture (TA) documents._
+
+### 4.3 Implementation Constraints
+
+_Design constraints that affect DEV work._
+
+---
+
+## 5. Behavior Impact Assessment
+
+> ⚠️ Does this SDI affect user-observable behavior?
+
+### 5.1 Changes to Feature Behavior
+
+_What behavior changes result from this design._
+
+### 5.2 Feature Canon Updates
+
+_What sections of Feature Canon need updates based on this SDI._
+
+---
+
+## 6. Integration Notes
+
+### 6.1 Product SD Alignment
+
+_How this project SDI aligns with or extends the product SD._
+
+### 6.2 Merge Strategy
+
+_How this SDI will be merged back to Product SD after project completion._
+
+---
+
+## 7. Review & Approval
+
+| Role | Name | Status | Date |
+|------|------|--------|------|
+| SA (Author) | [Name] | ✅ | YYYY-MM-DD |
+| FA | [Name] | ⏳ | |
+| Tech Lead | [Name] | ⏳ | |
+
+---
+
+## Change Log
+
+| Date | Author | Change |
+|------|--------|--------|
+| YYYY-MM-DD | @author | Initial draft |