scene-capability-engine 3.0.0 → 3.0.2
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/CHANGELOG.md +234 -233
- package/LICENSE +2 -2
- package/README.md +8 -11
- package/README.zh.md +7 -10
- package/bin/kse.js +1 -1
- package/bin/sce.js +1 -1
- package/bin/sco.js +1 -1
- package/docs/331-poc-adaptation-roadmap.md +25 -25
- package/docs/331-poc-dual-track-integration-guide.md +26 -26
- package/docs/331-poc-weekly-delivery-checklist.md +8 -8
- package/docs/OFFLINE_INSTALL.md +10 -10
- package/docs/README.md +24 -24
- package/docs/adopt-migration-guide.md +51 -51
- package/docs/adoption-guide.md +56 -56
- package/docs/agent-hooks-analysis.md +52 -52
- package/docs/architecture.md +6 -6
- package/docs/articles/ai-driven-development-philosophy-and-practice-review.md +4 -4
- package/docs/articles/ai-driven-development-philosophy-and-practice.en.md +9 -9
- package/docs/articles/ai-driven-development-philosophy-and-practice.md +10 -10
- package/docs/autonomous-control-guide.md +89 -89
- package/docs/command-reference.md +11 -11
- package/docs/community.md +4 -4
- package/docs/cross-tool-guide.md +47 -47
- package/docs/developer-guide.md +5 -5
- package/docs/document-governance.md +91 -91
- package/docs/environment-management-guide.md +53 -53
- package/docs/examples/add-export-command/design.md +2 -2
- package/docs/examples/add-export-command/requirements.md +5 -5
- package/docs/examples/add-export-command/tasks.md +2 -2
- package/docs/faq.md +69 -69
- package/docs/handoffs/evidence/ontology/moqui-template-baseline-2026-02-17-232922.json +9 -9
- package/docs/handoffs/evidence/ontology/moqui-template-baseline-2026-02-17-232922.md +3 -3
- package/docs/integration-modes.md +60 -60
- package/docs/integration-philosophy.md +48 -48
- package/docs/knowledge-management-guide.md +21 -21
- package/docs/manual-workflows-guide.md +20 -20
- package/docs/moqui-capability-matrix.md +22 -22
- package/docs/moqui-template-core-library-playbook.md +20 -20
- package/docs/multi-agent-coordination-guide.md +19 -19
- package/docs/multi-repo-management-guide.md +93 -93
- package/docs/quick-start-with-ai-tools.md +36 -36
- package/docs/quick-start.md +16 -16
- package/docs/release-checklist.md +7 -7
- package/docs/releases/v1.46.2-validation.md +1 -1
- package/docs/releases/v1.46.2.md +10 -10
- package/docs/scene-runtime-guide.md +42 -42
- package/docs/spec-collaboration-guide.md +43 -43
- package/docs/spec-locking-guide.md +26 -26
- package/docs/spec-numbering-guide.md +6 -6
- package/docs/spec-workflow.md +25 -25
- package/docs/steering-strategy-guide.md +36 -36
- package/docs/team-collaboration-guide.md +23 -23
- package/docs/testing-strategy.md +2 -2
- package/docs/tools/claude-guide.md +26 -26
- package/docs/tools/cursor-guide.md +31 -31
- package/docs/tools/generic-guide.md +22 -22
- package/docs/tools/kiro-guide.md +43 -43
- package/docs/tools/vscode-guide.md +18 -18
- package/docs/tools/windsurf-guide.md +50 -50
- package/docs/troubleshooting.md +116 -116
- package/docs/upgrade-guide.md +49 -49
- package/docs/value-observability-guide.md +6 -6
- package/docs/zh/README.md +22 -22
- package/docs/zh/quick-start.md +34 -34
- package/docs/zh/release-checklist.md +6 -6
- package/docs/zh/releases/v1.46.2-validation.md +1 -1
- package/docs/zh/releases/v1.46.2.md +9 -9
- package/docs/zh/spec-numbering-guide.md +6 -6
- package/docs/zh/tools/claude-guide.md +14 -14
- package/docs/zh/tools/cursor-guide.md +18 -18
- package/docs/zh/tools/generic-guide.md +40 -40
- package/docs/zh/tools/kiro-guide.md +50 -50
- package/docs/zh/tools/vscode-guide.md +20 -20
- package/docs/zh/tools/windsurf-guide.md +49 -49
- package/docs/zh/value-observability-guide.md +6 -6
- package/docs//344/272/244/344/273/230/346/270/205/345/215/225.md +4 -4
- package/lib/adoption/adoption-logger.js +1 -1
- package/lib/adoption/adoption-strategy.js +3 -3
- package/lib/adoption/detection-engine.js +1 -1
- package/lib/adoption/error-formatter.js +17 -17
- package/lib/adoption/progress-reporter.js +2 -2
- package/lib/adoption/smart-orchestrator.js +2 -2
- package/lib/adoption/strategy-selector.js +2 -2
- package/lib/adoption/summary-generator.js +3 -3
- package/lib/auto/autonomous-engine.js +2 -2
- package/lib/auto/close-loop-runner.js +9 -9
- package/lib/backup/backup-system.js +2 -2
- package/lib/collab/collab-manager.js +2 -2
- package/lib/commands/adopt.js +16 -16
- package/lib/commands/auto.js +93 -93
- package/lib/commands/collab.js +8 -8
- package/lib/commands/docs.js +26 -26
- package/lib/commands/doctor.js +2 -2
- package/lib/commands/env.js +14 -14
- package/lib/commands/knowledge.js +13 -13
- package/lib/commands/lock.js +6 -6
- package/lib/commands/ops.js +19 -19
- package/lib/commands/orchestrate.js +5 -5
- package/lib/commands/prompt.js +3 -3
- package/lib/commands/rollback.js +4 -4
- package/lib/commands/scene.js +29 -29
- package/lib/commands/spec-bootstrap.js +1 -1
- package/lib/commands/spec-gate.js +1 -1
- package/lib/commands/spec-pipeline.js +1 -1
- package/lib/commands/task.js +1 -1
- package/lib/commands/templates.js +27 -27
- package/lib/commands/upgrade.js +8 -8
- package/lib/commands/value.js +4 -4
- package/lib/commands/watch.js +9 -9
- package/lib/commands/workflows.js +5 -5
- package/lib/commands/workspace-multi.js +17 -17
- package/lib/commands/workspace.js +5 -5
- package/lib/context/context-exporter.js +1 -1
- package/lib/context/prompt-generator.js +1 -1
- package/lib/data/moqui-capability-lexicon.json +1 -1
- package/lib/environment/environment-manager.js +1 -1
- package/lib/gitignore/gitignore-detector.js +4 -4
- package/lib/gitignore/gitignore-integration.js +2 -2
- package/lib/gitignore/gitignore-transformer.js +3 -3
- package/lib/gitignore/layered-rules-template.js +2 -2
- package/lib/governance/diagnostic-engine.js +4 -4
- package/lib/governance/doc-reference-checker.js +1 -1
- package/lib/governance/hooks-manager.js +5 -5
- package/lib/governance/reporter.js +1 -1
- package/lib/knowledge/knowledge-manager.js +6 -6
- package/lib/orchestrator/agent-spawner.js +1 -1
- package/lib/orchestrator/bootstrap-prompt-builder.js +2 -2
- package/lib/repo/config-manager.js +2 -2
- package/lib/repo/handlers/init-handler.js +3 -3
- package/lib/scene-runtime/audit-emitter.js +2 -2
- package/lib/scene-runtime/binding-plugin-loader.js +1 -1
- package/lib/scene-runtime/moqui-adapter.js +2 -2
- package/lib/scene-runtime/moqui-extractor.js +3 -3
- package/lib/scene-runtime/scene-loader.js +3 -3
- package/lib/scene-runtime/scene-template-linter.js +1 -1
- package/lib/scene-runtime/templates/scene-template-erp-query-v0.1.yaml +1 -1
- package/lib/scene-runtime/templates/scene-template-hybrid-shadow-v0.1.yaml +1 -1
- package/lib/spec/multi-spec-orchestrate.js +1 -1
- package/lib/spec-gate/rules/default-rules.js +1 -1
- package/lib/steering/adoption-config.js +1 -1
- package/lib/steering/compliance-auto-fixer.js +1 -1
- package/lib/steering/compliance-cache.js +3 -3
- package/lib/steering/compliance-error-reporter.js +1 -1
- package/lib/steering/index.js +1 -1
- package/lib/steering/steering-manager.js +7 -7
- package/lib/task/task-claimer.js +2 -1
- package/lib/templates/metadata-collector.js +6 -6
- package/lib/templates/template-creator.js +2 -2
- package/lib/templates/template-exporter.js +12 -12
- package/lib/upgrade/migration-engine.js +4 -4
- package/lib/utils/tool-detector.js +25 -25
- package/lib/utils/validation.js +3 -3
- package/lib/version/version-checker.js +13 -13
- package/lib/version/version-manager.js +7 -7
- package/lib/watch/presets.js +4 -4
- package/lib/workspace/multi/path-utils.js +1 -1
- package/lib/workspace/multi/workspace-context-resolver.js +9 -9
- package/lib/workspace/multi/workspace-registry.js +2 -2
- package/lib/workspace/multi/workspace-state-manager.js +1 -1
- package/lib/workspace/multi/workspace.js +1 -1
- package/lib/workspace/workspace-sync.js +1 -1
- package/locales/en.json +1 -1
- package/locales/zh.json +1 -1
- package/package.json +5 -6
- package/template/.kiro/README.md +40 -40
- package/template/.kiro/specs/SPEC_WORKFLOW_GUIDE.md +3 -3
- package/template/.kiro/steering/CORE_PRINCIPLES.md +3 -3
- package/template/.kiro/steering/ENVIRONMENT.md +2 -2
- package/template/README.md +3 -3
- /package/bin/{kiro-spec-engine.js → scene-capability-engine.js} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Document Governance Guide
|
|
2
2
|
|
|
3
|
-
> Automated document lifecycle management for
|
|
3
|
+
> Automated document lifecycle management for sce projects
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
## Overview
|
|
15
15
|
|
|
16
|
-
The **Document Governance System** automatically enforces document lifecycle management rules in your
|
|
16
|
+
The **Document Governance System** automatically enforces document lifecycle management rules in your sce project. It helps you maintain clean, well-organized documentation by detecting violations, cleaning up temporary files, validating structure, and organizing artifacts.
|
|
17
17
|
|
|
18
18
|
### What is Document Governance?
|
|
19
19
|
|
|
@@ -39,7 +39,7 @@ Document governance ensures your project follows these rules:
|
|
|
39
39
|
### 1. Check Your Project's Compliance
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
|
|
42
|
+
sce docs diagnose
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
**Output:**
|
|
@@ -63,48 +63,48 @@ Spec Violations (1)
|
|
|
63
63
|
→ Move to reports/ subdirectory
|
|
64
64
|
|
|
65
65
|
💡 Recommended Actions
|
|
66
|
-
• Run '
|
|
67
|
-
• Run '
|
|
66
|
+
• Run 'sce docs cleanup' to remove temporary files
|
|
67
|
+
• Run 'sce docs archive --spec 01-00-user-login' to organize artifacts
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
### 2. Clean Up Temporary Files
|
|
71
71
|
|
|
72
72
|
```bash
|
|
73
73
|
# Preview what would be deleted
|
|
74
|
-
|
|
74
|
+
sce docs cleanup --dry-run
|
|
75
75
|
|
|
76
76
|
# Actually delete temporary files
|
|
77
|
-
|
|
77
|
+
sce docs cleanup
|
|
78
78
|
```
|
|
79
79
|
|
|
80
80
|
### 3. Organize Spec Artifacts
|
|
81
81
|
|
|
82
82
|
```bash
|
|
83
83
|
# Preview what would be moved
|
|
84
|
-
|
|
84
|
+
sce docs archive --spec 01-00-user-login --dry-run
|
|
85
85
|
|
|
86
86
|
# Actually move artifacts to subdirectories
|
|
87
|
-
|
|
87
|
+
sce docs archive --spec 01-00-user-login
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
### 4. Validate Structure
|
|
91
91
|
|
|
92
92
|
```bash
|
|
93
93
|
# Validate root directory
|
|
94
|
-
|
|
94
|
+
sce docs validate
|
|
95
95
|
|
|
96
96
|
# Validate all Specs
|
|
97
|
-
|
|
97
|
+
sce docs validate --all
|
|
98
98
|
|
|
99
99
|
# Validate specific Spec
|
|
100
|
-
|
|
100
|
+
sce docs validate --spec 01-00-user-login
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
### 5. Prevent Future Violations
|
|
104
104
|
|
|
105
105
|
```bash
|
|
106
106
|
# Install Git pre-commit hook
|
|
107
|
-
|
|
107
|
+
sce docs hooks install
|
|
108
108
|
|
|
109
109
|
# Now commits will be blocked if violations exist
|
|
110
110
|
git commit -m "Add feature"
|
|
@@ -115,13 +115,13 @@ git commit -m "Add feature"
|
|
|
115
115
|
|
|
116
116
|
## Commands Reference
|
|
117
117
|
|
|
118
|
-
### `
|
|
118
|
+
### `sce docs diagnose`
|
|
119
119
|
|
|
120
120
|
Scan your project for document violations.
|
|
121
121
|
|
|
122
122
|
**Usage:**
|
|
123
123
|
```bash
|
|
124
|
-
|
|
124
|
+
sce docs diagnose
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
**What it checks:**
|
|
@@ -143,7 +143,7 @@ kse docs diagnose
|
|
|
143
143
|
|
|
144
144
|
**Example:**
|
|
145
145
|
```bash
|
|
146
|
-
$
|
|
146
|
+
$ sce docs diagnose
|
|
147
147
|
|
|
148
148
|
🔥 Document Governance Diagnostic
|
|
149
149
|
|
|
@@ -153,13 +153,13 @@ All documents follow the lifecycle management rules.
|
|
|
153
153
|
|
|
154
154
|
---
|
|
155
155
|
|
|
156
|
-
### `
|
|
156
|
+
### `sce docs cleanup`
|
|
157
157
|
|
|
158
158
|
Remove temporary documents from your project.
|
|
159
159
|
|
|
160
160
|
**Usage:**
|
|
161
161
|
```bash
|
|
162
|
-
|
|
162
|
+
sce docs cleanup [options]
|
|
163
163
|
```
|
|
164
164
|
|
|
165
165
|
**Options:**
|
|
@@ -180,7 +180,7 @@ kse docs cleanup [options]
|
|
|
180
180
|
|
|
181
181
|
**Preview cleanup:**
|
|
182
182
|
```bash
|
|
183
|
-
$
|
|
183
|
+
$ sce docs cleanup --dry-run
|
|
184
184
|
|
|
185
185
|
🔥 Cleanup Preview (Dry Run)
|
|
186
186
|
|
|
@@ -195,7 +195,7 @@ Run without --dry-run to actually delete these files
|
|
|
195
195
|
|
|
196
196
|
**Interactive cleanup:**
|
|
197
197
|
```bash
|
|
198
|
-
$
|
|
198
|
+
$ sce docs cleanup --interactive
|
|
199
199
|
|
|
200
200
|
Delete /project/MVP-PLAN.md? (y/n): y
|
|
201
201
|
✓ Deleted
|
|
@@ -208,7 +208,7 @@ Deleted 1 file(s)
|
|
|
208
208
|
|
|
209
209
|
**Clean specific Spec:**
|
|
210
210
|
```bash
|
|
211
|
-
$
|
|
211
|
+
$ sce docs cleanup --spec 01-00-user-login
|
|
212
212
|
|
|
213
213
|
🔥 Cleanup Complete
|
|
214
214
|
|
|
@@ -224,13 +224,13 @@ Deleted 1 file(s):
|
|
|
224
224
|
|
|
225
225
|
---
|
|
226
226
|
|
|
227
|
-
### `
|
|
227
|
+
### `sce docs validate`
|
|
228
228
|
|
|
229
229
|
Validate document structure against governance rules.
|
|
230
230
|
|
|
231
231
|
**Usage:**
|
|
232
232
|
```bash
|
|
233
|
-
|
|
233
|
+
sce docs validate [options]
|
|
234
234
|
```
|
|
235
235
|
|
|
236
236
|
**Options:**
|
|
@@ -247,7 +247,7 @@ kse docs validate [options]
|
|
|
247
247
|
|
|
248
248
|
**Validate root directory:**
|
|
249
249
|
```bash
|
|
250
|
-
$
|
|
250
|
+
$ sce docs validate
|
|
251
251
|
|
|
252
252
|
🔥 Document Structure Validation
|
|
253
253
|
|
|
@@ -257,7 +257,7 @@ All document structures are compliant.
|
|
|
257
257
|
|
|
258
258
|
**Validate with errors:**
|
|
259
259
|
```bash
|
|
260
|
-
$
|
|
260
|
+
$ sce docs validate --all
|
|
261
261
|
|
|
262
262
|
🔥 Document Structure Validation
|
|
263
263
|
|
|
@@ -284,13 +284,13 @@ $ kse docs validate --all
|
|
|
284
284
|
|
|
285
285
|
---
|
|
286
286
|
|
|
287
|
-
### `
|
|
287
|
+
### `sce docs archive`
|
|
288
288
|
|
|
289
289
|
Organize Spec artifacts into proper subdirectories.
|
|
290
290
|
|
|
291
291
|
**Usage:**
|
|
292
292
|
```bash
|
|
293
|
-
|
|
293
|
+
sce docs archive --spec <spec-name> [options]
|
|
294
294
|
```
|
|
295
295
|
|
|
296
296
|
**Options:**
|
|
@@ -312,7 +312,7 @@ kse docs archive --spec <spec-name> [options]
|
|
|
312
312
|
|
|
313
313
|
**Preview archive:**
|
|
314
314
|
```bash
|
|
315
|
-
$
|
|
315
|
+
$ sce docs archive --spec 01-00-user-login --dry-run
|
|
316
316
|
|
|
317
317
|
🔥 Archive Preview (Dry Run)
|
|
318
318
|
|
|
@@ -332,7 +332,7 @@ Run without --dry-run to actually move these files
|
|
|
332
332
|
|
|
333
333
|
**Actually archive:**
|
|
334
334
|
```bash
|
|
335
|
-
$
|
|
335
|
+
$ sce docs archive --spec 01-00-user-login
|
|
336
336
|
|
|
337
337
|
🔥 Archive Complete
|
|
338
338
|
|
|
@@ -351,13 +351,13 @@ Moved 3 file(s):
|
|
|
351
351
|
|
|
352
352
|
---
|
|
353
353
|
|
|
354
|
-
### `
|
|
354
|
+
### `sce docs hooks`
|
|
355
355
|
|
|
356
356
|
Manage Git hooks for document governance.
|
|
357
357
|
|
|
358
358
|
**Usage:**
|
|
359
359
|
```bash
|
|
360
|
-
|
|
360
|
+
sce docs hooks <action>
|
|
361
361
|
```
|
|
362
362
|
|
|
363
363
|
**Actions:**
|
|
@@ -366,7 +366,7 @@ kse docs hooks <action>
|
|
|
366
366
|
- `status` - Check if hooks are installed
|
|
367
367
|
|
|
368
368
|
**What the hook does:**
|
|
369
|
-
- Runs `
|
|
369
|
+
- Runs `sce docs validate` before each commit
|
|
370
370
|
- Blocks commit if violations are found
|
|
371
371
|
- Shows violations and how to fix them
|
|
372
372
|
- Can be bypassed with `git commit --no-verify`
|
|
@@ -375,7 +375,7 @@ kse docs hooks <action>
|
|
|
375
375
|
|
|
376
376
|
**Install hooks:**
|
|
377
377
|
```bash
|
|
378
|
-
$
|
|
378
|
+
$ sce docs hooks install
|
|
379
379
|
|
|
380
380
|
🔧 Installing document governance hooks...
|
|
381
381
|
|
|
@@ -388,7 +388,7 @@ To bypass validation, use: git commit --no-verify
|
|
|
388
388
|
|
|
389
389
|
**Check status:**
|
|
390
390
|
```bash
|
|
391
|
-
$
|
|
391
|
+
$ sce docs hooks status
|
|
392
392
|
|
|
393
393
|
🔍 Checking Git hooks status...
|
|
394
394
|
|
|
@@ -398,7 +398,7 @@ $ kse docs hooks status
|
|
|
398
398
|
|
|
399
399
|
**Uninstall hooks:**
|
|
400
400
|
```bash
|
|
401
|
-
$
|
|
401
|
+
$ sce docs hooks uninstall
|
|
402
402
|
|
|
403
403
|
🔧 Uninstalling document governance hooks...
|
|
404
404
|
|
|
@@ -419,7 +419,7 @@ Found 2 violation(s):
|
|
|
419
419
|
|
|
420
420
|
Fix violations and try again, or use --no-verify to bypass.
|
|
421
421
|
|
|
422
|
-
Run '
|
|
422
|
+
Run 'sce docs diagnose' for details.
|
|
423
423
|
```
|
|
424
424
|
|
|
425
425
|
**Exit codes:**
|
|
@@ -428,13 +428,13 @@ Run 'kse docs diagnose' for details.
|
|
|
428
428
|
|
|
429
429
|
---
|
|
430
430
|
|
|
431
|
-
### `
|
|
431
|
+
### `sce docs config`
|
|
432
432
|
|
|
433
433
|
Display or modify document governance configuration.
|
|
434
434
|
|
|
435
435
|
**Usage:**
|
|
436
436
|
```bash
|
|
437
|
-
|
|
437
|
+
sce docs config [options]
|
|
438
438
|
```
|
|
439
439
|
|
|
440
440
|
**Options:**
|
|
@@ -450,7 +450,7 @@ kse docs config [options]
|
|
|
450
450
|
|
|
451
451
|
**Display configuration:**
|
|
452
452
|
```bash
|
|
453
|
-
$
|
|
453
|
+
$ sce docs config
|
|
454
454
|
|
|
455
455
|
⚙️ Document Governance Configuration
|
|
456
456
|
|
|
@@ -476,13 +476,13 @@ Temporary Patterns:
|
|
|
476
476
|
• MVP-*.md
|
|
477
477
|
|
|
478
478
|
Configuration file: .kiro/config/docs.json
|
|
479
|
-
To modify:
|
|
480
|
-
To reset:
|
|
479
|
+
To modify: sce docs config --set <key> <value>
|
|
480
|
+
To reset: sce docs config --reset
|
|
481
481
|
```
|
|
482
482
|
|
|
483
483
|
**Set configuration:**
|
|
484
484
|
```bash
|
|
485
|
-
$
|
|
485
|
+
$ sce docs config --set root-allowed-files "README.md,CUSTOM.md,LICENSE.md"
|
|
486
486
|
|
|
487
487
|
✅ Configuration updated: root-allowed-files
|
|
488
488
|
New value: README.md, CUSTOM.md, LICENSE.md
|
|
@@ -490,12 +490,12 @@ $ kse docs config --set root-allowed-files "README.md,CUSTOM.md,LICENSE.md"
|
|
|
490
490
|
|
|
491
491
|
**Reset configuration:**
|
|
492
492
|
```bash
|
|
493
|
-
$
|
|
493
|
+
$ sce docs config --reset
|
|
494
494
|
|
|
495
495
|
⚠️ Resetting configuration to defaults...
|
|
496
496
|
|
|
497
497
|
✅ Configuration reset to defaults
|
|
498
|
-
Run "
|
|
498
|
+
Run "sce docs config" to view current configuration
|
|
499
499
|
```
|
|
500
500
|
|
|
501
501
|
**Exit codes:**
|
|
@@ -505,13 +505,13 @@ $ kse docs config --reset
|
|
|
505
505
|
|
|
506
506
|
---
|
|
507
507
|
|
|
508
|
-
### `
|
|
508
|
+
### `sce docs stats`
|
|
509
509
|
|
|
510
510
|
Display document compliance statistics.
|
|
511
511
|
|
|
512
512
|
**Usage:**
|
|
513
513
|
```bash
|
|
514
|
-
|
|
514
|
+
sce docs stats
|
|
515
515
|
```
|
|
516
516
|
|
|
517
517
|
**What it shows:**
|
|
@@ -525,7 +525,7 @@ kse docs stats
|
|
|
525
525
|
|
|
526
526
|
**Example:**
|
|
527
527
|
```bash
|
|
528
|
-
$
|
|
528
|
+
$ sce docs stats
|
|
529
529
|
|
|
530
530
|
📊 Document Compliance Statistics
|
|
531
531
|
|
|
@@ -558,13 +558,13 @@ Recent Activity:
|
|
|
558
558
|
|
|
559
559
|
---
|
|
560
560
|
|
|
561
|
-
### `
|
|
561
|
+
### `sce docs report`
|
|
562
562
|
|
|
563
563
|
Generate a comprehensive compliance report.
|
|
564
564
|
|
|
565
565
|
**Usage:**
|
|
566
566
|
```bash
|
|
567
|
-
|
|
567
|
+
sce docs report
|
|
568
568
|
```
|
|
569
569
|
|
|
570
570
|
**What it generates:**
|
|
@@ -576,7 +576,7 @@ kse docs report
|
|
|
576
576
|
|
|
577
577
|
**Example:**
|
|
578
578
|
```bash
|
|
579
|
-
$
|
|
579
|
+
$ sce docs report
|
|
580
580
|
|
|
581
581
|
✅ Compliance report generated
|
|
582
582
|
Saved to: .kiro/reports/document-compliance-2024-01-24.md
|
|
@@ -613,18 +613,18 @@ $ kse docs report
|
|
|
613
613
|
|
|
614
614
|
**1. Start of day - Check compliance:**
|
|
615
615
|
```bash
|
|
616
|
-
|
|
616
|
+
sce docs diagnose
|
|
617
617
|
```
|
|
618
618
|
|
|
619
619
|
**2. Before committing - Validate:**
|
|
620
620
|
```bash
|
|
621
|
-
|
|
621
|
+
sce docs validate --all
|
|
622
622
|
```
|
|
623
623
|
|
|
624
624
|
**3. End of feature - Clean up:**
|
|
625
625
|
```bash
|
|
626
|
-
|
|
627
|
-
|
|
626
|
+
sce docs cleanup
|
|
627
|
+
sce docs archive --spec your-spec
|
|
628
628
|
```
|
|
629
629
|
|
|
630
630
|
### Spec Lifecycle
|
|
@@ -632,30 +632,30 @@ kse docs archive --spec your-spec
|
|
|
632
632
|
**When creating a Spec:**
|
|
633
633
|
```bash
|
|
634
634
|
# 1. Create Spec
|
|
635
|
-
|
|
635
|
+
sce spec bootstrap --name 01-00-new-feature --non-interactive
|
|
636
636
|
|
|
637
637
|
# 2. Verify structure
|
|
638
|
-
|
|
638
|
+
sce docs validate --spec 01-00-new-feature
|
|
639
639
|
```
|
|
640
640
|
|
|
641
641
|
**During development:**
|
|
642
642
|
```bash
|
|
643
643
|
# Keep artifacts organized
|
|
644
|
-
|
|
644
|
+
sce docs archive --spec 01-00-new-feature --dry-run
|
|
645
645
|
# Review what would be moved, then:
|
|
646
|
-
|
|
646
|
+
sce docs archive --spec 01-00-new-feature
|
|
647
647
|
```
|
|
648
648
|
|
|
649
649
|
**When completing a Spec:**
|
|
650
650
|
```bash
|
|
651
651
|
# 1. Clean up temporary files
|
|
652
|
-
|
|
652
|
+
sce docs cleanup --spec 01-00-new-feature
|
|
653
653
|
|
|
654
654
|
# 2. Organize all artifacts
|
|
655
|
-
|
|
655
|
+
sce docs archive --spec 01-00-new-feature
|
|
656
656
|
|
|
657
657
|
# 3. Validate final structure
|
|
658
|
-
|
|
658
|
+
sce docs validate --spec 01-00-new-feature
|
|
659
659
|
```
|
|
660
660
|
|
|
661
661
|
### Team Collaboration
|
|
@@ -663,19 +663,19 @@ kse docs validate --spec 01-00-new-feature
|
|
|
663
663
|
**Project setup:**
|
|
664
664
|
```bash
|
|
665
665
|
# 1. Install hooks for all team members
|
|
666
|
-
|
|
666
|
+
sce docs hooks install
|
|
667
667
|
|
|
668
668
|
# 2. Configure project-specific rules (if needed)
|
|
669
|
-
|
|
669
|
+
sce docs config --set root-allowed-files "README.md,README.zh.md,CHANGELOG.md,CONTRIBUTING.md,LICENSE.md"
|
|
670
670
|
```
|
|
671
671
|
|
|
672
672
|
**Code review:**
|
|
673
673
|
```bash
|
|
674
674
|
# Check compliance before reviewing
|
|
675
|
-
|
|
675
|
+
sce docs diagnose
|
|
676
676
|
|
|
677
677
|
# Generate report for team
|
|
678
|
-
|
|
678
|
+
sce docs report
|
|
679
679
|
```
|
|
680
680
|
|
|
681
681
|
### Automation
|
|
@@ -693,15 +693,15 @@ jobs:
|
|
|
693
693
|
steps:
|
|
694
694
|
- uses: actions/checkout@v2
|
|
695
695
|
- uses: actions/setup-node@v2
|
|
696
|
-
- run: npm install -g
|
|
697
|
-
- run:
|
|
698
|
-
- run:
|
|
696
|
+
- run: npm install -g scene-capability-engine
|
|
697
|
+
- run: sce docs diagnose
|
|
698
|
+
- run: sce docs validate --all
|
|
699
699
|
```
|
|
700
700
|
|
|
701
701
|
**Pre-commit hook (automatic):**
|
|
702
702
|
```bash
|
|
703
703
|
# Install once
|
|
704
|
-
|
|
704
|
+
sce docs hooks install
|
|
705
705
|
|
|
706
706
|
# Now every commit is validated automatically
|
|
707
707
|
git commit -m "Add feature"
|
|
@@ -746,17 +746,17 @@ The default configuration is:
|
|
|
746
746
|
|
|
747
747
|
**Add custom allowed files:**
|
|
748
748
|
```bash
|
|
749
|
-
|
|
749
|
+
sce docs config --set root-allowed-files "README.md,README.zh.md,CHANGELOG.md,CONTRIBUTING.md,LICENSE.md,SECURITY.md"
|
|
750
750
|
```
|
|
751
751
|
|
|
752
752
|
**Add custom subdirectories:**
|
|
753
753
|
```bash
|
|
754
|
-
|
|
754
|
+
sce docs config --set spec-subdirs "reports,scripts,tests,results,docs,diagrams,examples"
|
|
755
755
|
```
|
|
756
756
|
|
|
757
757
|
**Add custom temporary patterns:**
|
|
758
758
|
```bash
|
|
759
|
-
|
|
759
|
+
sce docs config --set temporary-patterns "*-SUMMARY.md,SESSION-*.md,*-COMPLETE.md,TEMP-*.md,WIP-*.md,MVP-*.md,DRAFT-*.md"
|
|
760
760
|
```
|
|
761
761
|
|
|
762
762
|
### Configuration File Location
|
|
@@ -796,22 +796,22 @@ chmod -R u+w .kiro/
|
|
|
796
796
|
git init
|
|
797
797
|
|
|
798
798
|
# Then install hooks
|
|
799
|
-
|
|
799
|
+
sce docs hooks install
|
|
800
800
|
```
|
|
801
801
|
|
|
802
802
|
**"Configuration file corrupted":**
|
|
803
803
|
```bash
|
|
804
804
|
# Reset to defaults
|
|
805
|
-
|
|
805
|
+
sce docs config --reset
|
|
806
806
|
```
|
|
807
807
|
|
|
808
808
|
**"Cleanup not removing files":**
|
|
809
809
|
```bash
|
|
810
810
|
# Check if files match temporary patterns
|
|
811
|
-
|
|
811
|
+
sce docs diagnose
|
|
812
812
|
|
|
813
813
|
# Use interactive mode to confirm
|
|
814
|
-
|
|
814
|
+
sce docs cleanup --interactive
|
|
815
815
|
```
|
|
816
816
|
|
|
817
817
|
---
|
|
@@ -819,7 +819,7 @@ kse docs cleanup --interactive
|
|
|
819
819
|
## Related Documentation
|
|
820
820
|
|
|
821
821
|
- **[Spec Workflow Guide](spec-workflow.md)** - Understanding Specs
|
|
822
|
-
- **[Command Reference](command-reference.md)** - All
|
|
822
|
+
- **[Command Reference](command-reference.md)** - All sce commands
|
|
823
823
|
- **[Troubleshooting Guide](troubleshooting.md)** - Common issues
|
|
824
824
|
- **[Quick Start Guide](quick-start.md)** - Getting started
|
|
825
825
|
|
|
@@ -828,34 +828,34 @@ kse docs cleanup --interactive
|
|
|
828
828
|
## Summary
|
|
829
829
|
|
|
830
830
|
**Document Governance Commands:**
|
|
831
|
-
- `
|
|
832
|
-
- `
|
|
833
|
-
- `
|
|
834
|
-
- `
|
|
835
|
-
- `
|
|
836
|
-
- `
|
|
837
|
-
- `
|
|
838
|
-
- `
|
|
831
|
+
- `sce docs diagnose` - Find violations
|
|
832
|
+
- `sce docs cleanup` - Remove temporary files
|
|
833
|
+
- `sce docs validate` - Check structure
|
|
834
|
+
- `sce docs archive` - Organize artifacts
|
|
835
|
+
- `sce docs hooks` - Manage Git hooks
|
|
836
|
+
- `sce docs config` - Configure rules
|
|
837
|
+
- `sce docs stats` - View statistics
|
|
838
|
+
- `sce docs report` - Generate report
|
|
839
839
|
|
|
840
840
|
**Quick Workflow:**
|
|
841
841
|
```bash
|
|
842
842
|
# 1. Check compliance
|
|
843
|
-
|
|
843
|
+
sce docs diagnose
|
|
844
844
|
|
|
845
845
|
# 2. Fix violations
|
|
846
|
-
|
|
847
|
-
|
|
846
|
+
sce docs cleanup
|
|
847
|
+
sce docs archive --spec your-spec
|
|
848
848
|
|
|
849
849
|
# 3. Validate
|
|
850
|
-
|
|
850
|
+
sce docs validate --all
|
|
851
851
|
|
|
852
852
|
# 4. Prevent future violations
|
|
853
|
-
|
|
853
|
+
sce docs hooks install
|
|
854
854
|
```
|
|
855
855
|
|
|
856
856
|
**Start using document governance:** 🚀
|
|
857
857
|
```bash
|
|
858
|
-
|
|
858
|
+
sce docs diagnose
|
|
859
859
|
```
|
|
860
860
|
|
|
861
861
|
---
|