@pigcloud/skills 1.0.11 → 1.1.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 +25 -20
- package/README.en.md +41 -75
- package/README.md +26 -39
- package/bin/cli.js +260 -151
- package/bin/rules-loader.js +271 -484
- package/codex-commands/README.md +25 -23
- package/codex-commands/commands/analyze.md +21 -22
- package/codex-commands/commands/build.md +22 -22
- package/codex-commands/commands/design.md +21 -22
- package/codex-commands/commands/distill.md +21 -21
- package/codex-commands/commands/doc.md +21 -22
- package/codex-commands/commands/infra.md +21 -21
- package/codex-commands/commands/init.md +20 -20
- package/codex-commands/commands/kb.md +21 -20
- package/codex-commands/commands/perf.md +21 -21
- package/codex-commands/commands/prd.md +21 -22
- package/codex-commands/commands/review.md +21 -22
- package/codex-commands/commands/security.md +21 -22
- package/codex-commands/commands/test.md +21 -21
- package/codex-commands/commands/workflow.md +21 -20
- package/package.json +5 -2
- package/rules/core/index.md +26 -41
- package/rules/delivery/index.md +25 -0
- package/rules/design/index.md +25 -0
- package/rules/discovery/index.md +25 -0
- package/rules/implementation/index.md +25 -0
- package/rules/index.md +24 -39
- package/rules/overlays/index.md +19 -19
- package/rules/overlays/pig-cloud.md +20 -45
- package/rules/shared/index.md +25 -0
- package/rules/skill-stage-map.json +26 -0
- package/rules/stages.json +48 -0
- package/rules/validation/index.md +25 -0
- package/scripts/add-skill-reference-nav.js +3 -0
- package/scripts/bootstrap-skill-specs.js +96 -0
- package/scripts/ci-validator.sh +51 -114
- package/scripts/generate-skill-prompt-library.js +3 -0
- package/scripts/golden-prompt-suite.current.js +211 -0
- package/scripts/migrate-skill-packages.js +309 -0
- package/scripts/run-golden-replays.js +110 -79
- package/scripts/validate-rules.js +128 -125
- package/scripts/validate-skill-replay-signals.js +45 -57
- package/scripts/validate-skill-shapes.js +153 -127
- package/scripts/validate-skill-stop-rules.js +54 -46
- package/skills/01-discovery/ambiguity-detection/SKILL.md +30 -0
- package/skills/01-discovery/ambiguity-detection/assets/golden-prompt-suite.current.js +22 -0
- package/skills/01-discovery/ambiguity-detection/references/README.md +17 -0
- package/skills/01-discovery/ambiguity-detection/references/cases.md +26 -0
- package/skills/01-discovery/ambiguity-detection/references/prompt-template.md +18 -0
- package/skills/01-discovery/ambiguity-detection/skill-spec.json +26 -0
- package/skills/01-discovery/business-analysis/SKILL.md +30 -0
- package/skills/01-discovery/business-analysis/assets/golden-prompt-suite.current.js +22 -0
- package/skills/01-discovery/business-analysis/references/README.md +17 -0
- package/skills/01-discovery/business-analysis/references/cases.md +26 -0
- package/skills/01-discovery/business-analysis/references/prompt-template.md +18 -0
- package/skills/01-discovery/business-analysis/skill-spec.json +26 -0
- package/skills/01-discovery/impact-analysis/SKILL.md +30 -0
- package/skills/01-discovery/impact-analysis/assets/golden-prompt-suite.current.js +22 -0
- package/skills/01-discovery/impact-analysis/references/README.md +17 -0
- package/skills/01-discovery/impact-analysis/references/cases.md +26 -0
- package/skills/01-discovery/impact-analysis/references/prompt-template.md +18 -0
- package/skills/01-discovery/impact-analysis/skill-spec.json +26 -0
- package/skills/01-discovery/requirement-discovery/SKILL.md +30 -0
- package/skills/01-discovery/requirement-discovery/assets/golden-prompt-suite.current.js +24 -0
- package/skills/01-discovery/requirement-discovery/references/README.md +17 -0
- package/skills/01-discovery/requirement-discovery/references/cases.md +28 -0
- package/skills/01-discovery/requirement-discovery/references/prompt-template.md +18 -0
- package/skills/01-discovery/requirement-discovery/skill-spec.json +26 -0
- package/skills/02-design/api-design/SKILL.md +29 -0
- package/skills/02-design/api-design/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/api-design/references/README.md +17 -0
- package/skills/02-design/api-design/references/cases.md +26 -0
- package/skills/02-design/api-design/references/prompt-template.md +18 -0
- package/skills/02-design/api-design/skill-spec.json +25 -0
- package/skills/02-design/architecture-design/SKILL.md +29 -0
- package/skills/02-design/architecture-design/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/architecture-design/references/README.md +17 -0
- package/skills/02-design/architecture-design/references/cases.md +26 -0
- package/skills/02-design/architecture-design/references/prompt-template.md +18 -0
- package/skills/02-design/architecture-design/skill-spec.json +25 -0
- package/skills/02-design/database-design/SKILL.md +29 -0
- package/skills/02-design/database-design/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/database-design/references/README.md +17 -0
- package/skills/02-design/database-design/references/cases.md +26 -0
- package/skills/02-design/database-design/references/prompt-template.md +18 -0
- package/skills/02-design/database-design/skill-spec.json +25 -0
- package/skills/02-design/task-breakdown/SKILL.md +29 -0
- package/skills/02-design/task-breakdown/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/task-breakdown/references/README.md +17 -0
- package/skills/02-design/task-breakdown/references/cases.md +26 -0
- package/skills/02-design/task-breakdown/references/prompt-template.md +18 -0
- package/skills/02-design/task-breakdown/skill-spec.json +25 -0
- package/skills/03-implementation/backend-development/SKILL.md +29 -0
- package/skills/03-implementation/backend-development/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/backend-development/references/README.md +17 -0
- package/skills/03-implementation/backend-development/references/cases.md +26 -0
- package/skills/03-implementation/backend-development/references/prompt-template.md +18 -0
- package/skills/03-implementation/backend-development/skill-spec.json +25 -0
- package/skills/03-implementation/bug-fix/SKILL.md +29 -0
- package/skills/03-implementation/bug-fix/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/bug-fix/references/README.md +17 -0
- package/skills/03-implementation/bug-fix/references/cases.md +26 -0
- package/skills/03-implementation/bug-fix/references/prompt-template.md +18 -0
- package/skills/03-implementation/bug-fix/skill-spec.json +25 -0
- package/skills/03-implementation/database-change/SKILL.md +29 -0
- package/skills/03-implementation/database-change/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/database-change/references/README.md +17 -0
- package/skills/03-implementation/database-change/references/cases.md +26 -0
- package/skills/03-implementation/database-change/references/prompt-template.md +18 -0
- package/skills/03-implementation/database-change/skill-spec.json +25 -0
- package/skills/03-implementation/frontend-development/SKILL.md +29 -0
- package/skills/03-implementation/frontend-development/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/frontend-development/references/README.md +17 -0
- package/skills/03-implementation/frontend-development/references/cases.md +26 -0
- package/skills/03-implementation/frontend-development/references/prompt-template.md +18 -0
- package/skills/03-implementation/frontend-development/skill-spec.json +25 -0
- package/skills/04-validation/code-review/SKILL.md +29 -0
- package/skills/04-validation/code-review/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/code-review/references/README.md +17 -0
- package/skills/04-validation/code-review/references/cases.md +26 -0
- package/skills/04-validation/code-review/references/prompt-template.md +18 -0
- package/skills/04-validation/code-review/skill-spec.json +25 -0
- package/skills/04-validation/performance-review/SKILL.md +29 -0
- package/skills/04-validation/performance-review/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/performance-review/references/README.md +17 -0
- package/skills/04-validation/performance-review/references/cases.md +26 -0
- package/skills/04-validation/performance-review/references/prompt-template.md +18 -0
- package/skills/04-validation/performance-review/skill-spec.json +25 -0
- package/skills/04-validation/regression-check/SKILL.md +29 -0
- package/skills/04-validation/regression-check/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/regression-check/references/README.md +17 -0
- package/skills/04-validation/regression-check/references/cases.md +26 -0
- package/skills/04-validation/regression-check/references/prompt-template.md +18 -0
- package/skills/04-validation/regression-check/skill-spec.json +25 -0
- package/skills/04-validation/security-review/SKILL.md +29 -0
- package/skills/04-validation/security-review/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/security-review/references/README.md +17 -0
- package/skills/04-validation/security-review/references/cases.md +26 -0
- package/skills/04-validation/security-review/references/prompt-template.md +18 -0
- package/skills/04-validation/security-review/skill-spec.json +25 -0
- package/skills/04-validation/unit-test/SKILL.md +29 -0
- package/skills/04-validation/unit-test/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/unit-test/references/README.md +17 -0
- package/skills/04-validation/unit-test/references/cases.md +26 -0
- package/skills/04-validation/unit-test/references/prompt-template.md +18 -0
- package/skills/04-validation/unit-test/skill-spec.json +25 -0
- package/skills/05-delivery/change-log/SKILL.md +29 -0
- package/skills/05-delivery/change-log/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/change-log/references/README.md +17 -0
- package/skills/05-delivery/change-log/references/cases.md +26 -0
- package/skills/05-delivery/change-log/references/prompt-template.md +18 -0
- package/skills/05-delivery/change-log/skill-spec.json +25 -0
- package/skills/05-delivery/deployment-guide/SKILL.md +29 -0
- package/skills/05-delivery/deployment-guide/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/deployment-guide/references/README.md +17 -0
- package/skills/05-delivery/deployment-guide/references/cases.md +26 -0
- package/skills/05-delivery/deployment-guide/references/prompt-template.md +18 -0
- package/skills/05-delivery/deployment-guide/skill-spec.json +25 -0
- package/skills/05-delivery/release-check/SKILL.md +29 -0
- package/skills/05-delivery/release-check/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/release-check/references/README.md +17 -0
- package/skills/05-delivery/release-check/references/cases.md +26 -0
- package/skills/05-delivery/release-check/references/prompt-template.md +18 -0
- package/skills/05-delivery/release-check/skill-spec.json +25 -0
- package/skills/05-delivery/release-validation/SKILL.md +29 -0
- package/skills/05-delivery/release-validation/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/release-validation/references/README.md +17 -0
- package/skills/05-delivery/release-validation/references/cases.md +26 -0
- package/skills/05-delivery/release-validation/references/prompt-template.md +18 -0
- package/skills/05-delivery/release-validation/skill-spec.json +25 -0
- package/skills/shared/codebase-learning/SKILL.md +29 -0
- package/skills/shared/codebase-learning/assets/golden-prompt-suite.current.js +22 -0
- package/skills/shared/codebase-learning/references/README.md +17 -0
- package/skills/shared/codebase-learning/references/cases.md +26 -0
- package/skills/shared/codebase-learning/references/prompt-template.md +18 -0
- package/skills/shared/codebase-learning/skill-spec.json +25 -0
- package/skills/shared/evidence-collector/SKILL.md +29 -0
- package/skills/shared/evidence-collector/assets/golden-prompt-suite.current.js +22 -0
- package/skills/shared/evidence-collector/references/README.md +17 -0
- package/skills/shared/evidence-collector/references/cases.md +26 -0
- package/skills/shared/evidence-collector/references/prompt-template.md +18 -0
- package/skills/shared/evidence-collector/skill-spec.json +25 -0
- package/skills/shared/framework-guide/SKILL.md +28 -0
- package/skills/shared/framework-guide/assets/golden-prompt-suite.current.js +22 -0
- package/skills/shared/framework-guide/references/README.md +17 -0
- package/skills/shared/framework-guide/references/cases.md +26 -0
- package/skills/shared/framework-guide/references/prompt-template.md +18 -0
- package/skills/shared/framework-guide/skill-spec.json +24 -0
- package/rules/bundles.json +0 -358
- package/rules/coding/analysis.md +0 -27
- package/rules/coding/backend/cache-invalidation.md +0 -30
- package/rules/coding/backend/cache-keying.md +0 -30
- package/rules/coding/backend/cache.md +0 -37
- package/rules/coding/backend/database.md +0 -32
- package/rules/coding/backend/feign.md +0 -30
- package/rules/coding/backend/index.md +0 -42
- package/rules/coding/backend/query.md +0 -32
- package/rules/coding/backend/remote.md +0 -33
- package/rules/coding/backend/transaction-boundary.md +0 -30
- package/rules/coding/backend/transaction-rollback.md +0 -30
- package/rules/coding/backend/transaction.md +0 -38
- package/rules/coding/boundary.md +0 -25
- package/rules/coding/implementation.md +0 -26
- package/rules/coding/index.md +0 -38
- package/rules/coding/scaffold.md +0 -28
- package/rules/coding/testing.md +0 -29
- package/rules/coding/validation.md +0 -29
- package/rules/core/code-quality.md +0 -30
- package/rules/core/evidence.md +0 -26
- package/rules/core/interface.md +0 -26
- package/rules/core/iteration.md +0 -26
- package/rules/core/layer-boundary.md +0 -25
- package/rules/core/logging.md +0 -26
- package/rules/core/security.md +0 -26
- package/rules/core/task-boundary.md +0 -27
- package/rules/docs/api.md +0 -34
- package/rules/docs/capture-summary.md +0 -29
- package/rules/docs/capture.md +0 -34
- package/rules/docs/contract.md +0 -30
- package/rules/docs/decision-log.md +0 -32
- package/rules/docs/examples.md +0 -28
- package/rules/docs/index.md +0 -49
- package/rules/docs/reference.md +0 -32
- package/rules/overlays/pig-cloud/controller.md +0 -33
- package/rules/overlays/pig-cloud/dto-vo.md +0 -33
- package/rules/overlays/pig-cloud/entity.md +0 -32
- package/rules/overlays/pig-cloud/exception.md +0 -32
- package/rules/overlays/pig-cloud/layering.md +0 -31
- package/rules/overlays/pig-cloud/mapper.md +0 -32
- package/rules/overlays/pig-cloud/query-style.md +0 -32
- package/rules/overlays/pig-cloud/rest-response.md +0 -33
- package/rules/overlays/pig-cloud/service.md +0 -33
- package/rules/overlays/pig-cloud/transactions.md +0 -32
- package/rules/overlays/pig-cloud/validation.md +0 -33
- package/rules/product/acceptance.md +0 -25
- package/rules/product/briefing.md +0 -27
- package/rules/product/index.md +0 -36
- package/rules/product/intake.md +0 -27
- package/rules/product/modeling.md +0 -25
- package/rules/product/project-context.md +0 -29
- package/rules/review/code.md +0 -35
- package/rules/review/evidence.md +0 -31
- package/rules/review/index.md +0 -50
- package/rules/review/java.md +0 -42
- package/rules/review/performance.md +0 -38
- package/rules/review/rubric.md +0 -28
- package/rules/review/security.md +0 -38
- package/rules/review/ts.md +0 -33
- package/rules/review/vue.md +0 -33
- package/rules/skill-profile-map.json +0 -59
- package/rules/skill-profile-map.md +0 -29
- package/rules/workflow/handoff.md +0 -25
- package/rules/workflow/index.md +0 -37
- package/rules/workflow/refinement.md +0 -29
- package/rules/workflow/router.md +0 -25
- package/rules/workflow/selection.md +0 -25
- package/rules/workflow/stop.md +0 -25
- package/skills/api-contract-docs/SKILL.md +0 -77
- package/skills/business-fact-extraction/SKILL.md +0 -337
- package/skills/business-fact-extraction/scripts/write-knowledge-base.js +0 -228
- package/skills/code-review/SKILL.md +0 -136
- package/skills/code-review/references/findings-template.md +0 -51
- package/skills/code-review/references/performance-checklist.md +0 -213
- package/skills/code-review/references/rubric.md +0 -232
- package/skills/code-review/references/rules.md +0 -32
- package/skills/code-review/references/security-checklist.md +0 -178
- package/skills/code-review/references/stack-notes.md +0 -25
- package/skills/code-review/references/template-review.md +0 -39
- package/skills/code-review/scripts/lint-code-review.mjs +0 -431
- package/skills/domain-modeling/SKILL.md +0 -81
- package/skills/domain-modeling/references/README.md +0 -134
- package/skills/domain-modeling/references/distillation-checklist.md +0 -44
- package/skills/domain-modeling/references/test-cases-template.md +0 -128
- package/skills/environment-deploy/SKILL.md +0 -81
- package/skills/feature-build/SKILL.md +0 -122
- package/skills/feature-build/references/coding-checklist.md +0 -97
- package/skills/feature-build/references/comment-specification.md +0 -89
- package/skills/knowledge-capture/SKILL.md +0 -93
- package/skills/performance-audit/SKILL.md +0 -118
- package/skills/project-bootstrap/SKILL.md +0 -81
- package/skills/references/anti-rationalization.md +0 -144
- package/skills/references/business-fact-extraction.md +0 -415
- package/skills/references/engineering-delivery-method.md +0 -64
- package/skills/references/engineering-delivery-template.md +0 -81
- package/skills/references/golden-prompt-suite.js +0 -436
- package/skills/references/golden-prompt-suite.md +0 -33
- package/skills/references/project-requirement-alignment.md +0 -42
- package/skills/references/rule-loading-map.md +0 -117
- package/skills/references/skill-authoring-standard.md +0 -74
- package/skills/references/skill-boundary-template.md +0 -71
- package/skills/references/skill-enhanced-template.md +0 -103
- package/skills/references/skill-reference-matrix.md +0 -62
- package/skills/security-audit/SKILL.md +0 -119
- package/skills/spec-refinement/SKILL.md +0 -149
- package/skills/technical-design/SKILL.md +0 -106
- package/skills/technical-design/references/solid-checklist.md +0 -199
- package/skills/test-design/SKILL.md +0 -92
- package/skills/workflow-router/SKILL.md +0 -86
|
@@ -1,415 +0,0 @@
|
|
|
1
|
-
# Business Fact Extraction
|
|
2
|
-
|
|
3
|
-
## Goal
|
|
4
|
-
|
|
5
|
-
Turn code-backed evidence into a three-stage artifact:
|
|
6
|
-
|
|
7
|
-
1. code facts
|
|
8
|
-
2. business facts
|
|
9
|
-
3. CodeWiki updates
|
|
10
|
-
|
|
11
|
-
## Evidence Order
|
|
12
|
-
|
|
13
|
-
Use the strongest source available first:
|
|
14
|
-
|
|
15
|
-
1. runtime behavior
|
|
16
|
-
2. automated tests
|
|
17
|
-
3. code paths
|
|
18
|
-
4. schema and contracts
|
|
19
|
-
5. docs and runbooks
|
|
20
|
-
6. comments and naming
|
|
21
|
-
|
|
22
|
-
## Fact Types
|
|
23
|
-
|
|
24
|
-
- evidence-backed fact: directly supported by code or tests
|
|
25
|
-
- inferred business fact: a reasonable business meaning derived from evidence
|
|
26
|
-
- unknown: the code does not prove it yet
|
|
27
|
-
- contradiction: two sources disagree
|
|
28
|
-
|
|
29
|
-
## Output Shape
|
|
30
|
-
|
|
31
|
-
### 1. Code Facts
|
|
32
|
-
|
|
33
|
-
#### `knowledge-base/realtime-code/modules.md`
|
|
34
|
-
|
|
35
|
-
- module:
|
|
36
|
-
- current responsibility:
|
|
37
|
-
- key entry points:
|
|
38
|
-
- important constraints:
|
|
39
|
-
- last verified:
|
|
40
|
-
|
|
41
|
-
#### `knowledge-base/realtime-code/flows.md`
|
|
42
|
-
|
|
43
|
-
- flow name:
|
|
44
|
-
- trigger:
|
|
45
|
-
- path:
|
|
46
|
-
- output:
|
|
47
|
-
- failure points:
|
|
48
|
-
- notes:
|
|
49
|
-
|
|
50
|
-
#### `knowledge-base/realtime-code/runtime-notes.md`
|
|
51
|
-
|
|
52
|
-
- fact:
|
|
53
|
-
- evidence:
|
|
54
|
-
- affected area:
|
|
55
|
-
- date:
|
|
56
|
-
- notes:
|
|
57
|
-
|
|
58
|
-
### 2. Business Facts
|
|
59
|
-
|
|
60
|
-
#### `knowledge-base/requirements/decisions.md`
|
|
61
|
-
|
|
62
|
-
- decision:
|
|
63
|
-
- reason:
|
|
64
|
-
- date or context:
|
|
65
|
-
- affected artifact:
|
|
66
|
-
- notes:
|
|
67
|
-
|
|
68
|
-
#### `knowledge-base/requirements/acceptance.md`
|
|
69
|
-
|
|
70
|
-
- requirement:
|
|
71
|
-
- acceptance criteria:
|
|
72
|
-
- out of scope:
|
|
73
|
-
- open questions:
|
|
74
|
-
- confirmed by:
|
|
75
|
-
|
|
76
|
-
#### `knowledge-base/requirements/conflicts.md`
|
|
77
|
-
|
|
78
|
-
- conflict:
|
|
79
|
-
- source:
|
|
80
|
-
- impact:
|
|
81
|
-
- resolution:
|
|
82
|
-
- status:
|
|
83
|
-
|
|
84
|
-
### 3. CodeWiki Update
|
|
85
|
-
|
|
86
|
-
#### `knowledge-base/codewiki/overview.md`
|
|
87
|
-
|
|
88
|
-
- one-line summary:
|
|
89
|
-
- what the system does:
|
|
90
|
-
- what changed:
|
|
91
|
-
- why it matters:
|
|
92
|
-
|
|
93
|
-
#### `knowledge-base/codewiki/architecture.md`
|
|
94
|
-
|
|
95
|
-
- layers:
|
|
96
|
-
- boundaries:
|
|
97
|
-
- dependencies:
|
|
98
|
-
- major integration points:
|
|
99
|
-
|
|
100
|
-
#### `knowledge-base/codewiki/modules.md`
|
|
101
|
-
|
|
102
|
-
- module name:
|
|
103
|
-
- responsibility:
|
|
104
|
-
- main interfaces:
|
|
105
|
-
- related runtime facts:
|
|
106
|
-
|
|
107
|
-
#### `knowledge-base/codewiki/flows.md`
|
|
108
|
-
|
|
109
|
-
- request flow:
|
|
110
|
-
- data flow:
|
|
111
|
-
- error flow:
|
|
112
|
-
- handoff flow:
|
|
113
|
-
|
|
114
|
-
#### `knowledge-base/codewiki/api.md`
|
|
115
|
-
|
|
116
|
-
- endpoint or contract:
|
|
117
|
-
- request shape:
|
|
118
|
-
- response shape:
|
|
119
|
-
- constraints:
|
|
120
|
-
|
|
121
|
-
#### `knowledge-base/codewiki/runbook.md`
|
|
122
|
-
|
|
123
|
-
- startup:
|
|
124
|
-
- verify:
|
|
125
|
-
- troubleshoot:
|
|
126
|
-
- recover:
|
|
127
|
-
|
|
128
|
-
#### `knowledge-base/codewiki/conventions.md`
|
|
129
|
-
|
|
130
|
-
- naming:
|
|
131
|
-
- layering:
|
|
132
|
-
- error handling:
|
|
133
|
-
- logging:
|
|
134
|
-
- data handling:
|
|
135
|
-
|
|
136
|
-
### 4. Enterprise Note
|
|
137
|
-
|
|
138
|
-
#### `knowledge-base/enterprise/decisions.md`
|
|
139
|
-
|
|
140
|
-
- decision:
|
|
141
|
-
- reason:
|
|
142
|
-
- scope:
|
|
143
|
-
- date:
|
|
144
|
-
- reusable lesson:
|
|
145
|
-
|
|
146
|
-
#### `knowledge-base/enterprise/pitfalls.md`
|
|
147
|
-
|
|
148
|
-
- pitfall:
|
|
149
|
-
- context:
|
|
150
|
-
- why it failed:
|
|
151
|
-
- how to avoid it:
|
|
152
|
-
|
|
153
|
-
#### `knowledge-base/enterprise/examples.md`
|
|
154
|
-
|
|
155
|
-
- example:
|
|
156
|
-
- context:
|
|
157
|
-
- lesson:
|
|
158
|
-
- reusable pattern:
|
|
159
|
-
|
|
160
|
-
#### `knowledge-base/enterprise/ai-coding-rules.md`
|
|
161
|
-
|
|
162
|
-
- rule:
|
|
163
|
-
- when it applies:
|
|
164
|
-
- why it matters:
|
|
165
|
-
- examples:
|
|
166
|
-
|
|
167
|
-
## Writing Rules
|
|
168
|
-
|
|
169
|
-
- Keep one fact per line.
|
|
170
|
-
- Point each fact back to evidence.
|
|
171
|
-
- Separate observed behavior from interpretation.
|
|
172
|
-
- Mark uncertainty explicitly.
|
|
173
|
-
- Do not mix solution ideas into the fact list.
|
|
174
|
-
- Write the three stages in order and keep them visually separate.
|
|
175
|
-
- Update the smallest matching file in each target layer.
|
|
176
|
-
- Keep file targets and file content in the same order.
|
|
177
|
-
|
|
178
|
-
## Auto-Write Pack
|
|
179
|
-
|
|
180
|
-
Use `skills/business-fact-extraction/scripts/write-knowledge-base.js` when the staged readout should be written into the knowledge base.
|
|
181
|
-
|
|
182
|
-
### Input Shape
|
|
183
|
-
|
|
184
|
-
```json
|
|
185
|
-
{
|
|
186
|
-
"files": {
|
|
187
|
-
"knowledge-base/realtime-code/modules.md": [
|
|
188
|
-
{
|
|
189
|
-
"module": "order-service",
|
|
190
|
-
"current responsibility": "creates orders and reserves inventory",
|
|
191
|
-
"key entry points": "createOrder(), reserveInventory()",
|
|
192
|
-
"important constraints": "stock must be checked before commit",
|
|
193
|
-
"last verified": "2026-06-22"
|
|
194
|
-
}
|
|
195
|
-
]
|
|
196
|
-
}
|
|
197
|
-
}
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Command
|
|
201
|
-
|
|
202
|
-
```bash
|
|
203
|
-
node skills/business-fact-extraction/scripts/write-knowledge-base.js --input fact-pack.json
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
### Behavior
|
|
207
|
-
|
|
208
|
-
- Writes only under `knowledge-base/`
|
|
209
|
-
- Keeps the file-specific field order
|
|
210
|
-
- Replaces the generated block between markers when it already exists
|
|
211
|
-
- Preserves the surrounding manual notes
|
|
212
|
-
- Supports `--dry-run` for preview and `--sample` for a sample pack
|
|
213
|
-
|
|
214
|
-
## Handoff Targets
|
|
215
|
-
|
|
216
|
-
- `domain-modeling` when the facts need boundary or concept normalization
|
|
217
|
-
- `spec-refinement` when the facts need to become a user-confirmable spec-refinement
|
|
218
|
-
- `knowledge-capture` when the facts are stable and ready to persist
|
|
219
|
-
|
|
220
|
-
## Sample Readout
|
|
221
|
-
|
|
222
|
-
- code facts: module behavior, entry points, constraints, runtime evidence
|
|
223
|
-
- business facts: decisions, acceptance criteria, conflicts, open questions
|
|
224
|
-
- CodeWiki update: flow, architecture, module, API, runbook, convention deltas
|
|
225
|
-
- enterprise note: pitfalls, examples, reusable rules
|
|
226
|
-
|
|
227
|
-
## Full Example
|
|
228
|
-
|
|
229
|
-
### Code Facts
|
|
230
|
-
|
|
231
|
-
#### `knowledge-base/realtime-code/modules.md`
|
|
232
|
-
|
|
233
|
-
- module: `order-service`
|
|
234
|
-
- current responsibility: creates orders and reserves inventory
|
|
235
|
-
- key entry points: `createOrder()`, `reserveInventory()`
|
|
236
|
-
- important constraints: stock must be checked before commit
|
|
237
|
-
- last verified: 2026-06-22
|
|
238
|
-
|
|
239
|
-
#### `knowledge-base/realtime-code/flows.md`
|
|
240
|
-
|
|
241
|
-
- flow name: checkout order placement
|
|
242
|
-
- trigger: user confirms checkout
|
|
243
|
-
- path: validate stock -> reserve inventory -> create order
|
|
244
|
-
- output: confirmed order or shortage error
|
|
245
|
-
- failure points: stock shortage, reservation failure
|
|
246
|
-
- notes: reservation must happen before the order commit
|
|
247
|
-
|
|
248
|
-
### Business Facts
|
|
249
|
-
|
|
250
|
-
#### `knowledge-base/requirements/decisions.md`
|
|
251
|
-
|
|
252
|
-
- decision: inventory must be reserved before order confirmation
|
|
253
|
-
- reason: avoid overselling
|
|
254
|
-
- date or context: 2026-06-22, order flow review
|
|
255
|
-
- affected artifact: checkout spec-refinement
|
|
256
|
-
- notes: failure should return a clear stock shortage message
|
|
257
|
-
|
|
258
|
-
#### `knowledge-base/requirements/acceptance.md`
|
|
259
|
-
|
|
260
|
-
- requirement: checkout must not confirm an order when stock is unavailable
|
|
261
|
-
- acceptance criteria: shortage blocks confirmation and returns a clear message
|
|
262
|
-
- out of scope: backorder design
|
|
263
|
-
- open questions: whether to retry reservation automatically
|
|
264
|
-
- confirmed by: order flow review
|
|
265
|
-
|
|
266
|
-
### CodeWiki Update
|
|
267
|
-
|
|
268
|
-
#### `knowledge-base/codewiki/flows.md`
|
|
269
|
-
|
|
270
|
-
- request flow: checkout -> validate stock -> reserve inventory -> create order
|
|
271
|
-
- data flow: cart snapshot -> reservation record -> order record
|
|
272
|
-
- error flow: stock shortage -> stop checkout -> return shortage reason
|
|
273
|
-
- handoff flow: checkout service hands off to inventory service and order repository
|
|
274
|
-
|
|
275
|
-
#### `knowledge-base/codewiki/modules.md`
|
|
276
|
-
|
|
277
|
-
- module name: `order-service`
|
|
278
|
-
- responsibility: coordinates checkout and order creation
|
|
279
|
-
- main interfaces: `createOrder()`, `reserveInventory()`
|
|
280
|
-
- related runtime facts: inventory must be reserved before commit
|
|
281
|
-
|
|
282
|
-
### Enterprise Note
|
|
283
|
-
|
|
284
|
-
#### `knowledge-base/enterprise/pitfalls.md`
|
|
285
|
-
|
|
286
|
-
- pitfall: reservation happens after order creation
|
|
287
|
-
- context: checkout path
|
|
288
|
-
- why it failed: allowed overselling under concurrent requests
|
|
289
|
-
- how to avoid it: reserve before committing the order
|
|
290
|
-
|
|
291
|
-
## End-to-End Example
|
|
292
|
-
|
|
293
|
-
### 1. Source Input
|
|
294
|
-
|
|
295
|
-
- PRD / spec-refinement note: checkout must not confirm when stock is insufficient
|
|
296
|
-
- code evidence: `order-service` reserves inventory before creating the order
|
|
297
|
-
- runtime evidence: shortage returns a stock error before commit
|
|
298
|
-
|
|
299
|
-
### 2. Extracted Output
|
|
300
|
-
|
|
301
|
-
- code facts:
|
|
302
|
-
- `knowledge-base/realtime-code/modules.md`: `order-service` coordinates checkout and inventory reservation
|
|
303
|
-
- `knowledge-base/realtime-code/flows.md`: checkout -> validate stock -> reserve inventory -> create order
|
|
304
|
-
- business facts:
|
|
305
|
-
- `knowledge-base/requirements/decisions.md`: reserve inventory before order confirmation
|
|
306
|
-
- `knowledge-base/requirements/acceptance.md`: shortage blocks confirmation and returns a clear message
|
|
307
|
-
- CodeWiki update:
|
|
308
|
-
- `knowledge-base/codewiki/flows.md`: document request / data / error / handoff flow
|
|
309
|
-
- `knowledge-base/codewiki/modules.md`: document `order-service` responsibilities and interfaces
|
|
310
|
-
- enterprise note:
|
|
311
|
-
- `knowledge-base/enterprise/pitfalls.md`: reservation after order creation causes overselling
|
|
312
|
-
- `knowledge-base/enterprise/ai-coding-rules.md`: reserve before commit under concurrency
|
|
313
|
-
|
|
314
|
-
### 3. Fact Pack
|
|
315
|
-
|
|
316
|
-
```json
|
|
317
|
-
{
|
|
318
|
-
"files": {
|
|
319
|
-
"knowledge-base/realtime-code/modules.md": [
|
|
320
|
-
{
|
|
321
|
-
"module": "order-service",
|
|
322
|
-
"current responsibility": "coordinates checkout and inventory reservation",
|
|
323
|
-
"key entry points": "createOrder(), reserveInventory()",
|
|
324
|
-
"important constraints": "stock must be checked before commit",
|
|
325
|
-
"last verified": "2026-06-22"
|
|
326
|
-
}
|
|
327
|
-
],
|
|
328
|
-
"knowledge-base/requirements/decisions.md": [
|
|
329
|
-
{
|
|
330
|
-
"decision": "inventory must be reserved before order confirmation",
|
|
331
|
-
"reason": "avoid overselling",
|
|
332
|
-
"date or context": "2026-06-22, checkout review",
|
|
333
|
-
"affected artifact": "checkout spec-refinement",
|
|
334
|
-
"notes": "shortage returns a clear error"
|
|
335
|
-
}
|
|
336
|
-
],
|
|
337
|
-
"knowledge-base/codewiki/flows.md": [
|
|
338
|
-
{
|
|
339
|
-
"request flow": "checkout -> validate stock -> reserve inventory -> create order",
|
|
340
|
-
"data flow": "cart snapshot -> reservation record -> order record",
|
|
341
|
-
"error flow": "stock shortage -> stop checkout -> return shortage reason",
|
|
342
|
-
"handoff flow": "checkout service hands off to inventory service and order repository"
|
|
343
|
-
}
|
|
344
|
-
],
|
|
345
|
-
"knowledge-base/enterprise/pitfalls.md": [
|
|
346
|
-
{
|
|
347
|
-
"pitfall": "reservation happens after order creation",
|
|
348
|
-
"context": "checkout path",
|
|
349
|
-
"why it failed": "allowed overselling under concurrent requests",
|
|
350
|
-
"how to avoid it": "reserve before committing the order"
|
|
351
|
-
}
|
|
352
|
-
]
|
|
353
|
-
}
|
|
354
|
-
}
|
|
355
|
-
```
|
|
356
|
-
|
|
357
|
-
### 4. Persist
|
|
358
|
-
|
|
359
|
-
```bash
|
|
360
|
-
node skills/business-fact-extraction/scripts/write-knowledge-base.js --input fact-pack.json
|
|
361
|
-
```
|
|
362
|
-
|
|
363
|
-
### 5. `knowledge-capture`
|
|
364
|
-
|
|
365
|
-
- Normalize the extracted note.
|
|
366
|
-
- Link it back to the originating skill.
|
|
367
|
-
- Persist the fact pack only when the note is ready.
|
|
368
|
-
|
|
369
|
-
#### `knowledge-base/enterprise/ai-coding-rules.md`
|
|
370
|
-
|
|
371
|
-
- rule: reserve inventory before committing the order
|
|
372
|
-
- when it applies: any checkout flow that can oversell
|
|
373
|
-
- why it matters: keeps business state consistent under concurrency
|
|
374
|
-
- examples: validate stock, reserve, then create the order
|
|
375
|
-
|
|
376
|
-
## Sample Output
|
|
377
|
-
|
|
378
|
-
### Code Facts
|
|
379
|
-
|
|
380
|
-
#### `knowledge-base/realtime-code/modules.md`
|
|
381
|
-
|
|
382
|
-
- module: `order-service`
|
|
383
|
-
- current responsibility: creates orders and reserves inventory
|
|
384
|
-
- key entry points: `createOrder()`, `reserveInventory()`
|
|
385
|
-
- important constraints: stock must be checked before commit
|
|
386
|
-
- last verified: 2026-06-22
|
|
387
|
-
|
|
388
|
-
### Business Facts
|
|
389
|
-
|
|
390
|
-
#### `knowledge-base/requirements/decisions.md`
|
|
391
|
-
|
|
392
|
-
- decision: inventory must be reserved before order confirmation
|
|
393
|
-
- reason: avoid overselling
|
|
394
|
-
- date or context: 2026-06-22, order flow review
|
|
395
|
-
- affected artifact: checkout spec-refinement
|
|
396
|
-
- notes: failure should return a clear stock shortage message
|
|
397
|
-
|
|
398
|
-
### CodeWiki Update
|
|
399
|
-
|
|
400
|
-
#### `knowledge-base/codewiki/flows.md`
|
|
401
|
-
|
|
402
|
-
- request flow: checkout -> validate stock -> reserve inventory -> create order
|
|
403
|
-
- data flow: cart snapshot -> reservation record -> order record
|
|
404
|
-
- error flow: stock shortage -> stop checkout -> return shortage reason
|
|
405
|
-
- handoff flow: checkout service hands off to inventory service and order repository
|
|
406
|
-
|
|
407
|
-
### Enterprise Note
|
|
408
|
-
|
|
409
|
-
#### `knowledge-base/enterprise/pitfalls.md`
|
|
410
|
-
|
|
411
|
-
- pitfall: reservation happens after order creation
|
|
412
|
-
- context: checkout path
|
|
413
|
-
- why it failed: allowed overselling under concurrent requests
|
|
414
|
-
- how to avoid it: reserve before committing the order
|
|
415
|
-
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
# Engineering Delivery Method
|
|
2
|
-
|
|
3
|
-
## Goal
|
|
4
|
-
|
|
5
|
-
Help engineering teams turn an approved spec-refinement into executable work, decide complexity before coding, implement inside `feature-build`, self-verify locally, and then hand off to validation and review.
|
|
6
|
-
|
|
7
|
-
Use [`engineering-delivery-template.md`](engineering-delivery-template.md) when you need the copyable one-page form.
|
|
8
|
-
|
|
9
|
-
## Flow
|
|
10
|
-
|
|
11
|
-
1. Start from an approved spec-refinement or executable design.
|
|
12
|
-
2. Align the spec-refinement with current project facts and selected rules.
|
|
13
|
-
3. Plan the task execution direction before coding.
|
|
14
|
-
4. Decide whether the change is simple or complex before coding.
|
|
15
|
-
5. If the change is complex, produce `technical-design` first.
|
|
16
|
-
6. Enter `feature-build` and split the work into small tasks.
|
|
17
|
-
7. Implement one task at a time.
|
|
18
|
-
8. Run local self-tests after each task.
|
|
19
|
-
9. Record validation evidence.
|
|
20
|
-
10. Hand off the verified result to `test-design`, then `code-review`.
|
|
21
|
-
|
|
22
|
-
## Task Split Rules
|
|
23
|
-
|
|
24
|
-
- Prefer acceptance-item first, then module-boundary refinement.
|
|
25
|
-
- Each task should be small enough to finish and verify independently.
|
|
26
|
-
- Each task should have a clear owner surface, dependency list, and done criteria.
|
|
27
|
-
- Split mixed-stack work by the smallest verifiable implementation unit.
|
|
28
|
-
- Treat task splitting as a working artifact, not as a separate lifecycle stage.
|
|
29
|
-
|
|
30
|
-
## Task Card Shape
|
|
31
|
-
|
|
32
|
-
- task goal
|
|
33
|
-
- impacted surface
|
|
34
|
-
- implementation boundary
|
|
35
|
-
- dependencies
|
|
36
|
-
- completion criteria
|
|
37
|
-
- self-test steps
|
|
38
|
-
- evidence to record
|
|
39
|
-
|
|
40
|
-
## Self-Test Rules
|
|
41
|
-
|
|
42
|
-
- Verify the smallest relevant unit first.
|
|
43
|
-
- Record the evidence immediately after the task is finished.
|
|
44
|
-
- If a task fails locally, fix it before moving to the next task.
|
|
45
|
-
- Do not wait until the end to discover basic correctness issues.
|
|
46
|
-
|
|
47
|
-
## Handoff Rules
|
|
48
|
-
|
|
49
|
-
- `feature-build` hands off code changes plus validation evidence.
|
|
50
|
-
- `test-design` receives implementation notes, self-test results, and coverage gaps.
|
|
51
|
-
- `code-review` receives the validated diff and evidence summary.
|
|
52
|
-
|
|
53
|
-
## Spec Stage Direction
|
|
54
|
-
|
|
55
|
-
- Before execution, produce an execution direction plan.
|
|
56
|
-
- Keep the direction explicit enough for a user to confirm.
|
|
57
|
-
- Do not enter `feature-build` until the direction is accepted.
|
|
58
|
-
|
|
59
|
-
## References
|
|
60
|
-
|
|
61
|
-
- `skills/references/project-requirement-alignment.md`
|
|
62
|
-
- `skills/references/flow-test-cases.md`
|
|
63
|
-
- `skills/references/full-chain-replay-scenarios.md`
|
|
64
|
-
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# Engineering Delivery Template
|
|
2
|
-
|
|
3
|
-
## How to Use
|
|
4
|
-
|
|
5
|
-
- Start from an approved spec-refinement or executable design.
|
|
6
|
-
- Fill this page before implementation.
|
|
7
|
-
- Keep each task small enough to implement and self-test independently.
|
|
8
|
-
- Do not add long background text.
|
|
9
|
-
|
|
10
|
-
## 1. Current State Alignment
|
|
11
|
-
|
|
12
|
-
- Product intent:
|
|
13
|
-
- Current project facts:
|
|
14
|
-
- Existing constraints:
|
|
15
|
-
- Conflicts or gaps:
|
|
16
|
-
- Alignment notes:
|
|
17
|
-
|
|
18
|
-
## 2. Execution Direction Plan
|
|
19
|
-
|
|
20
|
-
- Preferred execution path:
|
|
21
|
-
- What should be done first:
|
|
22
|
-
- What should be done next:
|
|
23
|
-
- What must wait for confirmation:
|
|
24
|
-
- Why this direction fits the current facts:
|
|
25
|
-
|
|
26
|
-
## 3. Task Breakdown
|
|
27
|
-
|
|
28
|
-
| Task | Goal | Impacted surface | Boundary | Dependencies | Done criteria |
|
|
29
|
-
|---|---|---|---|---|---|
|
|
30
|
-
| T1 | | | | | |
|
|
31
|
-
| T2 | | | | | |
|
|
32
|
-
| T3 | | | | | |
|
|
33
|
-
|
|
34
|
-
Rules:
|
|
35
|
-
|
|
36
|
-
- Prefer acceptance-item first, then module-boundary refinement.
|
|
37
|
-
- Split mixed-stack work by the smallest verifiable implementation unit.
|
|
38
|
-
- Keep each task finishable in one implementation pass.
|
|
39
|
-
|
|
40
|
-
## 4. Task-by-Task Implementation
|
|
41
|
-
|
|
42
|
-
For each task, record:
|
|
43
|
-
|
|
44
|
-
- Task ID:
|
|
45
|
-
- What changed:
|
|
46
|
-
- Files or surfaces:
|
|
47
|
-
- Rule bundle used:
|
|
48
|
-
- Notes:
|
|
49
|
-
|
|
50
|
-
## 5. Task-Level Self-Test
|
|
51
|
-
|
|
52
|
-
For each task, record:
|
|
53
|
-
|
|
54
|
-
- Task ID:
|
|
55
|
-
- Self-test steps:
|
|
56
|
-
- Expected result:
|
|
57
|
-
- Actual result:
|
|
58
|
-
- Evidence:
|
|
59
|
-
|
|
60
|
-
Rules:
|
|
61
|
-
|
|
62
|
-
- Run self-test immediately after the task is done.
|
|
63
|
-
- Fix failures before starting the next task.
|
|
64
|
-
- Record evidence as soon as the task passes.
|
|
65
|
-
|
|
66
|
-
## 6. Validation and Handoff
|
|
67
|
-
|
|
68
|
-
- Overall validation result:
|
|
69
|
-
- Coverage gaps:
|
|
70
|
-
- Remaining risks:
|
|
71
|
-
- Handoff target: `test-design`
|
|
72
|
-
- Review target: `code-review`
|
|
73
|
-
|
|
74
|
-
## Minimum Acceptance
|
|
75
|
-
|
|
76
|
-
- The spec-refinement is split into small tasks.
|
|
77
|
-
- The execution direction is explicit before confirmation.
|
|
78
|
-
- Every task has a done criteria and a self-test.
|
|
79
|
-
- The implementation was verified task by task.
|
|
80
|
-
- The handoff includes evidence, not just code.
|
|
81
|
-
|