speccrew 0.6.17 → 0.6.18
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/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-FASTAPI.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-JAVA.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-NET.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/MODULE-OVERVIEW-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-module-summarize/SKILL.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-module-summarize/templates/MODULE-OVERVIEW-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-system-summarize/SKILL.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-system-summarize/templates/SYSTEM-OVERVIEW-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-dispatch/SKILL.md +2 -2
- package/.speccrew/skills/speccrew-knowledge-techs-dispatch/STATUS-FORMATS.md +1 -1
- package/.speccrew/skills/speccrew-knowledge-techs-generate/SKILL.md +1 -1
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/ARCHITECTURE-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COLOR-SYSTEM-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COMPONENT-LIBRARY-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-BUILD-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DATA-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DESIGN-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DEV-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-SYSTEM-TEST-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-UNIT-TEST-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/PAGE-LAYOUTS-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/PAGE-TYPE-SUMMARY-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/TECH-STACK-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-generate-conventions/SKILL.md +7 -7
- package/.speccrew/skills/speccrew-knowledge-techs-generate-quality/SKILL.md +2 -2
- package/.speccrew/skills/speccrew-knowledge-techs-index/SKILL.md +2 -3
- package/.speccrew/skills/speccrew-knowledge-techs-index/templates/INDEX-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/BUSINESS-COMPONENTS-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMMON-COMPONENTS-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-INDIVIDUAL-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-LIBRARY-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/LAYOUT-INDIVIDUAL-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/LAYOUT-PATTERNS-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/NAVIGATION-PATTERNS-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/PAGE-TYPE-INDIVIDUAL-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/PAGE-TYPE-SUMMARY-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/SPACING-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/STYLE-SYSTEM-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/TYPOGRAPHY-TEMPLATE.md +1 -2
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/UI-STYLE-GUIDE-TEMPLATE.md +1 -2
- package/package.json +1 -1
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
> <!-- AI-TAG: FEATURE_DETAIL -->
|
|
8
8
|
> <!-- AI-CONTEXT: This document describes FastAPI endpoints, business logic flow, and data models. AI should fill all placeholders when generating. -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Files Referenced in This Document**
|
|
11
|
+
|
|
12
12
|
- [{router}.py](../../{routerSourcePath})
|
|
13
13
|
- [{service}.py](../../{serviceSourcePath})
|
|
14
14
|
- [{model}.py](../../{modelSourcePath})
|
|
15
15
|
- [{schema}.py](../../{schemaSourcePath})
|
|
16
|
-
</cite>
|
|
17
16
|
|
|
18
17
|
---
|
|
19
18
|
|
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
> <!-- AI-TAG: FEATURE_DETAIL -->
|
|
8
8
|
> <!-- AI-CONTEXT: This document describes the UI, interaction, and data rules of a single feature in detail. AI should fill all placeholders when generating. -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Files Referenced in This Document**
|
|
11
|
+
|
|
12
12
|
- [{Controller}.java](../../{controllerSourcePath})
|
|
13
13
|
- [{Service}.java](../../{serviceSourcePath})
|
|
14
14
|
- [{Entity}.java](../../{entitySourcePath})
|
|
15
15
|
- [{DTO}.java](../../{dtoSourcePath})
|
|
16
|
-
</cite>
|
|
17
16
|
|
|
18
17
|
---
|
|
19
18
|
|
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
> <!-- AI-TAG: FEATURE_DETAIL -->
|
|
8
8
|
> <!-- AI-CONTEXT: This document describes ASP.NET Core API endpoints, business logic flow, and data models. AI should fill all placeholders when generating. -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Files Referenced in This Document**
|
|
11
|
+
|
|
12
12
|
- [{Controller}.cs](../../{controllerSourcePath})
|
|
13
13
|
- [{Service}.cs](../../{serviceSourcePath})
|
|
14
14
|
- [{Repository}.cs](../../{repositorySourcePath})
|
|
15
15
|
- [{Entity}.cs](../../{entitySourcePath})
|
|
16
|
-
</cite>
|
|
17
16
|
|
|
18
17
|
---
|
|
19
18
|
|
package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE.md
CHANGED
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
> <!-- AI-TAG: FEATURE_DETAIL -->
|
|
8
8
|
> <!-- AI-CONTEXT: This document describes the UI, interaction, and data rules of a single feature in detail. AI should fill all placeholders when generating. -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Files Referenced in This Document**
|
|
11
|
+
|
|
12
12
|
- [{Controller}.java](../../{controllerSourcePath})
|
|
13
13
|
- [{Service}.java](../../{serviceSourcePath})
|
|
14
14
|
- [{Entity}.java](../../{entitySourcePath})
|
|
15
15
|
- [{DTO}.java](../../{dtoSourcePath})
|
|
16
|
-
</cite>
|
|
17
16
|
|
|
18
17
|
---
|
|
19
18
|
|
package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/MODULE-OVERVIEW-TEMPLATE.md
CHANGED
|
@@ -7,12 +7,11 @@
|
|
|
7
7
|
> <!-- AI-TAG: MODULE_OVERVIEW -->
|
|
8
8
|
> <!-- AI-CONTEXT: Read this document to understand module responsibilities, feature list, entity relationships, and dependency interfaces, used for requirement analysis and solution design -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Referenced Files**
|
|
11
|
+
|
|
12
12
|
- **API Handler**: [{Handler}.{ext}](../../{handlerSourcePath}) - *e.g., Controller (Java/.NET) or Router (FastAPI)*
|
|
13
13
|
- **Service Layer**: [{Service}.{ext}](../../{serviceSourcePath}) - *Business logic layer*
|
|
14
14
|
- **Data Model**: [{Model}.{ext}](../../{modelSourcePath}) - *e.g., Entity (Java/.NET) or Model (FastAPI)*
|
|
15
|
-
</cite>
|
|
16
15
|
|
|
17
16
|
---
|
|
18
17
|
|
|
@@ -287,11 +287,10 @@ Frontend (React): `[OrderDetail.tsx](../../../../../src/pages/order/OrderDetail.
|
|
|
287
287
|
|
|
288
288
|
1. **File Reference Block** (at document start):
|
|
289
289
|
```markdown
|
|
290
|
-
<cite>
|
|
291
290
|
**Referenced Files**
|
|
291
|
+
|
|
292
292
|
- [OrderController.*](path/to/source/OrderController.*)
|
|
293
293
|
- [OrderService.*](path/to/source/OrderService.*)
|
|
294
|
-
</cite>
|
|
295
294
|
```
|
|
296
295
|
|
|
297
296
|
2. **Diagram Source** (after each Mermaid diagram):
|
package/.speccrew/skills/speccrew-knowledge-module-summarize/templates/MODULE-OVERVIEW-TEMPLATE.md
CHANGED
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
> <!-- AI-TAG: MODULE_OVERVIEW -->
|
|
8
8
|
> <!-- AI-CONTEXT: Read this document to understand module responsibilities, feature list, entity relationships, and dependency interfaces, used for requirement analysis and solution design -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Referenced Files**
|
|
11
|
+
|
|
12
12
|
<!-- Path Note: {relativePath} must be dynamically calculated based on document depth. See SKILL.md "Source Traceability Guide" for calculation method. -->
|
|
13
13
|
- [{EntryPoint}]({relativePath}/{sourcePath}/{entryPointFile}) <!-- Backend: Controller/View/Router; Frontend: Page/View component -->
|
|
14
14
|
- [{BusinessLogic}]({relativePath}/{sourcePath}/{businessLogicFile}) <!-- Backend: Service; Frontend: Store/Composable/Hook -->
|
|
15
15
|
- [{DataModel}]({relativePath}/{sourcePath}/{dataModelFile}) <!-- Backend: Entity/Model; Frontend: Type/Interface definition -->
|
|
16
|
-
</cite>
|
|
17
16
|
|
|
18
17
|
---
|
|
19
18
|
|
|
@@ -330,12 +330,11 @@ Aggregate source file references from all module overview documents:
|
|
|
330
330
|
|
|
331
331
|
1. **File Reference Block** (at document start):
|
|
332
332
|
```markdown
|
|
333
|
-
<cite>
|
|
334
333
|
**Referenced Files**
|
|
334
|
+
|
|
335
335
|
- Aggregated from all module overview documents
|
|
336
336
|
- [OrderController.java](path/to/source/OrderController.java)
|
|
337
337
|
- [PaymentController.java](path/to/source/PaymentController.java)
|
|
338
|
-
</cite>
|
|
339
338
|
```
|
|
340
339
|
|
|
341
340
|
2. **Diagram Source** (after each Mermaid diagram):
|
package/.speccrew/skills/speccrew-knowledge-system-summarize/templates/SYSTEM-OVERVIEW-TEMPLATE.md
CHANGED
|
@@ -7,12 +7,11 @@
|
|
|
7
7
|
> <!-- AI-TAG: SYSTEM_OVERVIEW -->
|
|
8
8
|
> <!-- AI-CONTEXT: Read this document to understand overall system structure, module division, business processes, used for requirement impact scope judgment and solution planning -->
|
|
9
9
|
|
|
10
|
-
<cite>
|
|
11
10
|
**Referenced Files**
|
|
11
|
+
|
|
12
12
|
- Aggregated from all module overview documents
|
|
13
13
|
- [{Module} Entry Point](../../{sourcePath}/{moduleEntryFile})
|
|
14
14
|
<!-- Examples: Java Backend: OrderController.java, Vue Frontend: OrderView.vue, React Frontend: OrderPage.tsx -->
|
|
15
|
-
</cite>
|
|
16
15
|
|
|
17
16
|
---
|
|
18
17
|
|
|
@@ -456,7 +456,7 @@ Read the first 5 lines of each platform's INDEX.md:
|
|
|
456
456
|
|
|
457
457
|
#### Step 4: Source Traceability Spot-Check
|
|
458
458
|
For each platform, check ONE document (conventions-dev.md recommended):
|
|
459
|
-
- Verify it contains
|
|
459
|
+
- Verify it contains file reference block near the top (previously `<cite>`, now pure Markdown)
|
|
460
460
|
- If missing, log warning: "Platform {platform_id}: source traceability missing in conventions-dev.md"
|
|
461
461
|
|
|
462
462
|
#### Step 5: UI Style Analysis Level Recording
|
|
@@ -741,7 +741,7 @@ ON Worker Failure:
|
|
|
741
741
|
### Document Completeness Verification
|
|
742
742
|
- [ ] Each platform directory contains required documents: INDEX.md, tech-stack.md, architecture.md, conventions-design.md, conventions-dev.md, conventions-unit-test.md, conventions-system-test.md, conventions-build.md
|
|
743
743
|
- [ ] `conventions-data.md` exists only for appropriate platforms (backend required, others optional)
|
|
744
|
-
- [ ] All documents include
|
|
744
|
+
- [ ] All documents include file reference blocks (pure Markdown format for VS Code preview compatibility)
|
|
745
745
|
- [ ] All documents include AI-TAG and AI-CONTEXT comments
|
|
746
746
|
- [ ] techs/INDEX.md links only to existing documents
|
|
747
747
|
|
|
@@ -282,7 +282,7 @@ This document defines the JSON formats for techs pipeline status tracking files.
|
|
|
282
282
|
| `quality_checks` | object | Quality verification results from Stage 2.5 |
|
|
283
283
|
| `quality_checks.all_required_docs_present` | boolean | Whether all platforms have 8 required documents |
|
|
284
284
|
| `quality_checks.language_consistent` | boolean | Whether all documents match the target language |
|
|
285
|
-
| `quality_checks.traceability_verified` | boolean | Whether source traceability (
|
|
285
|
+
| `quality_checks.traceability_verified` | boolean | Whether source traceability (file reference blocks) verified |
|
|
286
286
|
| `quality_checks.ui_analyzer_results` | object | UI style analysis level per platform category |
|
|
287
287
|
| `quality_checks.ui_analyzer_results.full` | array | Platform IDs with full UI analysis |
|
|
288
288
|
| `quality_checks.ui_analyzer_results.minimal` | array | Platform IDs with minimal UI analysis |
|
|
@@ -203,7 +203,7 @@ Platform Technology Documents Generated: {{platform_id}}
|
|
|
203
203
|
**Relative Path Calculation**: Documents at `speccrew-workspace/knowledges/techs/{platform_id}/` are 4 levels deep. Use `../../../../` prefix to reference project root files.
|
|
204
204
|
|
|
205
205
|
**Required Elements**:
|
|
206
|
-
1.
|
|
206
|
+
1. File reference block at document beginning listing referenced files (pure Markdown format, previously used `<cite>` tags removed for VS Code preview compatibility)
|
|
207
207
|
2. `**Diagram Source**` annotation after each Mermaid diagram
|
|
208
208
|
3. `**Section Source**` annotation at end of major sections
|
|
209
209
|
|
package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/ARCHITECTURE-TEMPLATE.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Architecture Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}](file://{{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-BUILD-TEMPLATE.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Build & Deployment Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}](file://{{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DATA-TEMPLATE.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Data Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}](file://{{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DESIGN-TEMPLATE.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Design Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}]({{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DEV-TEMPLATE.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Development Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}]({{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} System Testing Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}]({{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Testing Conventions
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}]({{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# {{platform_name}} Technology Stack
|
|
2
2
|
|
|
3
|
-
<cite>
|
|
4
3
|
**Files Referenced in This Document**
|
|
4
|
+
|
|
5
5
|
{{#each source_files}}
|
|
6
6
|
- [{{name}}](file://{{path}})
|
|
7
7
|
{{/each}}
|
|
8
|
-
</cite>
|
|
9
8
|
|
|
10
9
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
10
|
|
|
@@ -434,10 +434,9 @@ All generated documents must follow this structure:
|
|
|
434
434
|
```markdown
|
|
435
435
|
# {{platform_name}} {{document_type}}
|
|
436
436
|
|
|
437
|
-
<cite>
|
|
438
437
|
**Files Referenced in This Document**
|
|
438
|
+
|
|
439
439
|
{{source_files}}
|
|
440
|
-
</cite>
|
|
441
440
|
|
|
442
441
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
443
442
|
|
|
@@ -489,18 +488,19 @@ For root INDEX.md (one level less deep):
|
|
|
489
488
|
- Document: `speccrew-workspace/knowledges/techs/INDEX.md`
|
|
490
489
|
- Prefix: `../../../` (3 levels)
|
|
491
490
|
|
|
492
|
-
**1. File Reference Block
|
|
491
|
+
**1. File Reference Block**
|
|
493
492
|
|
|
494
|
-
Place at the beginning of each document:
|
|
493
|
+
Place at the beginning of each document (using pure Markdown format for VS Code preview compatibility):
|
|
495
494
|
|
|
496
495
|
```markdown
|
|
497
|
-
<cite>
|
|
498
496
|
**Files Referenced in This Document**
|
|
497
|
+
|
|
499
498
|
- [package.json](../../../../yudao-ui/yudao-ui-admin-vue3/package.json)
|
|
500
499
|
- [tsconfig.json](../../../../yudao-ui/yudao-ui-admin-vue3/tsconfig.json)
|
|
501
|
-
</cite>
|
|
502
500
|
```
|
|
503
501
|
|
|
502
|
+
> **Note**: Previously used `<cite>` HTML tags have been removed because they prevent Markdown links from rendering correctly in VS Code preview.
|
|
503
|
+
|
|
504
504
|
**2. Diagram Source Annotation**
|
|
505
505
|
|
|
506
506
|
After each Mermaid diagram:
|
|
@@ -655,7 +655,7 @@ Upon completion, output the following structured report:
|
|
|
655
655
|
|
|
656
656
|
### Quality Checks
|
|
657
657
|
- [ ] All files written to output_path
|
|
658
|
-
- [ ] **Source traceability**:
|
|
658
|
+
- [ ] **Source traceability**: File reference block added to each document
|
|
659
659
|
- [ ] **Source traceability**: Diagram Source annotations added after each Mermaid diagram
|
|
660
660
|
- [ ] **Source traceability**: Section Source annotations added at end of major sections
|
|
661
661
|
- [ ] **Mermaid compatibility**: No `style`, `direction`, `<br/>`, or nested subgraphs
|
|
@@ -197,10 +197,10 @@ Verify `conventions-design.md` contains:
|
|
|
197
197
|
|
|
198
198
|
Verify that all documents properly cite their sources.
|
|
199
199
|
|
|
200
|
-
**5.1 File Reference Block
|
|
200
|
+
**5.1 File Reference Block Check**:
|
|
201
201
|
|
|
202
202
|
For each document, verify:
|
|
203
|
-
- [ ]
|
|
203
|
+
- [ ] File reference block exists at document beginning (previously used `<cite>` tags, now use pure Markdown for VS Code preview compatibility)
|
|
204
204
|
- [ ] Contains list of referenced files
|
|
205
205
|
- [ ] File paths use relative paths (NOT absolute or file://)
|
|
206
206
|
|
|
@@ -170,10 +170,9 @@ Read each platform's INDEX.md to extract:
|
|
|
170
170
|
```markdown
|
|
171
171
|
# Technology Knowledge Index
|
|
172
172
|
|
|
173
|
-
<cite>
|
|
174
173
|
**Files Referenced in This Document**
|
|
174
|
+
|
|
175
175
|
- [techs-manifest.json](../../../speccrew-workspace/knowledges/techs/techs-manifest.json)
|
|
176
|
-
</cite>
|
|
177
176
|
|
|
178
177
|
> **Target Audience**: devcrew-designer-*, devcrew-dev-*, devcrew-test-*
|
|
179
178
|
|
|
@@ -446,7 +445,7 @@ Use template at `templates/INDEX-TEMPLATE.md`:
|
|
|
446
445
|
### Quality & Validation
|
|
447
446
|
- [ ] No broken links to non-existent documents
|
|
448
447
|
- [ ] conventions-data.md links only included for platforms where it exists
|
|
449
|
-
- [ ] **Source traceability**:
|
|
448
|
+
- [ ] **Source traceability**: File reference block added to root INDEX.md
|
|
450
449
|
- [ ] **Source traceability**: Section Source annotations added at end of major sections
|
|
451
450
|
- [ ] Output file written successfully
|
|
452
451
|
- [ ] Results reported with document availability summary
|
package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-LIBRARY-TEMPLATE.md
CHANGED
|
@@ -6,10 +6,9 @@ output_file: components/component-library.md
|
|
|
6
6
|
|
|
7
7
|
# Component Library Inventory
|
|
8
8
|
|
|
9
|
-
<cite>
|
|
10
9
|
**Files Referenced in This Document**
|
|
10
|
+
|
|
11
11
|
{{source_files}}
|
|
12
|
-
</cite>
|
|
13
12
|
|
|
14
13
|
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}
|
|
15
14
|
|