ai-workflow-init 6.4.2 → 6.6.0

package/docs/ai/planning/epic-template.md

@@ -0,0 +1,155 @@
+# Epic: {Epic Name}
+
+Note: All content in this document must be written in English.
+
+---
+beads_epic: {bd-xxx or null}
+requirement: {docs/ai/requirements/req-xxx.md or null}
+---
+
+## 1. Overview
+
+### Problem Statement
+[Brief description of the problem this epic solves]
+
+### Goals
+- [Primary goal]
+- [Secondary goal]
+
+### Success Metrics
+- [How we measure success]
+
+---
+
+## 2. Architecture
+
+> **Note**: High-level architecture overview. Detailed implementation goes in task-level plans.
+
+### System Diagram
+```
+┌─────────────┐     ┌─────────────┐     ┌─────────────┐
+│  Component  │────▶│  Component  │────▶│  Component  │
+└─────────────┘     └─────────────┘     └─────────────┘
+```
+
+### Key Components
+| Component | Responsibility | Location |
+|-----------|----------------|----------|
+| {Name} | {What it does} | {path/to/} |
+
+### Technology Decisions
+| Decision | Choice | Rationale |
+|----------|--------|-----------|
+| {Area} | {Technology} | {Why this choice} |
+
+---
+
+## 3. Task Breakdown
+
+> **Note**: If using Beads, this table syncs with Beads via `bd` commands. If not using Beads, manage tasks manually.
+
+| # | Task | Priority | Status | Blocked By | Plan Doc |
+|---|------|----------|--------|------------|----------|
+| 1 | {Task title} | P{0-4} | {open/in_progress/closed} | {dependencies or -} | {feature-xxx.md or -} |
+| 2 | {Task title} | P{0-4} | {status} | Task 1 | {-} |
+
+<!-- If using Beads, replace # with Task ID (e.g., bd-xxx.1) -->
+
+### Dependency Graph
+```
+Task 1 ──────────────────────┐
+                             ▼
+Task 3 ───▶ Task 2 ───▶ Task 4
+```
+
+<!-- If using Beads, replace Task # with bd-xxx.# -->
+
+---
+
+## 4. Data Flow
+
+### Primary Flow: {Flow Name}
+1. [Step 1]: {description}
+2. [Step 2]: {description}
+3. [Step 3]: {description}
+
+### Alternative Flow: {Flow Name} (Optional)
+1. [Step 1]: {description}
+
+### Error Handling
+- {Error case}: {How it's handled}
+
+---
+
+## 5. API Contracts (Optional)
+
+> **Note**: Include if epic involves API changes. Keep high-level; details in task plans.
+
+### Endpoints Overview
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| POST | /api/v1/{resource} | {What it does} |
+| GET | /api/v1/{resource}/:id | {What it does} |
+
+### Key Data Models
+```
+{ModelName}:
+  - field1: type
+  - field2: type
+```
+
+---
+
+## 6. Key Decisions & Trade-offs
+
+| Decision | Options Considered | Choice | Trade-off |
+|----------|-------------------|--------|-----------|
+| {Decision area} | {Option A, Option B} | {Chosen} | {What we gain/lose} |
+
+---
+
+## 7. Risks & Mitigations
+
+| Risk | Impact | Probability | Mitigation |
+|------|--------|-------------|------------|
+| {Risk description} | High/Medium/Low | High/Medium/Low | {How to mitigate} |
+
+---
+
+## 8. Dependencies
+
+### External
+- {External service/API}: {What we need from it}
+
+### Internal
+- {Internal service/team}: {What we need from it}
+
+### Blockers
+- [ ] {Blocker that must be resolved before starting}
+
+---
+
+## 9. Milestones (Optional)
+
+> **Note**: Focus on task groupings and sequence, not time estimates.
+
+| Milestone | Tasks | Description |
+|-----------|-------|-------------|
+| {Milestone 1} | Task 1, Task 2 | {What this milestone delivers} |
+| {Milestone 2} | Task 3, Task 4 | {What this milestone delivers} |
+
+---
+
+## 10. References
+
+- **Requirement Doc**: [req-{name}.md](../requirements/req-{name}.md)
+- **Related Epics**: {links to related epic plans}
+- **External Docs**: {links to external resources}
+
+---
+
+## Changelog
+
+| Date | Author | Change |
+|------|--------|--------|
+| {YYYY-MM-DD} | {name} | Initial epic plan created |

package/docs/ai/planning/feature-template.md

@@ -2,6 +2,25 @@
 
 Note: All content in this document must be written in English.
 
+---
+beads_task: {bd-xxx.n or null}
+beads_epic: {bd-xxx or null}
+epic_plan: {docs/ai/planning/epic-xxx.md or null}
+---
+
+## 0. Beads Context (Optional)
+
+> **Note**: This section is auto-generated when plan is created via `/beads-next` → `/create-plan` workflow. Delete if not using Beads.
+
+- **Epic**: {epic-id} "{Epic Title}"
+- **Task**: {task-id} "{Task Title}"
+- **Epic Plan**: [epic-{name}.md](epic-{name}.md)
+- **Status**: in_progress
+- **Blocked by**: {list or "none"}
+- **Blocks**: {list of dependent tasks or "none"}
+
+---
+
 ## 0. Requirements Reference (Optional)
 
 - **Requirement Doc**: [req-{feature-name}.md](../requirements/req-{feature-name}.md)

package/docs/ai/requirements/req-template.md

@@ -1,45 +1,69 @@
 # Requirement: {Feature Name}
 
+> Generated: {YYYY-MM-DD}
+> Status: Draft | Review | Approved
+> Complexity: Low | Medium | High
+
 Note: All content in this document must be written in English.
 
 ---
 
-## 1. Problem Statement
+## Quick Links
+
+| Document | Status |
+|----------|--------|
+| [BA Analysis](agents/ba-{name}.md) | ✅ Complete / ⏭️ Skipped |
+| [SA Assessment](agents/sa-{name}.md) | ✅ Complete / ⏭️ Skipped |
+| [Domain Research](agents/research-{name}.md) | ✅ Complete / ⏭️ Skipped |
+| [UI/UX Design](agents/uiux-{name}.md) | ✅ Complete / ⏭️ Skipped |
+
+---
+
+## 1. Executive Summary
+
+{3-5 sentences covering: what is being built, why it matters, and how it will be approached}
+
+---
+
+## 2. Problem Statement
 
 ### Context
-[Business/technical context that led to this requirement]
+{Business/technical context that led to this requirement}
 
 ### Problem
-[The specific problem to be solved]
+{The specific problem to be solved}
 
 ### Impact
-[Consequences if not addressed - business value, user pain points]
+{Consequences if not addressed - business value, user pain points}
 
 ---
 
-## 2. User Stories (Optional)
+## 3. Users & User Stories
 
-- As a [role], I want [action], so that [benefit]
-- As a [role], I want [action], so that [benefit]
+### Target Users
 
----
+| User Type | Description | Primary Goals |
+|-----------|-------------|---------------|
+| {User 1} | {Who they are} | {What they want to achieve} |
 
-## 3. Business Rules (Optional)
+### User Stories
 
-| ID | Rule | Description |
-|----|------|-------------|
-| BR-01 | {Rule Name} | {Detailed description} |
-| BR-02 | {Rule Name} | {Detailed description} |
+| ID | Priority | As a... | I want to... | So that... |
+|----|----------|---------|--------------|------------|
+| US-01 | Must | {user} | {action} | {benefit} |
+| US-02 | Must | {user} | {action} | {benefit} |
+| US-03 | Should | {user} | {action} | {benefit} |
 
 ---
 
 ## 4. Functional Requirements
 
-| ID | Requirement | Priority | Notes |
-|----|-------------|----------|-------|
-| FR-01 | {Description} | Must | |
-| FR-02 | {Description} | Should | |
-| FR-03 | {Description} | Could | |
+| ID | Requirement | Priority | Acceptance Criteria |
+|----|-------------|----------|---------------------|
+| FR-01 | {Description} | Must | {How to verify} |
+| FR-02 | {Description} | Must | {How to verify} |
+| FR-03 | {Description} | Should | {How to verify} |
+| FR-04 | {Description} | Could | {How to verify} |
 
 **Priority Legend:**
 - **Must**: Critical for release
@@ -48,26 +72,96 @@ Note: All content in this document must be written in English.
 
 ---
 
-## 5. Non-Functional Requirements (Optional)
+## 5. Business Rules
+
+| ID | Rule | Condition | Action |
+|----|------|-----------|--------|
+| BR-01 | {Rule Name} | When {condition} | Then {action} |
+| BR-02 | {Rule Name} | When {condition} | Then {action} |
+
+---
+
+## 6. Technical Assessment
+
+### Feasibility Summary
+
+| Aspect | Status | Notes |
+|--------|--------|-------|
+| Overall | ✅ Feasible / ⚠️ Conditional / ❌ Issues | {Summary} |
+| Frontend | 🟢 Low / 🟡 Medium / 🔴 High | {Complexity notes} |
+| Backend | 🟢 Low / 🟡 Medium / 🔴 High | {Complexity notes} |
+| Data | 🟢 Low / 🟡 Medium / 🔴 High | {Complexity notes} |
+
+### Recommended Architecture
+
+{Brief description of recommended approach}
+
+### Technology Stack
+
+| Layer | Technology | Reason |
+|-------|------------|--------|
+| {Layer} | {Tech} | {Why} |
+
+### Technical Risks
+
+| ID | Risk | Impact | Likelihood | Mitigation |
+|----|------|--------|------------|------------|
+| TR-01 | {Risk} | High/Med/Low | High/Med/Low | {Mitigation} |
+
+---
+
+## 7. UI/UX Design (if applicable)
+
+### Screen Inventory
+
+| # | Screen | Purpose | Priority |
+|---|--------|---------|----------|
+| 1 | {Screen name} | {Purpose} | Must |
+
+### Key User Flows
+
+{Flow diagram or description}
+
+### Wireframe Reference
+
+See: [UI/UX Design Document](agents/uiux-{name}.md)
+
+---
+
+## 8. Domain Context (if applicable)
+
+### Glossary
+
+| Term | Definition |
+|------|------------|
+| {Term} | {Clear definition in project context} |
+
+### Compliance & Standards
+
+| Standard | Applicability |
+|----------|---------------|
+| {Standard name} | {How it applies} |
+
+---
+
+## 9. Non-Functional Requirements (Optional)
 
 | Category | Requirement |
 |----------|-------------|
-| **Performance** | {e.g., Response time < 200ms, support 1000 concurrent users} |
-| **Security** | {e.g., Authentication required, data encryption} |
-| **Compatibility** | {e.g., Chrome 90+, Safari 14+, mobile responsive} |
+| **Performance** | {e.g., Response time < 200ms} |
+| **Security** | {e.g., Authentication required} |
+| **Compatibility** | {e.g., Chrome 90+, mobile responsive} |
 | **Accessibility** | {e.g., WCAG 2.1 AA compliance} |
-| **Scalability** | {e.g., Handle 10x traffic growth} |
 
 ---
 
-## 6. Edge Cases & Constraints (Optional)
+## 10. Edge Cases & Constraints
 
 ### Edge Cases
 
 | Case | Expected Behavior |
 |------|-------------------|
 | {Edge case description} | {How system should handle it} |
-| {Edge case description} | {How system should handle it} |
 
 ### Constraints
 
@@ -77,61 +171,73 @@ Note: All content in this document must be written in English.
 
 ---
 
-## 7. Clarifications Log (Optional)
+## 11. Out of Scope
 
-> Questions resolved during requirement gathering sessions
+> Explicitly excluded from this requirement
 
-| # | Question | Answer |
-|---|----------|--------|
-| 1 | {Question asked} | {Answer received} |
-| 2 | {Question asked} | {Answer received} |
+- {Feature/functionality not included}
+- {Deferred to future iteration}
 
 ---
 
-## 8. Out of Scope (Optional)
+## 12. Open Questions
 
-> Explicitly excluded from this requirement
-
-- {Feature/functionality not included}
-- {Deferred to future iteration}
-- {Related but separate concern}
+| ID | Question | Owner | Status |
+|----|----------|-------|--------|
+| Q-01 | {Unresolved question} | {Who decides} | Open |
 
 ---
 
-## 9. Acceptance Criteria
+## 13. Acceptance Criteria
 
 ### Scenario 1: {Happy Path - Main Flow}
 
-- **Given** [initial context/state]
-- **When** [action performed]
-- **Then** [expected outcome]
+- **Given** {initial context/state}
+- **When** {action performed}
+- **Then** {expected outcome}
 
-### Scenario 2: {Alternative Flow} (Optional)
+### Scenario 2: {Alternative Flow}
 
-- **Given** [context]
-- **When** [action]
-- **Then** [outcome]
+- **Given** {context}
+- **When** {action}
+- **Then** {outcome}
 
-### Scenario 3: {Error Handling} (Optional)
+### Scenario 3: {Error Handling}
 
-- **Given** [context]
-- **When** [invalid action/error condition]
-- **Then** [error handling behavior]
+- **Given** {context}
+- **When** {invalid action/error condition}
+- **Then** {error handling behavior}
 
 ---
 
-## 10. References (Optional)
+## 14. Implementation Guidance
+
+### Suggested Phases
 
-- **Related Docs**: [links to related requirements, designs, etc.]
-- **External Links**: [Jira tickets, Figma, API docs, etc.]
+| Phase | Focus | Priority |
+|-------|-------|----------|
+| 1 | {Foundation} | High |
+| 2 | {Core features} | High |
+| 3 | {Enhancement} | Medium |
+
+### Dependencies
+
+| Dependency | Type | Status |
+|------------|------|--------|
+| {Dependency} | Internal/External | Available/Pending |
 
 ---
 
-## 11. Glossary (Optional)
+## 15. References
 
-> Domain-specific terms and definitions. Include only if specialized terminology is used.
+- **Related Docs**: {links to related requirements, designs}
+- **External Links**: {Jira tickets, Figma, API docs}
+- **Agent Outputs**: See Quick Links section
 
-| Term | Definition |
-|------|------------|
-| {Term 1} | {Clear definition in project context} |
-| {Term 2} | {Clear definition in project context} |
+---
+
+## Next Steps
+
+1. [ ] Review this requirement document
+2. [ ] Address open questions
+3. [ ] Run `/create-plan` to generate implementation plan

package/docs/ai/requirements/templates/ba-template.md

@@ -0,0 +1,151 @@
+# Business Analysis: {Feature Name}
+
+> Generated by BA Agent | Date: {YYYY-MM-DD}
+
+---
+
+## 1. Executive Summary
+
+{2-3 sentence summary of what is being built and why}
+
+---
+
+## 2. Problem Statement
+
+### Current Situation
+{Describe the current state or pain points}
+
+### Desired Outcome
+{What success looks like}
+
+---
+
+## 3. Users & Stakeholders
+
+### Primary Users
+
+| User Type | Description | Goals |
+|-----------|-------------|-------|
+| {User 1} | {Who they are} | {What they want to achieve} |
+| {User 2} | {Who they are} | {What they want to achieve} |
+
+### Secondary Users
+- {User type and role}
+
+### Stakeholders
+- {Stakeholder and their interest}
+
+---
+
+## 4. User Stories
+
+### Must-Have (P0)
+
+| ID | As a... | I want to... | So that... |
+|----|---------|--------------|------------|
+| US-01 | {user} | {action} | {benefit} |
+| US-02 | {user} | {action} | {benefit} |
+
+### Should-Have (P1)
+
+| ID | As a... | I want to... | So that... |
+|----|---------|--------------|------------|
+| US-03 | {user} | {action} | {benefit} |
+
+### Nice-to-Have (P2)
+
+| ID | As a... | I want to... | So that... |
+|----|---------|--------------|------------|
+| US-04 | {user} | {action} | {benefit} |
+
+---
+
+## 5. Functional Requirements
+
+### Core Requirements
+
+| ID | Requirement | Priority | Acceptance Criteria |
+|----|-------------|----------|---------------------|
+| FR-01 | {Clear, testable requirement} | Must | {How to verify} |
+| FR-02 | {Clear, testable requirement} | Must | {How to verify} |
+| FR-03 | {Clear, testable requirement} | Should | {How to verify} |
+
+### Data Requirements
+
+| ID | Requirement | Details |
+|----|-------------|---------|
+| DR-01 | {Data requirement} | {Specifics} |
+
+---
+
+## 6. Business Rules
+
+| ID | Rule | Condition | Action |
+|----|------|-----------|--------|
+| BR-01 | {Rule name} | When {condition} | Then {action} |
+| BR-02 | {Rule name} | When {condition} | Then {action} |
+
+---
+
+## 7. Assumptions & Dependencies
+
+### Assumptions
+
+| ID | Assumption | Impact if Wrong |
+|----|------------|-----------------|
+| A-01 | {What we assume} | {Consequence} |
+
+### Dependencies
+
+| ID | Dependency | Type | Status |
+|----|------------|------|--------|
+| D-01 | {External/internal dependency} | External/Internal | Available/Pending |
+
+---
+
+## 8. Out of Scope
+
+The following items are explicitly **NOT** included in this requirement:
+
+- {Excluded item 1}
+- {Excluded item 2}
+- {Excluded item 3}
+
+---
+
+## 9. Open Questions
+
+| ID | Question | Owner | Due Date | Status |
+|----|----------|-------|----------|--------|
+| Q-01 | {Unresolved question} | {Who decides} | {When} | Open |
+
+---
+
+## 10. Q&A Log
+
+### Round 1: {Topic}
+
+| # | Question | Answer |
+|---|----------|--------|
+| 1 | {Question asked} | {User's answer} |
+| 2 | {Question asked} | {User's answer} |
+
+### Round 2: {Topic}
+
+| # | Question | Answer |
+|---|----------|--------|
+| 3 | {Question asked} | {User's answer} |
+
+---
+
+## Appendix
+
+### Glossary
+{If domain terms were collected}
+
+| Term | Definition |
+|------|------------|
+| {Term} | {Definition} |
+
+### References
+- {Link to related documents}