@comfanion/workflow 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +185 -0
- package/bin/cli.js +406 -0
- package/package.json +50 -0
- package/src/build-info.json +16 -0
- package/src/opencode/ARCHITECTURE.md +255 -0
- package/src/opencode/FLOW.yaml +900 -0
- package/src/opencode/agents/analyst.md +141 -0
- package/src/opencode/agents/architect.md +177 -0
- package/src/opencode/agents/change-manager.md +263 -0
- package/src/opencode/agents/dev.md +171 -0
- package/src/opencode/agents/module-docs.md +628 -0
- package/src/opencode/agents/pm.md +157 -0
- package/src/opencode/agents/researcher.md +254 -0
- package/src/opencode/agents/sm.md +184 -0
- package/src/opencode/agents/workflow-orchestrator.md +249 -0
- package/src/opencode/checklists/architecture-checklist.md +166 -0
- package/src/opencode/checklists/code-review-checklist.md +151 -0
- package/src/opencode/checklists/prd-checklist.md +140 -0
- package/src/opencode/checklists/requirements-checklist.md +86 -0
- package/src/opencode/checklists/story-checklist.md +137 -0
- package/src/opencode/commands/architecture.md +68 -0
- package/src/opencode/commands/archive.md +146 -0
- package/src/opencode/commands/change.md +169 -0
- package/src/opencode/commands/clarify.md +132 -0
- package/src/opencode/commands/code-review.md +96 -0
- package/src/opencode/commands/coding-standards.md +102 -0
- package/src/opencode/commands/dev-story.md +80 -0
- package/src/opencode/commands/diagram.md +152 -0
- package/src/opencode/commands/epics.md +52 -0
- package/src/opencode/commands/help.md +139 -0
- package/src/opencode/commands/jira-sync.md +58 -0
- package/src/opencode/commands/module-docs.md +158 -0
- package/src/opencode/commands/prd.md +63 -0
- package/src/opencode/commands/quick.md +166 -0
- package/src/opencode/commands/requirements.md +49 -0
- package/src/opencode/commands/research.md +113 -0
- package/src/opencode/commands/sprint-plan.md +59 -0
- package/src/opencode/commands/stories.md +61 -0
- package/src/opencode/commands/validate.md +84 -0
- package/src/opencode/commands/workflow-status.md +150 -0
- package/src/opencode/config.yaml +223 -0
- package/src/opencode/opencode.json +36 -0
- package/src/opencode/skills/acceptance-criteria/SKILL.md +212 -0
- package/src/opencode/skills/adr-writing/SKILL.md +241 -0
- package/src/opencode/skills/architecture-design/SKILL.md +183 -0
- package/src/opencode/skills/architecture-validation/SKILL.md +199 -0
- package/src/opencode/skills/archiving/SKILL.md +191 -0
- package/src/opencode/skills/changelog/SKILL.md +280 -0
- package/src/opencode/skills/code-review/SKILL.md +193 -0
- package/src/opencode/skills/coding-standards/SKILL.md +430 -0
- package/src/opencode/skills/diagram-creation/SKILL.md +273 -0
- package/src/opencode/skills/doc-todo/SKILL.md +325 -0
- package/src/opencode/skills/epic-writing/SKILL.md +291 -0
- package/src/opencode/skills/jira-integration/SKILL.md +560 -0
- package/src/opencode/skills/methodologies/SKILL.md +376 -0
- package/src/opencode/skills/module-documentation/SKILL.md +214 -0
- package/src/opencode/skills/prd-validation/SKILL.md +164 -0
- package/src/opencode/skills/prd-writing/SKILL.md +104 -0
- package/src/opencode/skills/requirements-gathering/SKILL.md +132 -0
- package/src/opencode/skills/requirements-validation/SKILL.md +141 -0
- package/src/opencode/skills/research-methodology/SKILL.md +140 -0
- package/src/opencode/skills/sprint-planning/SKILL.md +217 -0
- package/src/opencode/skills/story-writing/SKILL.md +574 -0
- package/src/opencode/skills/test-design/SKILL.md +313 -0
- package/src/opencode/skills/translation/SKILL.md +411 -0
- package/src/opencode/templates/CHANGELOG.md +82 -0
- package/src/opencode/templates/adr-template.md +115 -0
- package/src/opencode/templates/architecture-template.md +362 -0
- package/src/opencode/templates/change-proposal-template.md +186 -0
- package/src/opencode/templates/epic-template.md +151 -0
- package/src/opencode/templates/git-workflow-template.md +384 -0
- package/src/opencode/templates/integration-tests-template.md +265 -0
- package/src/opencode/templates/jira-cache-template.yaml +103 -0
- package/src/opencode/templates/module-index-template.md +139 -0
- package/src/opencode/templates/module-test-cases-template.md +230 -0
- package/src/opencode/templates/prd-acceptance-criteria-template.md +124 -0
- package/src/opencode/templates/prd-template.md +479 -0
- package/src/opencode/templates/requirements-template.md +132 -0
- package/src/opencode/templates/sprint-status-template.yaml +84 -0
- package/src/opencode/templates/story-template.md +437 -0
- package/src/opencode/templates/testing-standards-template.md +359 -0
- package/src/opencode/workflows/dev-story/instructions.md +529 -0
- package/src/repo-structure/.gitattributes +64 -0
- package/src/repo-structure/CONTRIBUTING.md +182 -0
- package/src/repo-structure/README.md +77 -0
- package/src/repo-structure/docs/README.md +62 -0
- package/src/repo-structure/docs/api/README.md +43 -0
- package/src/repo-structure/docs/architecture/README.md +36 -0
- package/src/repo-structure/docs/architecture/adr/README.md +53 -0
- package/src/repo-structure/docs/architecture/diagrams/README.md +59 -0
- package/src/repo-structure/docs/coding-standards/README.md +52 -0
- package/src/repo-structure/docs/confluence/README.md +43 -0
- package/src/repo-structure/docs/requirements/README.md +28 -0
- package/src/repo-structure/docs/sprint-artifacts/README.md +76 -0
- package/src/repo-structure/docs/sprint-artifacts/backlog/README.md +24 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Structured clarification of requirements before creating PRD/Architecture
|
|
3
|
+
agent: requirements-analyst
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Clarify Command
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Run **before** `/prd` or `/architecture` to reduce rework. Asks structured questions to uncover gaps, ambiguities, and missing details in requirements.
|
|
11
|
+
|
|
12
|
+
## Arguments
|
|
13
|
+
$ARGUMENTS
|
|
14
|
+
|
|
15
|
+
- Empty: Clarify requirements.md
|
|
16
|
+
- "[topic]": Focus clarification on specific topic
|
|
17
|
+
- "all": Comprehensive clarification
|
|
18
|
+
|
|
19
|
+
## Prerequisites
|
|
20
|
+
|
|
21
|
+
!`ls -la docs/requirements/requirements.md 2>/dev/null && echo "EXISTS" || echo "MISSING"`
|
|
22
|
+
|
|
23
|
+
If requirements.md doesn't exist:
|
|
24
|
+
→ "Run `/requirements` first to gather requirements."
|
|
25
|
+
|
|
26
|
+
## Load Requirements
|
|
27
|
+
|
|
28
|
+
@docs/requirements/requirements.md
|
|
29
|
+
|
|
30
|
+
## Clarification Process
|
|
31
|
+
|
|
32
|
+
### 1. Scan for Ambiguities
|
|
33
|
+
|
|
34
|
+
Look for:
|
|
35
|
+
- Vague terms ("should", "might", "could", "etc.")
|
|
36
|
+
- Missing quantities ("fast", "many", "several")
|
|
37
|
+
- Undefined actors ("users", "admins" - who exactly?)
|
|
38
|
+
- Missing edge cases
|
|
39
|
+
- Unclear priorities
|
|
40
|
+
- Undefined terms
|
|
41
|
+
|
|
42
|
+
### 2. Generate Structured Questions
|
|
43
|
+
|
|
44
|
+
Organize questions by category:
|
|
45
|
+
|
|
46
|
+
```markdown
|
|
47
|
+
## Clarification Questions
|
|
48
|
+
|
|
49
|
+
### Functional Gaps
|
|
50
|
+
|
|
51
|
+
1. **FR-003: User Authentication**
|
|
52
|
+
- Q: What happens if login fails 3 times?
|
|
53
|
+
- Q: Is there a password reset flow?
|
|
54
|
+
- Q: What are the password requirements?
|
|
55
|
+
|
|
56
|
+
2. **FR-007: Data Export**
|
|
57
|
+
- Q: What formats are required (CSV, JSON, Excel)?
|
|
58
|
+
- Q: Is there a size limit?
|
|
59
|
+
|
|
60
|
+
### Non-Functional Gaps
|
|
61
|
+
|
|
62
|
+
1. **NFR-001: Performance**
|
|
63
|
+
- Q: "Fast response" - what is acceptable latency? (p50, p95, p99)
|
|
64
|
+
- Q: Under what load conditions?
|
|
65
|
+
|
|
66
|
+
2. **NFR-003: Availability**
|
|
67
|
+
- Q: "High availability" - what is the target uptime? (99%, 99.9%, 99.99%)
|
|
68
|
+
|
|
69
|
+
### Edge Cases
|
|
70
|
+
|
|
71
|
+
1. What happens when [edge case]?
|
|
72
|
+
2. How should the system handle [error condition]?
|
|
73
|
+
|
|
74
|
+
### User Clarifications
|
|
75
|
+
|
|
76
|
+
1. "Users" - Is this end-users, admins, or both?
|
|
77
|
+
2. What are the user personas?
|
|
78
|
+
|
|
79
|
+
### Scope Clarifications
|
|
80
|
+
|
|
81
|
+
1. Is [feature] in scope for MVP?
|
|
82
|
+
2. What is explicitly out of scope?
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### 3. Conduct Q&A Session
|
|
86
|
+
|
|
87
|
+
For each question:
|
|
88
|
+
1. Ask the user
|
|
89
|
+
2. Record the answer
|
|
90
|
+
3. Update requirements.md with clarification
|
|
91
|
+
|
|
92
|
+
### 4. Document Clarifications
|
|
93
|
+
|
|
94
|
+
Add a Clarifications section to requirements.md:
|
|
95
|
+
|
|
96
|
+
```markdown
|
|
97
|
+
## Clarifications
|
|
98
|
+
|
|
99
|
+
### Session: YYYY-MM-DD
|
|
100
|
+
|
|
101
|
+
**Q1: What happens if login fails 3 times?**
|
|
102
|
+
A: Account is locked for 15 minutes. User receives email notification.
|
|
103
|
+
→ Added to FR-003 acceptance criteria.
|
|
104
|
+
|
|
105
|
+
**Q2: What is acceptable response latency?**
|
|
106
|
+
A: < 200ms p95 for API calls, < 2s for page loads.
|
|
107
|
+
→ Updated NFR-001 with specific metrics.
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Output
|
|
111
|
+
|
|
112
|
+
After clarification:
|
|
113
|
+
1. Updated requirements.md with answers
|
|
114
|
+
2. Clarifications section added
|
|
115
|
+
3. Ambiguous terms resolved
|
|
116
|
+
4. Missing acceptance criteria added
|
|
117
|
+
|
|
118
|
+
## Validation
|
|
119
|
+
|
|
120
|
+
After clarification, verify:
|
|
121
|
+
- [ ] No vague language remains
|
|
122
|
+
- [ ] All quantities are specified
|
|
123
|
+
- [ ] Edge cases documented
|
|
124
|
+
- [ ] Actors clearly defined
|
|
125
|
+
- [ ] Priorities assigned
|
|
126
|
+
- [ ] Scope boundaries clear
|
|
127
|
+
|
|
128
|
+
## After Clarification
|
|
129
|
+
|
|
130
|
+
Suggest:
|
|
131
|
+
- `/validate requirements` - Validate completeness
|
|
132
|
+
- `/prd` - Create PRD with clarified requirements
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# /code-review Command
|
|
2
|
+
|
|
3
|
+
Review implemented code for quality, correctness, and adherence to standards.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
/code-review [story-path]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Arguments
|
|
12
|
+
|
|
13
|
+
- `story-path` (optional): Path to story file to review. If not provided, finds stories in `review` status.
|
|
14
|
+
|
|
15
|
+
## Agent
|
|
16
|
+
|
|
17
|
+
This command invokes the **Dev** agent (Amelia) in review mode.
|
|
18
|
+
|
|
19
|
+
## Process
|
|
20
|
+
|
|
21
|
+
1. Load story file and implementation
|
|
22
|
+
2. Check all acceptance criteria are met
|
|
23
|
+
3. Review code quality:
|
|
24
|
+
- Follows CLAUDE.md patterns
|
|
25
|
+
- Proper error handling
|
|
26
|
+
- Appropriate test coverage
|
|
27
|
+
- No security issues
|
|
28
|
+
- Clean code principles
|
|
29
|
+
4. Check tests:
|
|
30
|
+
- All tests pass
|
|
31
|
+
- Sufficient coverage
|
|
32
|
+
- Edge cases covered
|
|
33
|
+
5. Document findings in story file
|
|
34
|
+
6. Provide review outcome:
|
|
35
|
+
- ✅ **Approve** - Ready to merge
|
|
36
|
+
- 🔄 **Changes Requested** - Needs fixes
|
|
37
|
+
- ❌ **Blocked** - Major issues found
|
|
38
|
+
|
|
39
|
+
## Skills Loaded
|
|
40
|
+
|
|
41
|
+
- `code-review` - Review checklist and process
|
|
42
|
+
|
|
43
|
+
## Output
|
|
44
|
+
|
|
45
|
+
Updates story file with:
|
|
46
|
+
- `Senior Developer Review (AI)` section
|
|
47
|
+
- Review outcome
|
|
48
|
+
- Action items (if any)
|
|
49
|
+
- `Review Follow-ups (AI)` tasks (if changes requested)
|
|
50
|
+
|
|
51
|
+
## Review Checklist
|
|
52
|
+
|
|
53
|
+
### Functionality
|
|
54
|
+
- [ ] All acceptance criteria satisfied
|
|
55
|
+
- [ ] Edge cases handled
|
|
56
|
+
- [ ] Error handling is appropriate
|
|
57
|
+
|
|
58
|
+
### Code Quality
|
|
59
|
+
- [ ] Follows CLAUDE.md patterns
|
|
60
|
+
- [ ] No code duplication
|
|
61
|
+
- [ ] Clear naming conventions
|
|
62
|
+
- [ ] Appropriate comments
|
|
63
|
+
|
|
64
|
+
### Testing
|
|
65
|
+
- [ ] Unit tests for all new code
|
|
66
|
+
- [ ] Integration tests where needed
|
|
67
|
+
- [ ] All tests pass
|
|
68
|
+
- [ ] Good test coverage
|
|
69
|
+
|
|
70
|
+
### Security
|
|
71
|
+
- [ ] No hardcoded secrets
|
|
72
|
+
- [ ] Input validation present
|
|
73
|
+
- [ ] No SQL injection risks
|
|
74
|
+
- [ ] Proper authentication/authorization
|
|
75
|
+
|
|
76
|
+
## Example
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Review stories in 'review' status
|
|
80
|
+
/code-review
|
|
81
|
+
|
|
82
|
+
# Review specific story
|
|
83
|
+
/code-review docs/sprint-artifacts/sprint-1/stories/1-1-user-auth.md
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## After Review
|
|
87
|
+
|
|
88
|
+
- If **Approved**: Mark story as `done`
|
|
89
|
+
- If **Changes Requested**:
|
|
90
|
+
1. Review follow-up tasks added to story
|
|
91
|
+
2. Run `/dev-story` to address issues
|
|
92
|
+
3. Run `/code-review` again
|
|
93
|
+
|
|
94
|
+
## Best Practice
|
|
95
|
+
|
|
96
|
+
> **Tip:** For best results, run code-review using a **different** LLM than the one that implemented the story.
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create or update coding standards documentation (modular, multiple files)
|
|
3
|
+
agent: coding-standards
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Coding Standards Creation
|
|
7
|
+
|
|
8
|
+
## Arguments
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
- "create" or empty: Create new standards from scratch
|
|
12
|
+
- "edit": Edit existing standards
|
|
13
|
+
- "add [topic]": Add new standards file for specific topic
|
|
14
|
+
- "validate": Check standards completeness
|
|
15
|
+
|
|
16
|
+
## Prerequisites
|
|
17
|
+
|
|
18
|
+
Check existing standards:
|
|
19
|
+
!`ls -la docs/coding-standards/ 2>/dev/null || echo "No standards yet"`
|
|
20
|
+
|
|
21
|
+
Check tech stack (if code exists):
|
|
22
|
+
!`ls -la src/ 2>/dev/null | head -5 || echo "No src directory"`
|
|
23
|
+
|
|
24
|
+
## Input Context
|
|
25
|
+
|
|
26
|
+
Load if exists:
|
|
27
|
+
- @docs/requirements/requirements.md (for NFRs)
|
|
28
|
+
- @docs/prd.md (for tech decisions)
|
|
29
|
+
- @AGENTS.md (current rules)
|
|
30
|
+
|
|
31
|
+
## Your Task
|
|
32
|
+
|
|
33
|
+
### Create Mode
|
|
34
|
+
|
|
35
|
+
1. **Discover tech stack**:
|
|
36
|
+
- Ask user about languages (Go, TypeScript, Python, etc.)
|
|
37
|
+
- Ask about frameworks
|
|
38
|
+
- Ask about infrastructure (DB, queues, etc.)
|
|
39
|
+
|
|
40
|
+
2. **Create modular documentation** in `docs/coding-standards/`:
|
|
41
|
+
- **README.md** - Index and critical rules
|
|
42
|
+
- **project-structure.md** - Directory layout
|
|
43
|
+
- **[language]-standards.md** - Per language (go-standards.md, etc.)
|
|
44
|
+
- **architecture-patterns.md** - Required patterns
|
|
45
|
+
- **testing-standards.md** - Test requirements
|
|
46
|
+
- **api-standards.md** - API conventions (if applicable)
|
|
47
|
+
- **database-standards.md** - DB standards (if applicable)
|
|
48
|
+
- **security-standards.md** - Security rules
|
|
49
|
+
- **libraries.md** - Approved/forbidden deps
|
|
50
|
+
- **git-workflow.md** - Git conventions
|
|
51
|
+
|
|
52
|
+
3. **Each file MUST be < 2000 lines**
|
|
53
|
+
|
|
54
|
+
4. **Generate linter configs**:
|
|
55
|
+
- `.golangci.yml` for Go
|
|
56
|
+
- `.eslintrc.js` for TypeScript/JavaScript
|
|
57
|
+
- `.editorconfig` for all
|
|
58
|
+
|
|
59
|
+
### Edit Mode
|
|
60
|
+
|
|
61
|
+
1. Ask which file to edit
|
|
62
|
+
2. Load and review current content
|
|
63
|
+
3. Make targeted updates
|
|
64
|
+
4. Ensure consistency across files
|
|
65
|
+
|
|
66
|
+
### Add Topic Mode
|
|
67
|
+
|
|
68
|
+
1. Determine appropriate file name
|
|
69
|
+
2. Create new standards file
|
|
70
|
+
3. Update README.md index
|
|
71
|
+
|
|
72
|
+
## Output Structure
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
docs/coding-standards/
|
|
76
|
+
├── README.md # Index (<500 lines)
|
|
77
|
+
├── project-structure.md
|
|
78
|
+
├── go-standards.md # (or other language)
|
|
79
|
+
├── architecture-patterns.md
|
|
80
|
+
├── testing-standards.md
|
|
81
|
+
├── api-standards.md
|
|
82
|
+
├── database-standards.md
|
|
83
|
+
├── security-standards.md
|
|
84
|
+
├── libraries.md
|
|
85
|
+
└── git-workflow.md
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Validation
|
|
89
|
+
|
|
90
|
+
After creating, verify:
|
|
91
|
+
- [ ] README.md exists with complete index
|
|
92
|
+
- [ ] All files < 2000 lines: `wc -l docs/coding-standards/*.md`
|
|
93
|
+
- [ ] Each language has standards file
|
|
94
|
+
- [ ] No contradictions between files
|
|
95
|
+
- [ ] Examples provided for complex rules
|
|
96
|
+
|
|
97
|
+
## After Completion
|
|
98
|
+
|
|
99
|
+
Suggest:
|
|
100
|
+
- Update AGENTS.md with critical rules
|
|
101
|
+
- Run `/validate coding-standards`
|
|
102
|
+
- Continue with `/prd` if not done
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# /dev-story Command
|
|
2
|
+
|
|
3
|
+
Implement a story using red-green-refactor cycle.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
/dev-story [story-path]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Arguments
|
|
12
|
+
|
|
13
|
+
- `story-path` (optional): Path to specific story file. If not provided, finds next `ready-for-dev` story from sprint-status.yaml.
|
|
14
|
+
|
|
15
|
+
## Agent
|
|
16
|
+
|
|
17
|
+
This command invokes the **Dev** agent (Amelia).
|
|
18
|
+
|
|
19
|
+
## Process
|
|
20
|
+
|
|
21
|
+
1. Find or load story file
|
|
22
|
+
2. Load project context (CLAUDE.md, project-context.md)
|
|
23
|
+
3. Mark story as `in-progress`
|
|
24
|
+
4. For each task/subtask:
|
|
25
|
+
- 🔴 RED: Write failing test
|
|
26
|
+
- 🟢 GREEN: Implement minimal code to pass
|
|
27
|
+
- 🔵 REFACTOR: Improve while keeping tests green
|
|
28
|
+
5. Mark task complete `[x]` only when tests pass
|
|
29
|
+
6. Update story file (File List, Change Log, Dev Agent Record)
|
|
30
|
+
7. Mark story as `review` when all tasks complete
|
|
31
|
+
|
|
32
|
+
## Workflow
|
|
33
|
+
|
|
34
|
+
Executes: `workflows/dev-story/instructions.md`
|
|
35
|
+
|
|
36
|
+
## Skills Loaded
|
|
37
|
+
|
|
38
|
+
- `dev-story` - Implementation workflow
|
|
39
|
+
- `test-design` - Test writing patterns
|
|
40
|
+
|
|
41
|
+
## Output
|
|
42
|
+
|
|
43
|
+
- Implementation code
|
|
44
|
+
- Unit tests
|
|
45
|
+
- Integration tests
|
|
46
|
+
- Updated story file with:
|
|
47
|
+
- Tasks marked `[x]`
|
|
48
|
+
- File List
|
|
49
|
+
- Change Log
|
|
50
|
+
- Dev Agent Record
|
|
51
|
+
|
|
52
|
+
## HALT Conditions
|
|
53
|
+
|
|
54
|
+
The workflow will HALT and ask for input when:
|
|
55
|
+
- Additional dependencies need approval
|
|
56
|
+
- 3 consecutive implementation failures
|
|
57
|
+
- Required configuration is missing
|
|
58
|
+
- Ambiguous requirements need clarification
|
|
59
|
+
|
|
60
|
+
## Example
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# Find next ready story automatically
|
|
64
|
+
/dev-story
|
|
65
|
+
|
|
66
|
+
# Implement specific story
|
|
67
|
+
/dev-story docs/sprint-artifacts/sprint-1/stories/1-1-user-auth.md
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Story Status Flow
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
ready-for-dev → in-progress → review → done
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Next Steps After Completion
|
|
77
|
+
|
|
78
|
+
1. `/code-review` - Review the implementation
|
|
79
|
+
2. If approved, mark story as `done`
|
|
80
|
+
3. Continue with next story
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create technical diagrams (C4, sequence, ER, flowcharts) in Mermaid format
|
|
3
|
+
agent: diagram-creator
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Diagram Creation
|
|
7
|
+
|
|
8
|
+
## Arguments
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
Format: `[scope] [type]`
|
|
12
|
+
|
|
13
|
+
**Scope:**
|
|
14
|
+
- "system" - System-wide diagram
|
|
15
|
+
- "[module-name]" - Module-specific diagram
|
|
16
|
+
|
|
17
|
+
**Type:**
|
|
18
|
+
- "c4-context" - C4 Level 1: System context
|
|
19
|
+
- "c4-container" - C4 Level 2: Containers/services
|
|
20
|
+
- "c4-component" - C4 Level 3: Module components
|
|
21
|
+
- "sequence [flow-name]" - Sequence diagram for a flow
|
|
22
|
+
- "erd" - Entity relationship diagram
|
|
23
|
+
- "flow [process-name]" - Flowchart
|
|
24
|
+
- "state [entity-name]" - State machine
|
|
25
|
+
|
|
26
|
+
**Examples:**
|
|
27
|
+
- `/diagram system c4-context`
|
|
28
|
+
- `/diagram catalog c4-component`
|
|
29
|
+
- `/diagram catalog sequence product-import`
|
|
30
|
+
- `/diagram catalog erd`
|
|
31
|
+
- `/diagram order flow checkout-process`
|
|
32
|
+
- `/diagram offer state lifecycle`
|
|
33
|
+
|
|
34
|
+
## Check Existing Diagrams
|
|
35
|
+
|
|
36
|
+
!`ls -la docs/diagrams/ 2>/dev/null || echo "No diagrams yet"`
|
|
37
|
+
!`ls docs/diagrams/*/ 2>/dev/null || echo ""`
|
|
38
|
+
|
|
39
|
+
## Input Context
|
|
40
|
+
|
|
41
|
+
Load based on scope:
|
|
42
|
+
- @docs/architecture.md (always)
|
|
43
|
+
- @docs/modules/[scope]/architecture.md (if module-specific)
|
|
44
|
+
- @docs/modules/[scope]/data-model.md (for ERD)
|
|
45
|
+
|
|
46
|
+
## Diagram Storage
|
|
47
|
+
|
|
48
|
+
All diagrams go to `docs/diagrams/`:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
docs/diagrams/
|
|
52
|
+
├── README.md # Diagram index
|
|
53
|
+
├── c4/
|
|
54
|
+
│ ├── system-context.md # L1
|
|
55
|
+
│ ├── containers.md # L2
|
|
56
|
+
│ └── [module]-components.md # L3 per module
|
|
57
|
+
├── sequences/
|
|
58
|
+
│ └── [flow-name].md
|
|
59
|
+
├── data/
|
|
60
|
+
│ ├── erd-overview.md
|
|
61
|
+
│ └── [module]-erd.md
|
|
62
|
+
├── flows/
|
|
63
|
+
│ └── [process-name].md
|
|
64
|
+
└── states/
|
|
65
|
+
└── [entity]-states.md
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Your Task
|
|
69
|
+
|
|
70
|
+
1. **Determine diagram type** from arguments
|
|
71
|
+
2. **Load relevant context** (architecture, module docs)
|
|
72
|
+
3. **Create Mermaid diagram** in appropriate file
|
|
73
|
+
4. **Update index** in `docs/diagrams/README.md`
|
|
74
|
+
|
|
75
|
+
## Diagram Format
|
|
76
|
+
|
|
77
|
+
Each diagram file:
|
|
78
|
+
|
|
79
|
+
```markdown
|
|
80
|
+
# [Diagram Title]
|
|
81
|
+
|
|
82
|
+
## Context
|
|
83
|
+
|
|
84
|
+
[When/why this diagram is useful]
|
|
85
|
+
|
|
86
|
+
## Diagram
|
|
87
|
+
|
|
88
|
+
\`\`\`mermaid
|
|
89
|
+
[mermaid code]
|
|
90
|
+
\`\`\`
|
|
91
|
+
|
|
92
|
+
## Elements
|
|
93
|
+
|
|
94
|
+
| Element | Type | Description |
|
|
95
|
+
|---------|------|-------------|
|
|
96
|
+
|
|
97
|
+
## Notes
|
|
98
|
+
|
|
99
|
+
[Additional context, decisions]
|
|
100
|
+
|
|
101
|
+
## Related
|
|
102
|
+
|
|
103
|
+
- [Link to related diagram]
|
|
104
|
+
- [Link to architecture section]
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Index Update
|
|
108
|
+
|
|
109
|
+
After creating diagram, update `docs/diagrams/README.md`:
|
|
110
|
+
|
|
111
|
+
```markdown
|
|
112
|
+
# Diagrams Index
|
|
113
|
+
|
|
114
|
+
## C4 Architecture
|
|
115
|
+
|
|
116
|
+
| Diagram | Level | Scope | Description |
|
|
117
|
+
|---------|-------|-------|-------------|
|
|
118
|
+
| [System Context](./c4/system-context.md) | L1 | System | Overview |
|
|
119
|
+
|
|
120
|
+
## Sequences
|
|
121
|
+
|
|
122
|
+
| Diagram | Module | Flow |
|
|
123
|
+
|---------|--------|------|
|
|
124
|
+
|
|
125
|
+
## Data Models
|
|
126
|
+
|
|
127
|
+
| Diagram | Scope |
|
|
128
|
+
|---------|-------|
|
|
129
|
+
|
|
130
|
+
## Process Flows
|
|
131
|
+
|
|
132
|
+
| Diagram | Process |
|
|
133
|
+
|---------|---------|
|
|
134
|
+
|
|
135
|
+
## State Machines
|
|
136
|
+
|
|
137
|
+
| Diagram | Entity |
|
|
138
|
+
|---------|--------|
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Validation
|
|
142
|
+
|
|
143
|
+
- [ ] Mermaid syntax is valid
|
|
144
|
+
- [ ] Elements match architecture docs
|
|
145
|
+
- [ ] Index is updated
|
|
146
|
+
- [ ] Cross-references added
|
|
147
|
+
|
|
148
|
+
## Tips
|
|
149
|
+
|
|
150
|
+
- Keep diagrams focused (one concept per diagram)
|
|
151
|
+
- Use consistent naming across diagrams
|
|
152
|
+
- Link diagrams to relevant documentation sections
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create epics from PRD and Architecture
|
|
3
|
+
agent: sm
|
|
4
|
+
model: anthropic/claude-sonnet-4-20250514
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Epic Creation
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
|
|
11
|
+
**Required:**
|
|
12
|
+
- @docs/prd.md - For requirements coverage
|
|
13
|
+
- @docs/architecture.md - For module structure
|
|
14
|
+
|
|
15
|
+
**Check:**
|
|
16
|
+
!`ls -la docs/prd.md docs/architecture.md 2>/dev/null || echo "Missing PRD or Architecture"`
|
|
17
|
+
|
|
18
|
+
## Task
|
|
19
|
+
|
|
20
|
+
1. Load skill: `epic-writing`
|
|
21
|
+
2. Analyze PRD functional requirements
|
|
22
|
+
3. Review architecture module boundaries
|
|
23
|
+
4. Create epics that:
|
|
24
|
+
- Cover all FRs from PRD
|
|
25
|
+
- Align with architecture modules
|
|
26
|
+
- Have clear dependencies
|
|
27
|
+
- Are sized for 1-2 weeks
|
|
28
|
+
5. Load skill: `acceptance-criteria` for epic AC
|
|
29
|
+
6. **Ensure every epic has AC (MANDATORY)**
|
|
30
|
+
7. Save epics to sprint artifacts
|
|
31
|
+
|
|
32
|
+
## Epic Creation Checklist
|
|
33
|
+
|
|
34
|
+
For each epic:
|
|
35
|
+
- [ ] Unique ID: `[MODULE]-E[NN]`
|
|
36
|
+
- [ ] Clear responsibility
|
|
37
|
+
- [ ] PRD coverage documented
|
|
38
|
+
- [ ] Architecture references
|
|
39
|
+
- [ ] Dependencies identified
|
|
40
|
+
- [ ] **Acceptance criteria defined**
|
|
41
|
+
- [ ] Branch name specified
|
|
42
|
+
|
|
43
|
+
## Output
|
|
44
|
+
|
|
45
|
+
Save to: `docs/sprint-artifacts/backlog/epic-NN-module-description.md`
|
|
46
|
+
|
|
47
|
+
Or if assigning to sprint:
|
|
48
|
+
`docs/sprint-artifacts/sprint-N/epic-NN-module-description.md`
|
|
49
|
+
|
|
50
|
+
## Next Step
|
|
51
|
+
|
|
52
|
+
After epics created, suggest: `/stories [epic-id]` for each epic
|