speccrew 0.7.73 → 0.7.75
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/.speccrew/agents/speccrew-feature-designer.md +96 -0
- package/.speccrew/agents/speccrew-product-manager.md +55 -0
- package/.speccrew/agents/speccrew-system-deployer.md +178 -0
- package/.speccrew/agents/speccrew-system-developer.md +177 -0
- package/.speccrew/agents/speccrew-task-worker.md +18 -0
- package/.speccrew/agents/speccrew-team-leader.md +56 -0
- package/.speccrew/agents/speccrew-test-manager.md +167 -0
- package/.speccrew/skills/speccrew-agentflow-manager/SKILL.md +6 -149
- package/.speccrew/skills/speccrew-deploy-build/SKILL.md +2 -59
- package/.speccrew/skills/speccrew-deploy-migrate/SKILL.md +2 -64
- package/.speccrew/skills/speccrew-deploy-smoke-test/SKILL.md +2 -75
- package/.speccrew/skills/speccrew-deploy-startup/SKILL.md +2 -70
- package/.speccrew/skills/speccrew-dev-backend/SKILL.md +2 -381
- package/.speccrew/skills/speccrew-dev-desktop-electron/SKILL.md +2 -369
- package/.speccrew/skills/speccrew-dev-desktop-tauri/SKILL.md +2 -362
- package/.speccrew/skills/speccrew-dev-frontend/SKILL.md +2 -304
- package/.speccrew/skills/speccrew-dev-mobile/SKILL.md +2 -294
- package/.speccrew/skills/speccrew-dev-review-backend/SKILL.md +2 -204
- package/.speccrew/skills/speccrew-dev-review-desktop/SKILL.md +2 -173
- package/.speccrew/skills/speccrew-dev-review-frontend/SKILL.md +2 -169
- package/.speccrew/skills/speccrew-dev-review-mobile/SKILL.md +2 -173
- package/.speccrew/skills/speccrew-fd-api-contract/SKILL.md +2 -251
- package/.speccrew/skills/speccrew-fd-feature-analyze/SKILL.md +2 -254
- package/.speccrew/skills/speccrew-fd-feature-design/SKILL.md +2 -748
- package/.speccrew/skills/speccrew-feature-designer-orchestration/SKILL.md +6 -105
- package/.speccrew/skills/speccrew-get-timestamp/SKILL.md +6 -33
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/SKILL.md +3 -138
- package/.speccrew/skills/speccrew-knowledge-bizs-api-graph/SKILL.md +3 -283
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/SKILL.md +3 -1014
- package/.speccrew/skills/speccrew-knowledge-bizs-identify-entries/SKILL.md +4 -343
- package/.speccrew/skills/speccrew-knowledge-bizs-init-features/SKILL.md +4 -235
- package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/SKILL.md +6 -72
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/SKILL.md +3 -534
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-graph/SKILL.md +3 -432
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/SKILL.md +4 -391
- package/.speccrew/skills/speccrew-knowledge-graph-query/SKILL.md +3 -98
- package/.speccrew/skills/speccrew-knowledge-graph-write/SKILL.md +3 -92
- package/.speccrew/skills/speccrew-knowledge-module-summarize/SKILL.md +3 -181
- package/.speccrew/skills/speccrew-knowledge-system-summarize/SKILL.md +3 -148
- package/.speccrew/skills/speccrew-knowledge-techs-dispatch/SKILL.md +3 -330
- package/.speccrew/skills/speccrew-knowledge-techs-generate/SKILL.md +6 -159
- package/.speccrew/skills/speccrew-knowledge-techs-generate-conventions/SKILL.md +3 -142
- package/.speccrew/skills/speccrew-knowledge-techs-generate-quality/SKILL.md +3 -568
- package/.speccrew/skills/speccrew-knowledge-techs-generate-ui-style/SKILL.md +3 -180
- package/.speccrew/skills/speccrew-knowledge-techs-index/SKILL.md +3 -154
- package/.speccrew/skills/speccrew-knowledge-techs-init/SKILL.md +3 -176
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/SKILL.md +3 -135
- package/.speccrew/skills/speccrew-pm-knowledge-detector/SKILL.md +4 -88
- package/.speccrew/skills/speccrew-pm-module-initializer/SKILL.md +4 -178
- package/.speccrew/skills/speccrew-pm-module-matcher/SKILL.md +3 -102
- package/.speccrew/skills/speccrew-pm-phase0-init/SKILL.md +5 -78
- package/.speccrew/skills/speccrew-pm-phase1-knowledge-check/SKILL.md +5 -85
- package/.speccrew/skills/speccrew-pm-phase2-complexity-assess/SKILL.md +4 -100
- package/.speccrew/skills/speccrew-pm-phase5-subprd-dispatch/SKILL.md +14 -106
- package/.speccrew/skills/speccrew-pm-phase6-verify-confirm/SKILL.md +7 -84
- package/.speccrew/skills/speccrew-pm-requirement-analysis/SKILL.md +6 -66
- package/.speccrew/skills/speccrew-pm-requirement-assess/SKILL.md +4 -96
- package/.speccrew/skills/speccrew-pm-requirement-clarify/SKILL.md +4 -131
- package/.speccrew/skills/speccrew-pm-requirement-model/SKILL.md +6 -79
- package/.speccrew/skills/speccrew-pm-requirement-simple/SKILL.md +4 -76
- package/.speccrew/skills/speccrew-pm-sub-prd-generate/SKILL.md +3 -281
- package/.speccrew/skills/speccrew-product-manager-orchestration/SKILL.md +6 -165
- package/.speccrew/skills/speccrew-system-deployer-orchestration/SKILL.md +6 -79
- package/.speccrew/skills/speccrew-system-designer-orchestration/SKILL.md +2 -35
- package/.speccrew/skills/speccrew-system-developer-orchestration/SKILL.md +6 -98
- package/.speccrew/skills/speccrew-task-worker-execution/SKILL.md +6 -94
- package/.speccrew/skills/speccrew-team-leader-routing/SKILL.md +6 -79
- package/.speccrew/skills/speccrew-test-case-design/SKILL.md +2 -58
- package/.speccrew/skills/speccrew-test-code-gen/SKILL.md +2 -61
- package/.speccrew/skills/speccrew-test-manager-orchestration/SKILL.md +6 -94
- package/.speccrew/skills/speccrew-test-reporter/SKILL.md +2 -102
- package/.speccrew/skills/speccrew-test-runner/SKILL.md +3 -121
- package/package.json +1 -1
- package/workspace-template/docs/rules/agentflow-spec.md +56 -8
|
@@ -4,190 +4,12 @@ description: Summarize a module's features to complete MODULE-OVERVIEW.md using
|
|
|
4
4
|
tools: Read, Write, Glob
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
#
|
|
8
|
-
|
|
9
|
-
Read all {{feature_name}}.md files of a specific module, extract and summarize information to complete {{module_name}}-overview.md (full version with entities, dependencies, flows, and rules).
|
|
10
|
-
|
|
11
|
-
## Language Adaptation
|
|
12
|
-
|
|
13
|
-
**CRITICAL**: Generate all content in the language specified by the `language` parameter.
|
|
14
|
-
|
|
15
|
-
- `language: "zh"` → Generate all content in 中文
|
|
16
|
-
- `language: "en"` → Generate all content in English
|
|
17
|
-
- Other languages → Use the specified language
|
|
18
|
-
|
|
19
|
-
**All output content (entity names, descriptions, business rules, flow descriptions) must be in the target language only.**
|
|
20
|
-
|
|
21
|
-
## Trigger Scenarios
|
|
22
|
-
|
|
7
|
+
# Trigger Scenarios
|
|
23
8
|
- "Summarize module {name} features"
|
|
24
9
|
- "Complete module overview for {name}"
|
|
25
10
|
- "Finalize module documentation for {name}"
|
|
26
11
|
|
|
27
|
-
## Input
|
|
28
|
-
|
|
29
|
-
| Parameter | Type | Required | Description |
|
|
30
|
-
|-----------|------|----------|-------------|
|
|
31
|
-
| `module_name` | string | Yes | Module name to summarize |
|
|
32
|
-
| `module_path` | string | Yes | Path to module directory (e.g., `speccrew-workspace/knowledges/bizs/{{platform_type}}/{{module_name}}/`) containing: {{module_name}}-overview.md (initial version), features/{{feature_name}}.md files |
|
|
33
|
-
| `language` | string | Yes | Target language for generated content (e.g., "zh", "en") |
|
|
34
|
-
|
|
35
|
-
## Output
|
|
36
|
-
|
|
37
|
-
| Output | Path | Description |
|
|
38
|
-
|--------|------|-------------|
|
|
39
|
-
| `{{module_name}}-overview.md` | `{{module_path}}/{{module_name}}-overview.md` | Complete module overview (overwritten). Example: `speccrew-workspace/knowledges/bizs/backend-ai/chat/chat-overview.md` |
|
|
40
|
-
|
|
41
|
-
## Workflow
|
|
42
|
-
|
|
43
|
-
```mermaid
|
|
44
|
-
flowchart TD
|
|
45
|
-
Start([Start]) --> Step1[Step 1: Read Prerequisites]
|
|
46
|
-
Step1 --> Step2[Step 2: Extract Entities]
|
|
47
|
-
Step2 --> Step3[Step 3: Identify Dependencies]
|
|
48
|
-
Step3 --> Step4[Step 4: Summarize Business Rules]
|
|
49
|
-
Step4 --> Step5[Step 5: Generate Complete MODULE-OVERVIEW.md]
|
|
50
|
-
Step5 --> Step6[Step 6: Report Results]
|
|
51
|
-
Step6 --> End([End])
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
> **REQUIRED**: Before executing this workflow, read the XML workflow specification: `speccrew-workspace/docs/rules/agentflow-spec.md`
|
|
55
|
-
|
|
56
12
|
## AgentFlow Definition
|
|
57
|
-
|
|
58
13
|
<!-- @agentflow: SKILL.xml -->
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
### Critical Constraints
|
|
63
|
-
|
|
64
|
-
> 1. **FORBIDDEN: `create_file` for overview document** — If skeleton exists, use `search_replace`; if not, copy template first then fill with `search_replace`
|
|
65
|
-
> 2. **FORBIDDEN: Full-file rewrite** — Always use targeted `search_replace` on specific sections
|
|
66
|
-
> 3. **MANDATORY: Template-first workflow** — Template (or existing skeleton) MUST be in place before filling sections
|
|
67
|
-
|
|
68
|
-
### Content Language
|
|
69
|
-
|
|
70
|
-
**IMPORTANT**: ALL generated content (entity descriptions, business rules, flow descriptions, section headers, and narrative text) MUST be written in the language specified by the `language` parameter. Only code identifiers, file paths, and technical terms (class names, API endpoints) remain in their original language.
|
|
71
|
-
|
|
72
|
-
## Return Value Format
|
|
73
|
-
|
|
74
|
-
```json
|
|
75
|
-
{
|
|
76
|
-
"status": "success|failed",
|
|
77
|
-
"module_name": "module_name",
|
|
78
|
-
"output_file": "module_name-overview.md",
|
|
79
|
-
"message": "Module summarization completed with N features processed"
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
## Task Completion Report
|
|
84
|
-
|
|
85
|
-
Upon completion, output the following structured report:
|
|
86
|
-
|
|
87
|
-
```json
|
|
88
|
-
{
|
|
89
|
-
"status": "success | partial | failed",
|
|
90
|
-
"skill": "speccrew-knowledge-module-summarize",
|
|
91
|
-
"output_files": [
|
|
92
|
-
"{module_path}/{module_name}-overview.md"
|
|
93
|
-
],
|
|
94
|
-
"summary": "Module overview completed with entities, dependencies, and business rules extracted from {feature_count} features",
|
|
95
|
-
"metrics": {
|
|
96
|
-
"modules_processed": 1,
|
|
97
|
-
"documents_generated": 1,
|
|
98
|
-
"features_covered": 0
|
|
99
|
-
},
|
|
100
|
-
"errors": [],
|
|
101
|
-
"next_steps": [
|
|
102
|
-
"Run speccrew-knowledge-system-summarize to aggregate all modules into system overview"
|
|
103
|
-
]
|
|
104
|
-
}
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
## Reference Guides
|
|
108
|
-
|
|
109
|
-
### Mermaid Diagram Guide
|
|
110
|
-
|
|
111
|
-
When generating Mermaid diagrams, follow these compatibility guidelines:
|
|
112
|
-
|
|
113
|
-
**Key Requirements:**
|
|
114
|
-
- Use only basic node definitions: `A[text content]`
|
|
115
|
-
- No HTML tags (e.g., `<br/>`)
|
|
116
|
-
- No nested subgraphs
|
|
117
|
-
- No `direction` keyword
|
|
118
|
-
- No `style` definitions
|
|
119
|
-
- Use standard `graph TB/LR` syntax only
|
|
120
|
-
|
|
121
|
-
**Diagram Types:**
|
|
122
|
-
|
|
123
|
-
| Diagram Type | Use Case | Example |
|
|
124
|
-
|---------|---------|------|
|
|
125
|
-
| `graph TB/LR` | Module structure, dependencies | Project structure diagram, dependency graph |
|
|
126
|
-
| `sequenceDiagram` | Interaction flow, API calls | User operation flow, service call chain |
|
|
127
|
-
| `flowchart TD` | Business logic, conditional branches | State transition, exception handling |
|
|
128
|
-
| `classDiagram` | Class structure, entity relationships | Data model, service interface |
|
|
129
|
-
| `erDiagram` | Database table relationships | Entity relationship diagram |
|
|
130
|
-
| `stateDiagram-v2` | State machine | Order status, approval status |
|
|
131
|
-
|
|
132
|
-
### Source Traceability Guide
|
|
133
|
-
|
|
134
|
-
Aggregate source file references from all feature documents:
|
|
135
|
-
|
|
136
|
-
> **Note**: Use relative paths from the generated document to the source file. Do NOT use `file://` protocol.
|
|
137
|
-
|
|
138
|
-
**CRITICAL: Dynamic Relative Path Calculation**
|
|
139
|
-
|
|
140
|
-
The document generation location is `speccrew-workspace/knowledges/bizs/{platform_id}/{module_path}/{file}.md`, which has a **variable depth** from the project root. You MUST dynamically calculate the relative path depth based on the actual document location.
|
|
141
|
-
|
|
142
|
-
**Calculation Method:**
|
|
143
|
-
1. Count the number of directory separators (`/`) from the project root to the document's directory
|
|
144
|
-
2. Each directory level requires one `../` to traverse up to the project root
|
|
145
|
-
3. Example: Document at `speccrew-workspace/knowledges/bizs/backend-ai/chat/overview.md` (5 levels) → Use `../../../../../src/...`
|
|
146
|
-
|
|
147
|
-
**Common Path Depths Reference:**
|
|
148
|
-
| Document Location | Depth | Relative Path Prefix |
|
|
149
|
-
|---|---|---|
|
|
150
|
-
| `speccrew-workspace/knowledges/bizs/{platform}/{module}/` | 5+ | `../../../../../` |
|
|
151
|
-
| `speccrew-workspace/knowledges/bizs/{platform}/{module}/{sub}/` | 6+ | `../../../../../../` |
|
|
152
|
-
|
|
153
|
-
**Source reference examples by tech stack (assuming document at depth 5):**
|
|
154
|
-
|
|
155
|
-
Backend (Java): `[OrderController.java](../../../../../src/main/java/.../OrderController.java#L10-L25)`
|
|
156
|
-
Backend (Python): `[views.py](../../../../../app/order/views.py#L10-L25)`
|
|
157
|
-
Backend (Node.js): `[orderController.js](../../../../../src/modules/order/orderController.js#L10-L25)`
|
|
158
|
-
Frontend (Vue): `[OrderList.vue](../../../../../src/views/order/OrderList.vue#L10-L25)`
|
|
159
|
-
Frontend (React): `[OrderDetail.tsx](../../../../../src/pages/order/OrderDetail.tsx#L10-L25)`
|
|
160
|
-
|
|
161
|
-
1. **File Reference Block** (at document start):
|
|
162
|
-
```markdown
|
|
163
|
-
**Referenced Files**
|
|
164
|
-
|
|
165
|
-
- [OrderController.*](path/to/source/OrderController.*)
|
|
166
|
-
- [OrderService.*](path/to/source/OrderService.*)
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
2. **Diagram Source** (after each Mermaid diagram):
|
|
170
|
-
```markdown
|
|
171
|
-
**Diagram Source**
|
|
172
|
-
- [OrderController.*](path/to/source/OrderController.*#L45-L60)
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
3. **Section Source** (at end of document):
|
|
176
|
-
```markdown
|
|
177
|
-
**Section Source**
|
|
178
|
-
- [OrderController.*](path/to/source/OrderController.*#L1-L100)
|
|
179
|
-
- [OrderService.*](path/to/source/OrderService.*#L1-L80)
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
## Notes
|
|
183
|
-
|
|
184
|
-
> **Note**: This skill focuses on document aggregation only. Knowledge graph data (nodes, edges) is handled separately by the dispatch skill's `process-batch-results.js` script during Stage 2. Module-summarize does NOT read from or write to the knowledge graph.
|
|
185
|
-
|
|
186
|
-
## Checklist
|
|
187
|
-
|
|
188
|
-
- [ ] Step 1: Prerequisites read (template, initial overview, feature details)
|
|
189
|
-
- [ ] Step 2: Entities extracted and aggregated
|
|
190
|
-
- [ ] Step 3: Dependencies identified
|
|
191
|
-
- [ ] Step 4: Business rules collected
|
|
192
|
-
- [ ] Step 5: Section 3-6 completed in {{module_name}}-overview.md
|
|
193
|
-
- [ ] Step 6: Results reported
|
|
14
|
+
> **REQUIRED**: Before executing this workflow, read the XML workflow specification: speccrew-workspace/docs/rules/agentflow-spec.md
|
|
15
|
+
> Then read and execute the XML workflow in SKILL.xml block-by-block as the authoritative execution plan.
|
|
@@ -4,157 +4,12 @@ description: Generate complete system-overview.md by reading all {{module_name}}
|
|
|
4
4
|
tools: Read, Write, Glob, Skill
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
#
|
|
8
|
-
|
|
9
|
-
Read all {{module_name}}-overview.md files, aggregate information to generate complete system-overview.md with module index, topology, and business flows.
|
|
10
|
-
|
|
11
|
-
## Language Adaptation
|
|
12
|
-
|
|
13
|
-
**CRITICAL**: Generate all content in the language specified by the `language` parameter.
|
|
14
|
-
|
|
15
|
-
- `language: "zh"` → Generate all content in 中文
|
|
16
|
-
- `language: "en"` → Generate all content in English
|
|
17
|
-
- Other languages → Use the specified language
|
|
18
|
-
|
|
19
|
-
**All output content (system description, module summaries, flow descriptions) must be in the target language only.**
|
|
20
|
-
|
|
21
|
-
## Trigger Scenarios
|
|
22
|
-
|
|
7
|
+
# Trigger Scenarios
|
|
23
8
|
- "Generate system overview from modules"
|
|
24
9
|
- "Complete system documentation"
|
|
25
10
|
- "Summarize all modules into system view"
|
|
26
11
|
|
|
27
|
-
## User
|
|
28
|
-
|
|
29
|
-
Worker Agent (speccrew-task-worker)
|
|
30
|
-
|
|
31
|
-
## Input
|
|
32
|
-
|
|
33
|
-
| Parameter | Type | Required | Description |
|
|
34
|
-
|-----------|------|----------|-------------|
|
|
35
|
-
| `modules_path` | string | Yes | Path to modules directory (e.g., `speccrew-workspace/knowledges/bizs/`) containing all {{platform_type}}/{{module_name}}/{{module_name}}-overview.md files |
|
|
36
|
-
| `output_path` | string | Yes | Output path for system-overview.md (e.g., `speccrew-workspace/knowledges/bizs/`) |
|
|
37
|
-
| `language` | string | Yes | Target language for generated content (e.g., "zh", "en") |
|
|
38
|
-
|
|
39
|
-
## Output
|
|
40
|
-
|
|
41
|
-
| Output | Path | Description |
|
|
42
|
-
|--------|------|-------------|
|
|
43
|
-
| `system-overview.md` | `{{output_path}}/system-overview.md` | Complete system overview. Example: `speccrew-workspace/knowledges/bizs/system-overview.md` |
|
|
44
|
-
|
|
45
12
|
## AgentFlow Definition
|
|
46
|
-
|
|
47
13
|
<!-- @agentflow: SKILL.xml -->
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
### Critical Constraints
|
|
52
|
-
|
|
53
|
-
> 1. **FORBIDDEN: `create_file` for documents** — Document MUST be created by copying template (Step 7a) then filling with `search_replace` (Step 7b)
|
|
54
|
-
> 2. **FORBIDDEN: Full-file rewrite** — Always use targeted `search_replace` on specific sections
|
|
55
|
-
> 3. **MANDATORY: Template-first workflow** — Step 7a MUST execute before Step 7b
|
|
56
|
-
|
|
57
|
-
### Content Language
|
|
58
|
-
|
|
59
|
-
**IMPORTANT**: ALL generated content (system description, module summaries, flow descriptions, section headers, and narrative text) MUST be written in the language specified by the `language` parameter. Only code identifiers, file paths, and technical terms remain in their original language.
|
|
60
|
-
|
|
61
|
-
## Return Value Format
|
|
62
|
-
|
|
63
|
-
```json
|
|
64
|
-
{
|
|
65
|
-
"status": "success|failed",
|
|
66
|
-
"output_file": "system-overview.md",
|
|
67
|
-
"message": "System summarization completed with N modules processed"
|
|
68
|
-
}
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## Task Completion Report
|
|
72
|
-
|
|
73
|
-
Upon completion, output the following structured report:
|
|
74
|
-
|
|
75
|
-
```json
|
|
76
|
-
{
|
|
77
|
-
"status": "success | partial | failed",
|
|
78
|
-
"skill": "speccrew-knowledge-system-summarize",
|
|
79
|
-
"output_files": [
|
|
80
|
-
"{output_path}/system-overview.md"
|
|
81
|
-
],
|
|
82
|
-
"summary": "System overview generated from {module_count} modules across {platform_count} platforms",
|
|
83
|
-
"metrics": {
|
|
84
|
-
"platforms_covered": 0,
|
|
85
|
-
"modules_summarized": 0,
|
|
86
|
-
"system_overview_generated": true
|
|
87
|
-
},
|
|
88
|
-
"errors": [],
|
|
89
|
-
"next_steps": [
|
|
90
|
-
"Review system-overview.md for completeness",
|
|
91
|
-
"Run speccrew-pm-requirement-assess if requirement assessment is needed"
|
|
92
|
-
]
|
|
93
|
-
}
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
## Reference Guides
|
|
97
|
-
|
|
98
|
-
### Mermaid Diagram Guide
|
|
99
|
-
|
|
100
|
-
When generating Mermaid diagrams, follow these compatibility guidelines:
|
|
101
|
-
|
|
102
|
-
**Key Requirements:**
|
|
103
|
-
- Use only basic node definitions: `A[text content]`
|
|
104
|
-
- No HTML tags (e.g., `<br/>`)
|
|
105
|
-
- No nested subgraphs
|
|
106
|
-
- No `direction` keyword
|
|
107
|
-
- No `style` definitions
|
|
108
|
-
- Use standard `graph TB/LR` syntax only
|
|
109
|
-
|
|
110
|
-
**Diagram Types:**
|
|
111
|
-
|
|
112
|
-
| Diagram Type | Use Case | Example |
|
|
113
|
-
|---------|---------|------|
|
|
114
|
-
| `graph TB/LR` | System structure, module dependencies | System architecture, module dependency graph |
|
|
115
|
-
| `sequenceDiagram` | Cross-module interaction flow | User operation flow, service call chain |
|
|
116
|
-
| `flowchart TD` | Business logic, conditional branches | State transition, exception handling |
|
|
117
|
-
| `classDiagram` | Class structure, entity relationships | Data model, service interface |
|
|
118
|
-
| `erDiagram` | Database table relationships | Entity relationship diagram |
|
|
119
|
-
| `stateDiagram-v2` | State machine | Order status, approval status |
|
|
120
|
-
|
|
121
|
-
### Source Traceability Guide
|
|
122
|
-
|
|
123
|
-
Aggregate source file references from all module overview documents:
|
|
124
|
-
|
|
125
|
-
> **Note**: Use relative paths from the generated document to the source file. Do NOT use `file://` protocol.
|
|
126
|
-
|
|
127
|
-
1. **File Reference Block** (at document start):
|
|
128
|
-
```markdown
|
|
129
|
-
**Referenced Files**
|
|
130
|
-
|
|
131
|
-
- Aggregated from all module overview documents
|
|
132
|
-
- [OrderController.java](path/to/source/OrderController.java)
|
|
133
|
-
- [PaymentController.java](path/to/source/PaymentController.java)
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
2. **Diagram Source** (after each Mermaid diagram):
|
|
137
|
-
```markdown
|
|
138
|
-
**Diagram Source**
|
|
139
|
-
- Aggregated from: order-overview.md, payment-overview.md
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
3. **Section Source** (at end of document):
|
|
143
|
-
```markdown
|
|
144
|
-
**Section Source**
|
|
145
|
-
- Aggregated from all module overview documents
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
## Checklist
|
|
149
|
-
|
|
150
|
-
- [ ] All {{module_name}}-overview.md files discovered
|
|
151
|
-
- [ ] Module information extracted
|
|
152
|
-
- [ ] Source file references aggregated from module documents
|
|
153
|
-
- [ ] Module index table created
|
|
154
|
-
- [ ] Dependency graph built
|
|
155
|
-
- [ ] Business domains identified
|
|
156
|
-
- [ ] End-to-end flows mapped
|
|
157
|
-
- [ ] system-overview.md generated with all sections
|
|
158
|
-
- [ ] Source traceability information included
|
|
159
|
-
- [ ] Mermaid diagrams follow compatibility guidelines
|
|
160
|
-
- [ ] Results reported
|
|
14
|
+
> **REQUIRED**: Before executing this workflow, read the XML workflow specification: speccrew-workspace/docs/rules/agentflow-spec.md
|
|
15
|
+
> Then read and execute the XML workflow in SKILL.xml block-by-block as the authoritative execution plan.
|