speccrew 0.5.5 → 0.5.6
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.
|
@@ -36,6 +36,7 @@ ISA-95 Stages 4-6 as internal thinking framework:
|
|
|
36
36
|
|
|
37
37
|
**MANDATORY:**
|
|
38
38
|
- Template-first workflow — Step 5 (copy template) MUST precede Step 6 (fill content)
|
|
39
|
+
- **Mermaid for all diagrams** — ALL interaction flows, processing logic flows, and cross-function sequences MUST use Mermaid syntax (`sequenceDiagram`, `flowchart TD`). Plain text ASCII flowcharts are FORBIDDEN for these sections. Reference: `speccrew-workspace/docs/rules/mermaid-rule.md`.
|
|
39
40
|
|
|
40
41
|
**NOTE:** Design process is internal — no intermediate design-data files are produced.
|
|
41
42
|
|
|
@@ -170,6 +171,8 @@ Create ASCII wireframes showing layout, UI elements, navigation.
|
|
|
170
171
|
|
|
171
172
|
Document: `User Action → Frontend Response → Backend API Call`
|
|
172
173
|
|
|
174
|
+
**Output format: Mermaid `sequenceDiagram`** — Generate interaction flows as Mermaid sequence diagrams showing: User → Frontend → Backend API → Data Store. DO NOT use ASCII text charts.
|
|
175
|
+
|
|
173
176
|
> **ISA-95 Stage 4 Thinking — Information Flows**
|
|
174
177
|
> - Cross-module flows: Map data flows between feature and other modules
|
|
175
178
|
> - Sequence coverage: Complete chain user→frontend→backend→database→external
|
|
@@ -199,6 +202,8 @@ Document: `User Action → Frontend Response → Backend API Call`
|
|
|
199
202
|
| Data Operations | What data to read/write |
|
|
200
203
|
| Response | What data to return |
|
|
201
204
|
|
|
205
|
+
**Output format: Mermaid `flowchart TD`** — Generate processing logic as Mermaid flowcharts showing: business validation → data operation → response. DO NOT use ASCII text charts.
|
|
206
|
+
|
|
202
207
|
### 2.3 Data Access Scheme
|
|
203
208
|
|
|
204
209
|
| Operation | Data Target | Type |
|
|
@@ -396,6 +401,13 @@ Log: "✅ Checkpoint B (feature_design_review) passed and recorded"
|
|
|
396
401
|
| 5. API Contract Summary | Aggregated from Step 2.1 API List |
|
|
397
402
|
| 6. Notes | Contextual notes from analysis |
|
|
398
403
|
|
|
404
|
+
**CRITICAL — Diagram Format Rule:**
|
|
405
|
+
- "交互流程" / "Interaction Flow" sections → MUST use Mermaid `sequenceDiagram`
|
|
406
|
+
- "核心业务逻辑" / "Processing Logic" sections → MUST use Mermaid `flowchart TD`
|
|
407
|
+
- "跨函数流程" / "Cross-Function Flow" sections → MUST use Mermaid `sequenceDiagram`
|
|
408
|
+
- Plain text / ASCII flowcharts are FORBIDDEN in these sections
|
|
409
|
+
- Reference: `speccrew-workspace/docs/rules/mermaid-rule.md` for syntax compliance
|
|
410
|
+
|
|
399
411
|
### Filling Rules
|
|
400
412
|
|
|
401
413
|
- Use `search_replace` for each section individually
|
|
@@ -471,7 +483,9 @@ Log: "✅ Feature Spec generation completed. Checkpoint feature_spec_review pass
|
|
|
471
483
|
- [ ] Output path determined
|
|
472
484
|
- [ ] Template copied using `create_file`
|
|
473
485
|
- [ ] All sections filled using `search_replace`
|
|
474
|
-
- [ ] Mermaid
|
|
486
|
+
- [ ] **[CRITICAL]** Interaction Flow uses Mermaid sequenceDiagram (NOT ASCII)
|
|
487
|
+
- [ ] **[CRITICAL]** Processing Logic uses Mermaid flowchart TD (NOT ASCII)
|
|
488
|
+
- [ ] All Mermaid diagrams follow mermaid-rule.md compliance rules
|
|
475
489
|
- [ ] `.checkpoints.json` updated via script
|
|
476
490
|
- [ ] No technology decisions included
|
|
477
491
|
- [ ] No intermediate design-data artifact created
|
|
@@ -195,7 +195,7 @@
|
|
|
195
195
|
|
|
196
196
|
#### 2.1.2 Interaction Flow
|
|
197
197
|
|
|
198
|
-
<!-- AI-NOTE: Use Mermaid sequenceDiagram to show the flow: User → Frontend → Backend API → Data Store. NO style definitions allowed. NO HTML tags. -->
|
|
198
|
+
<!-- AI-NOTE: Use Mermaid sequenceDiagram to show the flow: User → Frontend → Backend API → Data Store. NO style definitions allowed. NO HTML tags. CRITICAL: This section MUST contain mermaid syntax. Plain text or ASCII flowcharts are FORBIDDEN. -->
|
|
199
199
|
|
|
200
200
|
```mermaid
|
|
201
201
|
sequenceDiagram
|
|
@@ -250,7 +250,7 @@ sequenceDiagram
|
|
|
250
250
|
|
|
251
251
|
**Processing Logic:**
|
|
252
252
|
|
|
253
|
-
<!-- AI-NOTE: Use Mermaid flowchart TD to show the processing logic for each core interface. Show: business validation → data operation → response. NO style definitions allowed. -->
|
|
253
|
+
<!-- AI-NOTE: Use Mermaid flowchart TD to show the processing logic for each core interface. Show: business validation → data operation → response. NO style definitions allowed. CRITICAL: This section MUST contain mermaid syntax. Plain text or ASCII flowcharts are FORBIDDEN. -->
|
|
254
254
|
|
|
255
255
|
```mermaid
|
|
256
256
|
flowchart TD
|