@pzy560117/codex-harness 0.1.3 → 0.1.5

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.
Files changed (386) hide show
  1. package/README.md +164 -27
  2. package/bin/harness.js +7 -7
  3. package/lib/commands/doctor.js +12 -12
  4. package/lib/commands/init.js +105 -105
  5. package/lib/commands/run.js +22 -22
  6. package/lib/commands/verify.js +12 -12
  7. package/lib/main.js +62 -62
  8. package/lib/powershell/find-powershell.js +20 -20
  9. package/lib/powershell/invoke-script.js +34 -34
  10. package/lib/project/assert-initialized.js +20 -20
  11. package/lib/project/detect-project-root.js +5 -5
  12. package/lib/release/cache-layout.js +34 -34
  13. package/lib/release/download-release.js +25 -25
  14. package/lib/release/package-source-layout.js +13 -13
  15. package/lib/release/release-config.js +6 -6
  16. package/lib/release/release-manifest.js +76 -76
  17. package/lib/release/resolve-package-source.js +21 -21
  18. package/lib/release/resolve-version.js +26 -26
  19. package/lib/release/unpack-zip.js +25 -25
  20. package/lib/release/verify-sha256.js +16 -16
  21. package/package-source/AGENTS.md +48 -57
  22. package/package-source/PACKAGE.md +7 -7
  23. package/package-source/README.md +85 -81
  24. package/package-source/docs/codex-harness-engineering/templates/AGENTS.md +51 -0
  25. package/package-source/docs/codex-harness-engineering/templates/README.md +21 -20
  26. package/package-source/docs/codex-harness-engineering/templates/bootstrap-codex-harness.ps1 +144 -110
  27. package/package-source/docs/codex-harness-engineering/templates/ci/AGENTS.md +15 -0
  28. package/package-source/docs/codex-harness-engineering/templates/ci/github-action-codex-review.yml +110 -110
  29. package/package-source/docs/codex-harness-engineering/templates/config/AGENTS.md +19 -0
  30. package/package-source/docs/codex-harness-engineering/templates/config/agents/architect.toml +18 -17
  31. package/package-source/docs/codex-harness-engineering/templates/config/agents/backend-worker.toml +15 -14
  32. package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-researcher.toml +13 -12
  33. package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-worker.toml +16 -15
  34. package/package-source/docs/codex-harness-engineering/templates/config/agents/explorer.toml +15 -14
  35. package/package-source/docs/codex-harness-engineering/templates/config/agents/failure-triage.toml +19 -18
  36. package/package-source/docs/codex-harness-engineering/templates/config/agents/frontend-worker.toml +15 -14
  37. package/package-source/docs/codex-harness-engineering/templates/config/agents/harness-writer.toml +16 -15
  38. package/package-source/docs/codex-harness-engineering/templates/config/agents/planner.toml +16 -15
  39. package/package-source/docs/codex-harness-engineering/templates/config/agents/readonly-research.toml +14 -13
  40. package/package-source/docs/codex-harness-engineering/templates/config/agents/reviewer.toml +13 -12
  41. package/package-source/docs/codex-harness-engineering/templates/config/agents/security-reviewer.toml +16 -15
  42. package/package-source/docs/codex-harness-engineering/templates/config/agents/stage1-reviewer.toml +15 -14
  43. package/package-source/docs/codex-harness-engineering/templates/config/agents/stage2-reviewer.toml +16 -15
  44. package/package-source/docs/codex-harness-engineering/templates/config/agents/test-planner.toml +18 -17
  45. package/package-source/docs/codex-harness-engineering/templates/config/agents/test-runner.toml +15 -14
  46. package/package-source/docs/codex-harness-engineering/templates/config/agents/visual-reviewer.toml +16 -15
  47. package/package-source/docs/codex-harness-engineering/templates/config/codex-agent-roles.md +24 -24
  48. package/package-source/docs/codex-harness-engineering/templates/config/codex-config.toml +12 -12
  49. package/package-source/docs/codex-harness-engineering/templates/config/codex-readme.md +6 -6
  50. package/package-source/docs/codex-harness-engineering/templates/config/env-check.ps1 +44 -40
  51. package/package-source/docs/codex-harness-engineering/templates/config/env.example +13 -12
  52. package/package-source/docs/codex-harness-engineering/templates/config/global-AGENTS.md +40 -40
  53. package/package-source/docs/codex-harness-engineering/templates/config/global-config.toml +19 -19
  54. package/package-source/docs/codex-harness-engineering/templates/config/rules/agents.md +118 -115
  55. package/package-source/docs/codex-harness-engineering/templates/config/rules/coding-style.md +57 -74
  56. package/package-source/docs/codex-harness-engineering/templates/config/rules/constitution.md +4 -4
  57. package/package-source/docs/codex-harness-engineering/templates/config/rules/git.rules +41 -41
  58. package/package-source/docs/codex-harness-engineering/templates/config/rules/harness.rules +29 -29
  59. package/package-source/docs/codex-harness-engineering/templates/config/rules/safety.rules +35 -35
  60. package/package-source/docs/codex-harness-engineering/templates/context/AGENTS.md +19 -0
  61. package/package-source/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
  62. package/package-source/docs/codex-harness-engineering/templates/context/CHANGELOG_AI.md +11 -0
  63. package/package-source/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +114 -0
  64. package/package-source/docs/codex-harness-engineering/templates/context/DB_SCHEMA.md +14 -0
  65. package/package-source/docs/codex-harness-engineering/templates/context/DECISIONS.md +12 -0
  66. package/package-source/docs/codex-harness-engineering/templates/context/KNOWN_ISSUES.md +12 -0
  67. package/package-source/docs/codex-harness-engineering/templates/context/PROJECT_CONTEXT.md +14 -0
  68. package/package-source/docs/codex-harness-engineering/templates/context/architecture-brief.md +58 -58
  69. package/package-source/docs/codex-harness-engineering/templates/context/dev-plan.md +89 -83
  70. package/package-source/docs/codex-harness-engineering/templates/context/feature-pack.md +101 -101
  71. package/package-source/docs/codex-harness-engineering/templates/context/repo-map.md +102 -78
  72. package/package-source/docs/codex-harness-engineering/templates/context/service-dependency-matrix.yaml +25 -25
  73. package/package-source/docs/codex-harness-engineering/templates/contracts/AGENTS.md +17 -0
  74. package/package-source/docs/codex-harness-engineering/templates/contracts/README.md +24 -16
  75. package/package-source/docs/codex-harness-engineering/templates/contracts/openapi.yaml +182 -182
  76. package/package-source/docs/codex-harness-engineering/templates/contracts/orval.config.ts +20 -20
  77. package/package-source/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -34
  78. package/package-source/docs/codex-harness-engineering/templates/design/AGENTS.md +21 -0
  79. package/package-source/docs/codex-harness-engineering/templates/design/ai-image-brief.md +122 -122
  80. package/package-source/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
  81. package/package-source/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
  82. package/package-source/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
  83. package/package-source/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
  84. package/package-source/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
  85. package/package-source/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
  86. package/package-source/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
  87. package/package-source/docs/codex-harness-engineering/templates/docs/AGENTS.md +19 -0
  88. package/package-source/docs/codex-harness-engineering/templates/docs/architecture-constraints.md +97 -83
  89. package/package-source/docs/codex-harness-engineering/templates/docs/code-semantics-and-navigation.md +54 -0
  90. package/package-source/docs/codex-harness-engineering/templates/docs/code-style-and-naming.md +116 -0
  91. package/package-source/docs/codex-harness-engineering/templates/docs/directory-structure-template.md +88 -0
  92. package/package-source/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
  93. package/package-source/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +165 -138
  94. package/package-source/docs/codex-harness-engineering/templates/docs/governance-auto-repair.md +82 -80
  95. package/package-source/docs/codex-harness-engineering/templates/docs/harness-architecture.md +78 -78
  96. package/package-source/docs/codex-harness-engineering/templates/docs/install-manifest-governance.md +16 -16
  97. package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-architecture.md +241 -219
  98. package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-import.md +108 -108
  99. package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-lint.md +98 -98
  100. package/package-source/docs/codex-harness-engineering/templates/docs/mcp-knowledge-governance.md +24 -0
  101. package/package-source/docs/codex-harness-engineering/templates/docs/new-project-checklist.md +7 -7
  102. package/package-source/docs/codex-harness-engineering/templates/docs/new-project-usage.md +107 -43
  103. package/package-source/docs/codex-harness-engineering/templates/docs/project-agents-template.md +211 -154
  104. package/package-source/docs/codex-harness-engineering/templates/docs/prompt-knowledge-integration.md +100 -89
  105. package/package-source/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -45
  106. package/package-source/docs/codex-harness-engineering/templates/docs/requirement-prep-kit/README.md +3 -3
  107. package/package-source/docs/codex-harness-engineering/templates/docs/rule-governance.md +98 -98
  108. package/package-source/docs/codex-harness-engineering/templates/docs/service-dependency-matrix.md +70 -55
  109. package/package-source/docs/codex-harness-engineering/templates/docs/task-session-strategy.md +133 -116
  110. package/package-source/docs/codex-harness-engineering/templates/docs/team-knowledge-sync.md +187 -187
  111. package/package-source/docs/codex-harness-engineering/templates/docs/trace-format.md +44 -32
  112. package/package-source/docs/codex-harness-engineering/templates/governance/AGENTS.md +18 -0
  113. package/package-source/docs/codex-harness-engineering/templates/governance/branch-protection-checklist.md +50 -50
  114. package/package-source/docs/codex-harness-engineering/templates/governance/feedback-evolution-loop.md +55 -55
  115. package/package-source/docs/codex-harness-engineering/templates/governance/retry-budget.yaml +30 -30
  116. package/package-source/docs/codex-harness-engineering/templates/governance/risk-levels.yaml +53 -53
  117. package/package-source/docs/codex-harness-engineering/templates/governance/sandbox-policy.md +13 -13
  118. package/package-source/docs/codex-harness-engineering/templates/hooks/AGENTS.md +15 -0
  119. package/package-source/docs/codex-harness-engineering/templates/hooks/hook-stop-verify.ps1 +171 -118
  120. package/package-source/docs/codex-harness-engineering/templates/hooks/hooks.json +40 -40
  121. package/package-source/docs/codex-harness-engineering/templates/knowledge/AGENTS.md +16 -0
  122. package/package-source/docs/codex-harness-engineering/templates/knowledge/catalog.md +6 -6
  123. package/package-source/docs/codex-harness-engineering/templates/knowledge/decisions/DECISION-HARNESS-001.md +39 -39
  124. package/package-source/docs/codex-harness-engineering/templates/knowledge/guidelines/GUIDELINE-RULES-001.md +30 -30
  125. package/package-source/docs/codex-harness-engineering/templates/knowledge/knowledge-catalog.md +41 -41
  126. package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/plan-template.md +252 -252
  127. package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/spec-template.md +145 -145
  128. package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/tasks-template.md +47 -47
  129. package/package-source/docs/codex-harness-engineering/templates/package-assets/AGENTS.md +19 -0
  130. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/AGENTS.md +25 -0
  131. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/README.md +118 -42
  132. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/START-HERE.md +66 -53
  133. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/agent-ecosystem-practices.md +140 -140
  134. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/best-practices.md +9 -9
  135. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/codex-global-rules-example.md +48 -48
  136. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/AGENTS.md +14 -0
  137. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/goal-templates.md +380 -380
  138. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/AGENTS.md +14 -0
  139. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/README.md +64 -64
  140. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/openapi.yaml +25 -25
  141. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/orval.config.ts +20 -20
  142. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ai-image-brief.md +44 -44
  143. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/component-map.md +17 -17
  144. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/design-brief.md +58 -58
  145. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/frontend-architecture.md +106 -106
  146. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/image-to-frontend-spec.md +72 -72
  147. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/screen-states.md +25 -25
  148. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ui-image-review.md +38 -38
  149. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/difficulty-research.md +39 -39
  150. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/page-inventory.md +5 -5
  151. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/prd-lite.md +41 -41
  152. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/requirement-interface-matrix.md +32 -32
  153. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/state-matrix.yaml +14 -14
  154. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/model/Ticket.ts +6 -6
  155. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/ticket-api.ts +35 -35
  156. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/http-client.ts +8 -8
  157. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/ui/TicketFilterBar.tsx +72 -72
  158. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/plans/features/ticket-filter.dev-plan.md +48 -48
  159. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/progress.txt +1 -1
  160. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/stories/TicketFilterBar.stories.tsx +33 -33
  161. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/task.json +54 -54
  162. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/verify.ps1 +42 -42
  163. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/global-rules-and-bootstrap.md +157 -157
  164. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/goal-harness-integration-guide.md +364 -364
  165. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-flow.md +7 -5
  166. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-guide.md +25 -25
  167. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/knowledge-surface-map.md +186 -0
  168. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/mode-matrix.md +57 -57
  169. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/new-project-usage.md +176 -0
  170. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/project-agents-template.md +168 -154
  171. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/superpowers-codex-solo-builder-playbook.md +676 -676
  172. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/AGENTS.md +22 -0
  173. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/AGENTS.md +14 -0
  174. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
  175. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +89 -0
  176. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/dev-plan.md +166 -0
  177. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/AGENTS.md +14 -0
  178. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/README.md +24 -0
  179. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -0
  180. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/AGENTS.md +14 -0
  181. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
  182. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
  183. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
  184. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
  185. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
  186. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
  187. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
  188. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/AGENTS.md +14 -0
  189. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
  190. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +161 -138
  191. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -0
  192. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/trace-format.md +86 -0
  193. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/AGENTS.md +14 -0
  194. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -0
  195. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -0
  196. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/AGENTS.md +14 -0
  197. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -0
  198. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -0
  199. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/11-security-design.md +43 -0
  200. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/AGENTS.md +14 -0
  201. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/AGENTS.md +14 -0
  202. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -0
  203. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +690 -0
  204. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -0
  205. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -0
  206. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +23 -0
  207. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/verify-matrix.md +51 -0
  208. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/README.md +10 -10
  209. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/commands/e2e.md +30 -30
  210. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/README.md +60 -60
  211. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/Mobile_App_Production_Readiness_Framework_/347/247/273/345/212/250/347/253/257/345/205/250/345/271/263/345/217/260/347/224/237/344/272/247/345/217/257/344/270/212/347/272/277/350/247/204/350/214/203.md +2457 -2457
  212. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/catalog.md +33 -33
  213. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/architecture.md +358 -358
  214. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/AI_Coding_Production_Control_Framework_AI/345/206/231/345/256/214/347/232/204/344/273/243/347/240/201/345/246/202/344/275/225/344/270/215/345/244/261/346/216/247.md +2055 -2055
  215. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/catalog.md +34 -34
  216. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/initial-content.md +296 -296
  217. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/integration-roadmap.md +221 -221
  218. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/architecture-constraints.md +95 -83
  219. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-semantics-and-navigation.md +17 -0
  220. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-style-and-naming.md +116 -0
  221. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/frontend-quality-rules.md +138 -138
  222. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/governance-auto-repair.md +82 -80
  223. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/mcp-knowledge-governance.md +24 -0
  224. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/service-dependency-matrix.md +55 -55
  225. package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/speckit-requirements-gate.md +124 -124
  226. package/package-source/docs/codex-harness-engineering/templates/package-assets/root/PACKAGE.md +7 -7
  227. package/package-source/docs/codex-harness-engineering/templates/package-assets/root/README.md +52 -52
  228. package/package-source/docs/codex-harness-engineering/templates/package-assets/root/install-agent-here.ps1 +57 -57
  229. package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/agents.md +115 -115
  230. package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/coding-style.md +57 -74
  231. package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/constitution.md +4 -4
  232. package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/git.rules +41 -41
  233. package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/harness.rules +29 -29
  234. package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/safety.rules +35 -35
  235. package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
  236. package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
  237. package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-targets.example.json +35 -35
  238. package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/harness/harness-governance-check.ps1 +864 -366
  239. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/HOW_TO_USE_SKILLS.md +79 -79
  240. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/academic-mermaid-diagrams/SKILL.md +172 -172
  241. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/SKILL.md +152 -152
  242. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/references/command-recipes.md +92 -92
  243. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/auto-commit/SKILL.md +324 -322
  244. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/better-icons/SKILL.md +3 -3
  245. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/SKILL.md +100 -100
  246. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/references/windows-openrouter-clash-playbook.md +94 -94
  247. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/diagnose-openrouter-route.ps1 +282 -282
  248. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/ensure-openrouter-rule.ps1 +101 -101
  249. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/fixing-metadata/SKILL.md +6 -6
  250. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/frontend-design/SKILL.md +37 -37
  251. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/git-xianyu-analyzer/SKILL.md +3 -3
  252. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/SKILL.md +204 -188
  253. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/current-repo-sync-matrix.md +150 -110
  254. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/stale-patterns.md +65 -65
  255. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/init-autopilot/SKILL.md +17 -15
  256. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/log-analysis-optimization/SKILL.md +5 -5
  257. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/prd-writer-skill/SKILL.md +28 -28
  258. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-planner/SKILL.md +11 -11
  259. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-runner/SKILL.md +6 -6
  260. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-mock-cleaner/SKILL.md +4 -4
  261. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/SKILL.md +67 -67
  262. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/agents/openai.yaml +7 -7
  263. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/scripts/configure-qoder-codex-api.ps1 +278 -278
  264. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/requirements-design-template/SKILL.md +87 -87
  265. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/skills-index.md +12 -12
  266. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-analyze/SKILL.md +34 -34
  267. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-checklist/SKILL.md +8 -8
  268. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-clarify/SKILL.md +28 -28
  269. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-e2e-tasks/SKILL.md +12 -12
  270. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-implement/SKILL.md +37 -37
  271. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-plan/SKILL.md +140 -138
  272. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-specify/SKILL.md +100 -100
  273. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-tasks/SKILL.md +86 -86
  274. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-verify/SKILL.md +144 -142
  275. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/SKILL.md +145 -143
  276. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/current-repo-notes.md +42 -41
  277. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/github-samples.md +33 -33
  278. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/scripts/collect-root-doc-facts.ps1 +174 -145
  279. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/ai-integrity-and-originality.md +191 -191
  280. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/citation-templates.md +99 -99
  281. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/final-checklist.md +60 -60
  282. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/photographer-booking-paper.md +85 -85
  283. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/test-result-templates.md +22 -22
  284. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/thesis-analysis-template.md +63 -63
  285. package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/update-codemaps/SKILL.md +31 -31
  286. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/README.md +15 -15
  287. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.analyze.md +60 -60
  288. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.checklist.md +8 -8
  289. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.clarify.md +28 -28
  290. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.e2e-testing.md +10 -10
  291. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.implement.md +56 -56
  292. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.plan.md +137 -134
  293. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.specify.md +100 -100
  294. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.tasks.md +86 -86
  295. package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.verify.md +130 -130
  296. package/package-source/docs/codex-harness-engineering/templates/product/AGENTS.md +19 -0
  297. package/package-source/docs/codex-harness-engineering/templates/product/acceptance-criteria.md +47 -47
  298. package/package-source/docs/codex-harness-engineering/templates/product/difficulty-research.md +47 -47
  299. package/package-source/docs/codex-harness-engineering/templates/product/page-inventory.md +21 -21
  300. package/package-source/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -158
  301. package/package-source/docs/codex-harness-engineering/templates/product/requirement-interface-matrix.md +37 -37
  302. package/package-source/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -105
  303. package/package-source/docs/codex-harness-engineering/templates/prompts/AGENTS.md +15 -0
  304. package/package-source/docs/codex-harness-engineering/templates/prompts/controller-loop.md +88 -88
  305. package/package-source/docs/codex-harness-engineering/templates/prompts/failure-triage.md +71 -69
  306. package/package-source/docs/codex-harness-engineering/templates/prompts/harness-audit.md +54 -52
  307. package/package-source/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -148
  308. package/package-source/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -67
  309. package/package-source/docs/codex-harness-engineering/templates/prompts/review-one-task.md +45 -43
  310. package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage1-spec.md +111 -109
  311. package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage2-quality.md +82 -80
  312. package/package-source/docs/codex-harness-engineering/templates/prompts/visual-evaluator.md +80 -78
  313. package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/backend-worker.md +41 -41
  314. package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/docs-worker.md +28 -28
  315. package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/frontend-worker.md +46 -46
  316. package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/harness-writer.md +40 -40
  317. package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/test-runner.md +27 -27
  318. package/package-source/docs/codex-harness-engineering/templates/runtime/AGENTS.md +66 -50
  319. package/package-source/docs/codex-harness-engineering/templates/runtime/codex-loop.ps1 +2129 -231
  320. package/package-source/docs/codex-harness-engineering/templates/runtime/doctor.ps1 +224 -224
  321. package/package-source/docs/codex-harness-engineering/templates/runtime/project-task-template.json +42 -39
  322. package/package-source/docs/codex-harness-engineering/templates/runtime/scripts/test-install-modes.ps1 +2 -2
  323. package/package-source/docs/codex-harness-engineering/templates/runtime/smoke-task.json +52 -52
  324. package/package-source/docs/codex-harness-engineering/templates/runtime/task-run-profile.json +86 -86
  325. package/package-source/docs/codex-harness-engineering/templates/runtime/task.json +11 -8
  326. package/package-source/docs/codex-harness-engineering/templates/runtime/verify.ps1 +21 -21
  327. package/package-source/docs/codex-harness-engineering/templates/scripts/AGENTS.md +15 -0
  328. package/package-source/docs/codex-harness-engineering/templates/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
  329. package/package-source/docs/codex-harness-engineering/templates/scripts/harness/harness-governance-check.ps1 +864 -366
  330. package/package-source/docs/codex-harness-engineering/templates/spec/10-data-model.md +23 -7
  331. package/package-source/docs/codex-harness-engineering/templates/spec/11-security-design.md +30 -13
  332. package/package-source/docs/codex-harness-engineering/templates/spec/AGENTS.md +15 -0
  333. package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_CRITERIA.md +39 -39
  334. package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_EXAMPLES.md +37 -37
  335. package/package-source/docs/codex-harness-engineering/templates/testing/AGENTS.md +19 -0
  336. package/package-source/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -48
  337. package/package-source/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +5 -4
  338. package/package-source/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -20
  339. package/package-source/docs/codex-harness-engineering/templates/testing/RISK_BASED_TEST_PLAN.md +16 -16
  340. package/package-source/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -97
  341. package/package-source/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +6 -5
  342. package/package-source/docs/codex-harness-engineering/templates/testing/coverage-policy.md +25 -25
  343. package/package-source/docs/codex-harness-engineering/templates/testing/e2e-plan.md +139 -139
  344. package/package-source/docs/codex-harness-engineering/templates/testing/failure-findings.example.json +3 -3
  345. package/package-source/docs/codex-harness-engineering/templates/testing/failure-triage.md +62 -62
  346. package/package-source/docs/codex-harness-engineering/templates/testing/test-data-plan.md +36 -36
  347. package/package-source/docs/codex-harness-engineering/templates/testing/test-report.md +85 -41
  348. package/package-source/docs/codex-harness-engineering/templates/testing/verify-matrix.md +15 -5
  349. package/package-source/docs/codex-harness-engineering/templates/tools/AGENTS.md +14 -0
  350. package/package-source/docs/codex-harness-engineering/templates/tools/harness/acceptance-lint.ps1 +37 -0
  351. package/package-source/docs/codex-harness-engineering/templates/tools/harness/architecture-lint.ps1 +150 -0
  352. package/package-source/docs/codex-harness-engineering/templates/tools/harness/backend-lint.ps1 +137 -0
  353. package/package-source/docs/codex-harness-engineering/templates/tools/harness/business-lint.ps1 +148 -0
  354. package/package-source/docs/codex-harness-engineering/templates/tools/harness/component-lint.ps1 +148 -0
  355. package/package-source/docs/codex-harness-engineering/templates/tools/harness/config-lint.ps1 +159 -0
  356. package/package-source/docs/codex-harness-engineering/templates/tools/harness/context-lint.ps1 +187 -0
  357. package/package-source/docs/codex-harness-engineering/templates/tools/harness/contract-lint.ps1 +148 -0
  358. package/package-source/docs/codex-harness-engineering/templates/tools/harness/data-lint.ps1 +37 -0
  359. package/package-source/docs/codex-harness-engineering/templates/tools/harness/directory-lint.ps1 +152 -0
  360. package/package-source/docs/codex-harness-engineering/templates/tools/harness/docs-lint.ps1 +40 -0
  361. package/package-source/docs/codex-harness-engineering/templates/tools/harness/impact-lint.ps1 +148 -0
  362. package/package-source/docs/codex-harness-engineering/templates/tools/harness/integration-lint.ps1 +37 -0
  363. package/package-source/docs/codex-harness-engineering/templates/tools/harness/mobile-lint.ps1 +37 -0
  364. package/package-source/docs/codex-harness-engineering/templates/tools/harness/observability-lint.ps1 +137 -0
  365. package/package-source/docs/codex-harness-engineering/templates/tools/harness/performance-lint.ps1 +148 -0
  366. package/package-source/docs/codex-harness-engineering/templates/tools/harness/refactor-lint.ps1 +137 -0
  367. package/package-source/docs/codex-harness-engineering/templates/tools/harness/security-lint.ps1 +159 -0
  368. package/package-source/docs/codex-harness-engineering/templates/tools/harness/session-lint.ps1 +126 -0
  369. package/package-source/docs/codex-harness-engineering/templates/tools/harness/spec-lint.ps1 +285 -0
  370. package/package-source/docs/codex-harness-engineering/templates/tools/harness/state-lint.ps1 +137 -0
  371. package/package-source/docs/codex-harness-engineering/templates/tools/harness/style-lint.ps1 +155 -0
  372. package/package-source/docs/codex-harness-engineering/templates/tools/harness/testing-lint.ps1 +192 -0
  373. package/package-source/docs/codex-harness-engineering/templates/tools/harness/ui-lint.ps1 +148 -0
  374. package/package-source/docs/codex-harness-engineering/templates/trace/AGENTS.md +16 -0
  375. package/package-source/docs/codex-harness-engineering/templates/trace/eval-case.yaml +24 -24
  376. package/package-source/docs/codex-harness-engineering/templates/trace/trace.schema.json +101 -101
  377. package/package-source/install-manifest.json +149 -79
  378. package/package-source/tools/install/ai-workflow/check-ai-sync-drift.ps1 +205 -205
  379. package/package-source/tools/install/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
  380. package/package-source/tools/install/ai-workflow/sync-targets.example.json +35 -35
  381. package/package-source/tools/install/bootstrap-codex-harness.ps1 +145 -129
  382. package/package-source/tools/install/env-check.ps1 +40 -40
  383. package/package-source/tools/install/init-project.ps1 +1 -1
  384. package/package-source/tools/install/install-agent-here.ps1 +57 -57
  385. package/package-source/tools/install/install-agent.ps1 +33 -31
  386. package/package.json +23 -23
@@ -1,221 +1,221 @@
1
- # 外挂总知识库落地路线
2
-
3
- ## 阶段 0:研究和边界冻结
4
-
5
- 目标:先把“外挂总知识库是什么、不是什么”说清楚。
6
-
7
- 产物:
8
-
9
- - `docs/external-knowledge/README.md`
10
- - `docs/external-knowledge/architecture.md`
11
- - `docs/external-knowledge/initial-content.md`
12
- - `docs/external-knowledge/integration-roadmap.md`
13
-
14
- 验收:
15
-
16
- - 明确项目知识与外挂知识的优先级。
17
- - 明确第一版不依赖 RAG。
18
- - 明确外部知识不可用时不阻塞本地 driver。
19
- - 明确长文档必须通过 catalog 进入查询链路,不进入默认上下文。
20
-
21
- ## 阶段 1:完整项目 MVP 骨架
22
-
23
- 目标:创建 `team-wiki/` 独立仓库,并从一开始按完整项目管理,而不是只建文档目录。
24
-
25
- 任务:
26
-
27
- 1. 按 `initial-content.md` 创建目录。
28
- 2. 创建 `knowledge-catalog.md`、`.knowledge-config.yaml`、`log.md`。
29
- 3. 创建 `quality-management/`、`software-engineering/`、`agent-engineering/` 三大知识域。
30
- 4. 创建 `schemas/` 和 `scripts/`,至少预留 frontmatter schema 与 lint 脚本入口。
31
- 5. 创建 `contributions/pending/`、`contributions/conflicts/`、`reports/` 和 `archive/`。
32
- 6. 写入 10-20 条面向 AI 编程质量管理和软件工程的 draft 种子知识。
33
- 7. 为每条种子知识补齐 frontmatter。
34
-
35
- 建议验证:
36
-
37
- ```powershell
38
- git diff --check
39
- ```
40
-
41
- 后续可增加:
42
-
43
- ```powershell
44
- powershell -NoProfile -ExecutionPolicy Bypass -File scripts/knowledge/lint-knowledge.ps1
45
- ```
46
-
47
- ## 阶段 2:项目侧外挂配置
48
-
49
- 目标:让项目能声明外挂知识库位置,但不强依赖。
50
-
51
- 新增项目文件:
52
-
53
- ```text
54
- .knowledge-sources.yml
55
- ```
56
-
57
- 最小内容:
58
-
59
- ```yaml
60
- schema_version: 1
61
- sources:
62
- project:
63
- path: docs/knowledge
64
- required: true
65
- team:
66
- path: ../team-wiki
67
- required: false
68
- catalogs:
69
- - knowledge-catalog.md
70
- - quality-management/catalog.md
71
- - software-engineering/catalog.md
72
- - agent-engineering/catalog.md
73
- - app/catalog.md
74
- query:
75
- max_catalogs: 4
76
- max_entries: 8
77
- prefer_maturity: [proven, verified, draft]
78
- ```
79
-
80
- 任务:
81
-
82
- 1. 在 Harness 模板中加入 `.knowledge-sources.yml` 示例。
83
- 2. 在 `tools/harness/templates/project-task-template.json.runtime.handoff.truth_sources` 中支持 `team_knowledge`。
84
- 3. `team_knowledge` 缺失时只输出 warning。
85
- 4. 项目画像 `project-profiles/<project-slug>.md` 可选接入,用于过滤不相关知识。
86
- 5. 领域扩展 catalog,如 `common/catalog.md`、`app/catalog.md`,只有任务命中对应 AI Coding 控制、平台或发布风险时才读取。
87
-
88
- ## 阶段 3:Prompt 查询协议
89
-
90
- 目标:让 Codex 会话知道何时读取外挂知识。
91
-
92
- 修改点:
93
-
94
- - `implement-one-task.md`
95
- - `review-stage1-spec.md`
96
- - `review-stage2-quality.md`
97
- - `failure-triage.md`
98
- - `repair-one-finding.md`
99
- - `worker-role/*`
100
-
101
- 要求:
102
-
103
- 1. 先读项目 truth source。
104
- 2. 再读项目 `docs/knowledge/knowledge-catalog.md`。
105
- 3. 如 `.knowledge-sources.yml` 存在且任务相关,再读外挂 catalog。
106
- 4. 只读取少量相关条目。
107
- 5. 最终输出 `knowledge_references` 时标记来源:
108
- 6. 对 `common/`、`app/` 这类长文档领域扩展,先读 catalog 摘要;只有 AI Coding 生产控制、移动端上线、平台审核、支付、隐私、安全、弱网、灰度回滚或行业专项任务才读取完整规范相关章节。
109
-
110
- ```markdown
111
- ## Knowledge References
112
- - `GUIDELINE-HARNESS-001`: title - source=team - used_in=plan - `../team-wiki/...`
113
- ```
114
-
115
- ## 阶段 4:同步候选任务
116
-
117
- 目标:把项目知识中可复用的 verified/proven 候选导出到外挂库 pending。
118
-
119
- 新增可选任务:
120
-
121
- ```json
122
- {
123
- "id": "KNOWLEDGE-TEAM-SYNC-001",
124
- "description": "把项目知识中的跨项目候选导出到外挂总知识库 pending",
125
- "task_kind": "archive",
126
- "phase": "archive",
127
- "gate_profile": "lightweight",
128
- "required_truth_sources": ["knowledge"],
129
- "priority": 95,
130
- "dependencies": ["ARCHIVE-001"],
131
- "passes": false,
132
- "context_files": [
133
- ".knowledge-sources.yml",
134
- "docs/harness/team-knowledge-sync.md",
135
- "docs/knowledge/knowledge-catalog.md",
136
- "docs/knowledge/catalog.md"
137
- ],
138
- "owned_paths": [
139
- "docs/knowledge/"
140
- ],
141
- "execution": { "mode": "single" },
142
- "test_command": "git diff --check",
143
- "acceptance": [
144
- "输出 team sync candidates 或说明外挂知识库不可用",
145
- "没有把 draft 或单次经验直接升级为 proven",
146
- "冲突只进入 conflict candidate,不覆盖外挂知识主干"
147
- ]
148
- }
149
- ```
150
-
151
- 如果需要直接写外挂仓库,必须显式把外挂路径纳入 owned paths 或由人工执行同步。
152
-
153
- ## 阶段 5:最小脚本
154
-
155
- 建议新增脚本:
156
-
157
- ```text
158
- scripts/knowledge/
159
- resolve-sources.ps1
160
- lint-knowledge.ps1
161
- export-team-candidates.ps1
162
- build-agent-index.ps1
163
- ```
164
-
165
- 职责:
166
-
167
- - `resolve-sources.ps1`:读取 `.knowledge-sources.yml`,输出可用 catalog 和缺失 source。
168
- - `lint-knowledge.ps1`:检查 frontmatter、catalog、孤儿条目、重复和冲突候选。
169
- - `export-team-candidates.ps1`:把项目 promotion candidates 转成 `contributions/pending/` 条目。
170
- - `build-agent-index.ps1`:生成 `agent-context.md` 或 `llms.txt` 形式的低成本 Agent 查询入口。
171
-
172
- 脚本边界:
173
-
174
- - 不自动删除知识。
175
- - 不静默提升为 `proven`。
176
- - 外挂库不可用时 exit 0 + warning,除非用户显式要求强制同步。
177
-
178
- ## 阶段 6:RAG 增强
179
-
180
- 触发条件:
181
-
182
- - 外挂知识超过 300 条。
183
- - catalog 筛选已经不足以召回相关内容。
184
- - 已有稳定 frontmatter 和权限边界。
185
-
186
- RAG 结构:
187
-
188
- ```text
189
- Markdown Git repo
190
- -> index builder
191
- -> vector store
192
- -> retrieval candidates
193
- -> 回到 Markdown source 读取原文
194
- ```
195
-
196
- RAG 不作为 truth source。它只负责召回候选,最终引用必须指向 Git 中的 Markdown 条目。
197
-
198
- ## 风险和防线
199
-
200
- | 风险 | 防线 |
201
- | --- | --- |
202
- | 外挂知识覆盖项目事实 | 项目 truth source 优先,冲突输出 candidate |
203
- | 知识库膨胀 | catalog-first、query budget、lint |
204
- | 单次经验变全局规则 | draft 默认、proven 需多证据或审批 |
205
- | 外部库不可用阻塞开发 | `required: false`,降级 warning |
206
- | 过时知识误导 Agent | last_referenced、decay、archive |
207
- | 泄露敏感信息 | 禁止 token、cookie、私钥、客户数据入库 |
208
-
209
- ## 第一轮实施建议
210
-
211
- 先做以下最小闭环:
212
-
213
- 1. 创建独立 `team-wiki` 仓库骨架。
214
- 2. 按质量管理、软件工程、Agent 工程三大域写入 10-20 条种子知识。
215
- 3. 在本项目新增 `.knowledge-sources.yml` 示例。
216
- 4. 修改 prompt,让它能按需读取外挂 catalog。
217
- 5. 新增 `resolve-sources.ps1` 和 `lint-knowledge.ps1`。
218
- 6. 跑一次人工 ARCHIVE,把当前 Harness 的两条 draft 项目知识导出为团队 pending 候选。
219
- 7. 将 `docs/external-knowledge/common/catalog.md` 作为通用 AI Coding 生产控制入口,将 `docs/external-knowledge/app/catalog.md` 作为 App 生产可上线领域扩展入口,并保持完整规范为按需读取资料。
220
-
221
- 这一步完成后,再考虑自动同步和 RAG。
1
+ # 外挂总知识库落地路线
2
+
3
+ ## 阶段 0:研究和边界冻结
4
+
5
+ 目标:先把“外挂总知识库是什么、不是什么”说清楚。
6
+
7
+ 产物:
8
+
9
+ - `docs/external-knowledge/README.md`
10
+ - `docs/external-knowledge/architecture.md`
11
+ - `docs/external-knowledge/initial-content.md`
12
+ - `docs/external-knowledge/integration-roadmap.md`
13
+
14
+ 验收:
15
+
16
+ - 明确项目知识与外挂知识的优先级。
17
+ - 明确第一版不依赖 RAG。
18
+ - 明确外部知识不可用时不阻塞本地 driver。
19
+ - 明确长文档必须通过 catalog 进入查询链路,不进入默认上下文。
20
+
21
+ ## 阶段 1:完整项目 MVP 骨架
22
+
23
+ 目标:创建 `team-wiki/` 独立仓库,并从一开始按完整项目管理,而不是只建文档目录。
24
+
25
+ 任务:
26
+
27
+ 1. 按 `initial-content.md` 创建目录。
28
+ 2. 创建 `knowledge-catalog.md`、`.knowledge-config.yaml`、`log.md`。
29
+ 3. 创建 `quality-management/`、`software-engineering/`、`agent-engineering/` 三大知识域。
30
+ 4. 创建 `schemas/` 和 `scripts/`,至少预留 frontmatter schema 与 lint 脚本入口。
31
+ 5. 创建 `contributions/pending/`、`contributions/conflicts/`、`reports/` 和 `archive/`。
32
+ 6. 写入 10-20 条面向 AI 编程质量管理和软件工程的 draft 种子知识。
33
+ 7. 为每条种子知识补齐 frontmatter。
34
+
35
+ 建议验证:
36
+
37
+ ```powershell
38
+ git diff --check
39
+ ```
40
+
41
+ 后续可增加:
42
+
43
+ ```powershell
44
+ powershell -NoProfile -ExecutionPolicy Bypass -File scripts/knowledge/lint-knowledge.ps1
45
+ ```
46
+
47
+ ## 阶段 2:项目侧外挂配置
48
+
49
+ 目标:让项目能声明外挂知识库位置,但不强依赖。
50
+
51
+ 新增项目文件:
52
+
53
+ ```text
54
+ .knowledge-sources.yml
55
+ ```
56
+
57
+ 最小内容:
58
+
59
+ ```yaml
60
+ schema_version: 1
61
+ sources:
62
+ project:
63
+ path: docs/knowledge
64
+ required: true
65
+ team:
66
+ path: ../team-wiki
67
+ required: false
68
+ catalogs:
69
+ - knowledge-catalog.md
70
+ - quality-management/catalog.md
71
+ - software-engineering/catalog.md
72
+ - agent-engineering/catalog.md
73
+ - app/catalog.md
74
+ query:
75
+ max_catalogs: 4
76
+ max_entries: 8
77
+ prefer_maturity: [proven, verified, draft]
78
+ ```
79
+
80
+ 任务:
81
+
82
+ 1. 在 Harness 模板中加入 `.knowledge-sources.yml` 示例。
83
+ 2. 在 `tools/harness/templates/project-task-template.json.runtime.handoff.truth_sources` 中支持 `team_knowledge`。
84
+ 3. `team_knowledge` 缺失时只输出 warning。
85
+ 4. 项目画像 `project-profiles/<project-slug>.md` 可选接入,用于过滤不相关知识。
86
+ 5. 领域扩展 catalog,如 `common/catalog.md`、`app/catalog.md`,只有任务命中对应 AI Coding 控制、平台或发布风险时才读取。
87
+
88
+ ## 阶段 3:Prompt 查询协议
89
+
90
+ 目标:让 Codex 会话知道何时读取外挂知识。
91
+
92
+ 修改点:
93
+
94
+ - `implement-one-task.md`
95
+ - `review-stage1-spec.md`
96
+ - `review-stage2-quality.md`
97
+ - `failure-triage.md`
98
+ - `repair-one-finding.md`
99
+ - `worker-role/*`
100
+
101
+ 要求:
102
+
103
+ 1. 先读项目 truth source。
104
+ 2. 再读项目 `docs/knowledge/knowledge-catalog.md`。
105
+ 3. 如 `.knowledge-sources.yml` 存在且任务相关,再读外挂 catalog。
106
+ 4. 只读取少量相关条目。
107
+ 5. 最终输出 `knowledge_references` 时标记来源:
108
+ 6. 对 `common/`、`app/` 这类长文档领域扩展,先读 catalog 摘要;只有 AI Coding 生产控制、移动端上线、平台审核、支付、隐私、安全、弱网、灰度回滚或行业专项任务才读取完整规范相关章节。
109
+
110
+ ```markdown
111
+ ## Knowledge References
112
+ - `GUIDELINE-HARNESS-001`: title - source=team - used_in=plan - `../team-wiki/...`
113
+ ```
114
+
115
+ ## 阶段 4:同步候选任务
116
+
117
+ 目标:把项目知识中可复用的 verified/proven 候选导出到外挂库 pending。
118
+
119
+ 新增可选任务:
120
+
121
+ ```json
122
+ {
123
+ "id": "KNOWLEDGE-TEAM-SYNC-001",
124
+ "description": "把项目知识中的跨项目候选导出到外挂总知识库 pending",
125
+ "task_kind": "archive",
126
+ "phase": "archive",
127
+ "gate_profile": "lightweight",
128
+ "required_truth_sources": ["knowledge"],
129
+ "priority": 95,
130
+ "dependencies": ["ARCHIVE-001"],
131
+ "passes": false,
132
+ "context_files": [
133
+ ".knowledge-sources.yml",
134
+ "docs/harness/team-knowledge-sync.md",
135
+ "docs/knowledge/knowledge-catalog.md",
136
+ "docs/knowledge/catalog.md"
137
+ ],
138
+ "owned_paths": [
139
+ "docs/knowledge/"
140
+ ],
141
+ "execution": { "mode": "single" },
142
+ "test_command": "git diff --check",
143
+ "acceptance": [
144
+ "输出 team sync candidates 或说明外挂知识库不可用",
145
+ "没有把 draft 或单次经验直接升级为 proven",
146
+ "冲突只进入 conflict candidate,不覆盖外挂知识主干"
147
+ ]
148
+ }
149
+ ```
150
+
151
+ 如果需要直接写外挂仓库,必须显式把外挂路径纳入 owned paths 或由人工执行同步。
152
+
153
+ ## 阶段 5:最小脚本
154
+
155
+ 建议新增脚本:
156
+
157
+ ```text
158
+ scripts/knowledge/
159
+ resolve-sources.ps1
160
+ lint-knowledge.ps1
161
+ export-team-candidates.ps1
162
+ build-agent-index.ps1
163
+ ```
164
+
165
+ 职责:
166
+
167
+ - `resolve-sources.ps1`:读取 `.knowledge-sources.yml`,输出可用 catalog 和缺失 source。
168
+ - `lint-knowledge.ps1`:检查 frontmatter、catalog、孤儿条目、重复和冲突候选。
169
+ - `export-team-candidates.ps1`:把项目 promotion candidates 转成 `contributions/pending/` 条目。
170
+ - `build-agent-index.ps1`:生成 `agent-context.md` 或 `llms.txt` 形式的低成本 Agent 查询入口。
171
+
172
+ 脚本边界:
173
+
174
+ - 不自动删除知识。
175
+ - 不静默提升为 `proven`。
176
+ - 外挂库不可用时 exit 0 + warning,除非用户显式要求强制同步。
177
+
178
+ ## 阶段 6:RAG 增强
179
+
180
+ 触发条件:
181
+
182
+ - 外挂知识超过 300 条。
183
+ - catalog 筛选已经不足以召回相关内容。
184
+ - 已有稳定 frontmatter 和权限边界。
185
+
186
+ RAG 结构:
187
+
188
+ ```text
189
+ Markdown Git repo
190
+ -> index builder
191
+ -> vector store
192
+ -> retrieval candidates
193
+ -> 回到 Markdown source 读取原文
194
+ ```
195
+
196
+ RAG 不作为 truth source。它只负责召回候选,最终引用必须指向 Git 中的 Markdown 条目。
197
+
198
+ ## 风险和防线
199
+
200
+ | 风险 | 防线 |
201
+ | --- | --- |
202
+ | 外挂知识覆盖项目事实 | 项目 truth source 优先,冲突输出 candidate |
203
+ | 知识库膨胀 | catalog-first、query budget、lint |
204
+ | 单次经验变全局规则 | draft 默认、proven 需多证据或审批 |
205
+ | 外部库不可用阻塞开发 | `required: false`,降级 warning |
206
+ | 过时知识误导 Agent | last_referenced、decay、archive |
207
+ | 泄露敏感信息 | 禁止 token、cookie、私钥、客户数据入库 |
208
+
209
+ ## 第一轮实施建议
210
+
211
+ 先做以下最小闭环:
212
+
213
+ 1. 创建独立 `team-wiki` 仓库骨架。
214
+ 2. 按质量管理、软件工程、Agent 工程三大域写入 10-20 条种子知识。
215
+ 3. 在本项目新增 `.knowledge-sources.yml` 示例。
216
+ 4. 修改 prompt,让它能按需读取外挂 catalog。
217
+ 5. 新增 `resolve-sources.ps1` 和 `lint-knowledge.ps1`。
218
+ 6. 跑一次人工 ARCHIVE,把当前 Harness 的两条 draft 项目知识导出为团队 pending 候选。
219
+ 7. 将 `docs/external-knowledge/common/catalog.md` 作为通用 AI Coding 生产控制入口,将 `docs/external-knowledge/app/catalog.md` 作为 App 生产可上线领域扩展入口,并保持完整规范为按需读取资料。
220
+
221
+ 这一步完成后,再考虑自动同步和 RAG。
@@ -1,83 +1,95 @@
1
- # Architecture Constraints Packet
2
-
3
- 本文件在需求分析结束、进入计划或编码前完成。它把“系统应该是什么形态”转成可执行约束,供 `task.json`、Stage 1 Review 和验证命令使用。
4
-
5
- 默认路径是 `docs/architecture/constraints.md`。项目可以在 `task.json.runtime.handoff.truth_sources.architecture` 中改用其他路径,但后续任务、prompt 和 review 必须读取同一组 truth source。
6
-
7
- ## 1. System Shape
8
-
9
- - `delivery_shape`: `web_app` / `backend_service` / `monolith` / `frontend_app` / `cli` / `library` / `automation` / `data_pipeline` / `domain_prototype` / `other:<name>`
10
- - `runtime_model`: `http_service` / `worker` / `scheduled_job` / `static_site` / `embedded_library` / `command` / `not_applicable`
11
- - `deployment_unit`: `container` / `single_process` / `serverless` / `package` / `static_assets` / `not_applicable`
12
- - `production_entrypoints`: 列出当前项目真实启动入口、公开命令、页面入口、worker entry、package export、Dockerfile 或 `not_applicable`。
13
-
14
- ## 2. Public Interface Boundary
15
-
16
- - `public_interfaces`: `HTTP` / `gRPC` / `GraphQL` / `MQ` / `CLI` / `UI route` / `package API` / `file format` / `none`
17
- - `contract_source`: `OpenAPI` / `protobuf` / `GraphQL schema` / `existing API` / `typed API` / `docs` / `not_applicable`
18
- - `interface_trace_rule`: 每个公开入口应能追踪到实现、测试和证据路径;没有公开入口时写明 `not_applicable`。
19
-
20
- ## 2.1 Service And Contract Topology
21
-
22
- 多服务、多仓库、契约或外部系统项目必须声明服务拓扑;不适用时写明 `service_matrix: not_applicable`。
23
-
24
- - `service_matrix`: `.service-matrix/dependencies.yaml` / `not_applicable` / `project_defined:<path>`
25
- - `affected_services`: 本轮需求会修改或影响的服务、应用、包、worker、前端入口或外部系统。
26
- - `upstream_downstream_rule`: 说明上游调用方和下游依赖方如何确认;不能只依赖代码搜索。
27
- - `contract_branch_rule`: IDL、OpenAPI、schema、generated code 或外部契约是否需要同分支、同版本或兼容性证明。
28
- - `change_gate_rule`: 对应 contract diff、consumer test、integration test、mock 更新、灰度或回滚检查。
29
-
30
- ## 3. Data Boundary
31
-
32
- - `persistence_boundary`: `MySQL` / `PostgreSQL` / `SQLite` / `Redis` / `object_storage` / `filesystem` / `browser_storage` / `external API` / `none`
33
- - `schema_or_migration_required`: `yes` / `no` / `not_applicable`
34
- - `repository_policy`: 说明声明交付路径使用的真实数据边界;测试替身、fixture、mock adapter 或 local-only adapter 只能用于声明允许的范围。
35
- - `consistency_requirements`: 事务、锁、幂等键、唯一约束、审计保留、缓存失效、离线同步或 `not_applicable`。
36
-
37
- ## 4. Async And Worker Boundary
38
-
39
- - `async_required`: `yes` / `no`
40
- - `scheduling_model`: `DB polling` / `MQ consumer` / `cron` / `event bus` / `browser event` / `manual command` / `none`
41
- - `concurrency_control`: `DB row lock` / `optimistic CAS` / `distributed lock` / `single process` / `browser single-thread` / `none`
42
- - `time_source`: `database time` / `server time` / `event time` / `browser time` / `not_applicable`
43
-
44
- ## 5. Test Double Policy
45
-
46
- - `test_double_allowed_scope`: `unit_tests_only` / `contract_tests` / `local_demo` / `domain_prototype` / `not_allowed` / `project_defined:<rule>`
47
- - `mock_as_acceptance_evidence`: `no` by default;如果允许,必须写明原因、适用依赖、过期条件和替代真实验证计划。
48
- - `minimum_integration_evidence`: 列出当前项目最低真实验证组合,例如 UI + API、API + DB、CLI + filesystem、package API + consumer test、worker + queue,或 `not_applicable`。
49
-
50
- ## 6. Forbidden Implementations
51
-
52
- 按项目填充,不要只写抽象原则。示例只作为选项,不代表所有项目都适用:
53
-
54
- - 不允许只实现领域 service 而没有任务声明的公开入口。
55
- - 不允许公开契约有 operation 但代码没有对应实现或验证。
56
- - 不允许用测试替身、mock、fixture、local-only adapter 冒充声明交付路径。
57
- - 不允许把 `domain_prototype` 标记为可交付功能完成。
58
- - 不允许只运行 `git diff --check` 就声明 `feature_impl` 完成。
59
-
60
- ## 7. Architecture Fitness Checks
61
-
62
- 每个项目至少定义一个可运行或可审查的架构适配检查,并把命令或检查项同步到 `task.json` `test_command`。
63
-
64
- ```powershell
65
- <replace-with-project-fitness-check>
66
- ```
67
-
68
- 若暂时没有脚本,必须在 `docs/testing/verify-matrix.md` 写明等价检查项。可选检查包括:
69
-
70
- - 声明的生产入口存在,且能被启动、导入、访问或执行。
71
- - 公开接口与实现、测试和证据路径可追踪。
72
- - 声明交付路径未引用禁止的测试替身。
73
- - 需要持久化、worker、浏览器、文件或第三方服务时,存在对应的真实验证证据。
74
- - 不适用的边界已明确标记为 `not_applicable`,而不是留空。
75
-
76
- ## 8. Definition Of Done
77
-
78
- - `architecture_constraints` 已从本文件或等价 truth source 复制到每个相关 `feature_impl` 任务。
79
- - 多服务、多仓库或契约任务已把服务矩阵、受影响服务和 change gates 复制到相关 `feature_impl` 的 `context_files`、`architecture_constraints`、`qa_contract` 和 `test_command`。
80
- - `forbidden_implementations` 已覆盖当前项目最容易跑偏的替代实现。
81
- - `test_command` 包含项目适配检查、affected tests、必要契约/集成/端到端验证和 `git diff --check`。
82
- - Stage 1 Review 对声明的架构形态给出 PASS。
83
- - 完成声明能说明声明交付路径、测试替身和不适用边界。
1
+ # Architecture Constraints Packet
2
+
3
+ 本文件在需求分析结束、进入计划或编码前完成。它把“系统应该是什么形态”转成可执行约束,供 `task.json`、Stage 1 Review 和验证命令使用。
4
+
5
+ 默认路径是 `docs/architecture/constraints.md`。项目可以在 `task.json.runtime.handoff.truth_sources.architecture` 中改用其他路径,但后续任务、prompt 和 review 必须读取同一组 truth source。
6
+
7
+ ## 1. System Shape
8
+
9
+ - `delivery_shape`: `web_app` / `backend_service` / `monolith` / `frontend_app` / `cli` / `library` / `automation` / `data_pipeline` / `domain_prototype` / `other:<name>`
10
+ - `runtime_model`: `http_service` / `worker` / `scheduled_job` / `static_site` / `embedded_library` / `command` / `not_applicable`
11
+ - `deployment_unit`: `container` / `single_process` / `serverless` / `package` / `static_assets` / `not_applicable`
12
+ - `production_entrypoints`: 列出当前项目真实启动入口、公开命令、页面入口、worker entry、package export、Dockerfile 或 `not_applicable`。
13
+
14
+ ## 2. Public Interface Boundary
15
+
16
+ - `public_interfaces`: `HTTP` / `gRPC` / `GraphQL` / `MQ` / `CLI` / `UI route` / `package API` / `file format` / `none`
17
+ - `contract_source`: `OpenAPI` / `protobuf` / `GraphQL schema` / `existing API` / `typed API` / `docs` / `not_applicable`
18
+ - `interface_trace_rule`: 每个公开入口应能追踪到实现、测试和证据路径;没有公开入口时写明 `not_applicable`。
19
+
20
+ ## 2.1 Service And Contract Topology
21
+
22
+ 多服务、多仓库、契约或外部系统项目必须声明服务拓扑;不适用时写明 `service_matrix: not_applicable`。
23
+
24
+ - `service_matrix`: `.service-matrix/dependencies.yaml` / `not_applicable` / `project_defined:<path>`
25
+ - `affected_services`: 本轮需求会修改或影响的服务、应用、包、worker、前端入口或外部系统。
26
+ - `upstream_downstream_rule`: 说明上游调用方和下游依赖方如何确认;不能只依赖代码搜索。
27
+ - `contract_branch_rule`: IDL、OpenAPI、schema、generated code 或外部契约是否需要同分支、同版本或兼容性证明。
28
+ - `change_gate_rule`: 对应 contract diff、consumer test、integration test、mock 更新、灰度或回滚检查。
29
+
30
+ ## 3. Data Boundary
31
+
32
+ - `persistence_boundary`: `MySQL` / `PostgreSQL` / `SQLite` / `Redis` / `object_storage` / `filesystem` / `browser_storage` / `external API` / `none`
33
+ - `schema_or_migration_required`: `yes` / `no` / `not_applicable`
34
+ - `repository_policy`: 说明声明交付路径使用的真实数据边界;测试替身、fixture、mock adapter 或 local-only adapter 只能用于声明允许的范围。
35
+ - `consistency_requirements`: 事务、锁、幂等键、唯一约束、审计保留、缓存失效、离线同步或 `not_applicable`。
36
+
37
+ ## 4. Async And Worker Boundary
38
+
39
+ - `async_required`: `yes` / `no`
40
+ - `scheduling_model`: `DB polling` / `MQ consumer` / `cron` / `event bus` / `browser event` / `manual command` / `none`
41
+ - `concurrency_control`: `DB row lock` / `optimistic CAS` / `distributed lock` / `single process` / `browser single-thread` / `none`
42
+ - `time_source`: `database time` / `server time` / `event time` / `browser time` / `not_applicable`
43
+
44
+ ## 4.1 Backend Layering And Error Boundary
45
+
46
+ 如果项目包含后端服务、BFF、worker API 或命令式写路径,至少补齐:
47
+
48
+ - `controller_policy`: Controller / Handler 只负责请求解析、权限入口、调用 service、响应映射;不堆业务规则。
49
+ - `service_policy`: Service 负责业务逻辑、事务编排、幂等和副作用协调;不得直接依赖 `req/res/ctx/request/response`。
50
+ - `repository_policy_detail`: Repository / DAO 负责数据库访问、查询组合和持久化边界;不返回页面展示字段。
51
+ - `dto_policy`: DTO / Request / Response / Entity 的边界和禁止混用规则。
52
+ - `error_handling_policy`: 全局异常处理、错误码模型、用户可见错误、日志保留策略。
53
+ - `transaction_boundary`: 哪些写路径必须事务化,哪些步骤不得跨外部调用长持锁。
54
+ - `idempotency_policy`: 哪些入口必须幂等,幂等键放在哪里,重复请求返回什么。
55
+
56
+ ## 5. Test Double Policy
57
+
58
+ - `test_double_allowed_scope`: `unit_tests_only` / `contract_tests` / `local_demo` / `domain_prototype` / `not_allowed` / `project_defined:<rule>`
59
+ - `mock_as_acceptance_evidence`: `no` by default;如果允许,必须写明原因、适用依赖、过期条件和替代真实验证计划。
60
+ - `minimum_integration_evidence`: 列出当前项目最低真实验证组合,例如 UI + API、API + DB、CLI + filesystem、package API + consumer test、worker + queue,或 `not_applicable`。
61
+
62
+ ## 6. Forbidden Implementations
63
+
64
+ 按项目填充,不要只写抽象原则。示例只作为选项,不代表所有项目都适用:
65
+
66
+ - 不允许只实现领域 service 而没有任务声明的公开入口。
67
+ - 不允许公开契约有 operation 但代码没有对应实现或验证。
68
+ - 不允许用测试替身、mock、fixture、local-only adapter 冒充声明交付路径。
69
+ - 不允许把 `domain_prototype` 标记为可交付功能完成。
70
+ - 不允许只运行 `git diff --check` 就声明 `feature_impl` 完成。
71
+
72
+ ## 7. Architecture Fitness Checks
73
+
74
+ 每个项目至少定义一个可运行或可审查的架构适配检查,并把命令或检查项同步到 `task.json` `test_command`。
75
+
76
+ ```powershell
77
+ <replace-with-project-fitness-check>
78
+ ```
79
+
80
+ 若暂时没有脚本,必须在 `docs/testing/verify-matrix.md` 写明等价检查项。可选检查包括:
81
+
82
+ - 声明的生产入口存在,且能被启动、导入、访问或执行。
83
+ - 公开接口与实现、测试和证据路径可追踪。
84
+ - 声明交付路径未引用禁止的测试替身。
85
+ - 需要持久化、worker、浏览器、文件或第三方服务时,存在对应的真实验证证据。
86
+ - 不适用的边界已明确标记为 `not_applicable`,而不是留空。
87
+
88
+ ## 8. Definition Of Done
89
+
90
+ - `architecture_constraints` 已从本文件或等价 truth source 复制到每个相关 `feature_impl` 任务。
91
+ - 多服务、多仓库或契约任务已把服务矩阵、受影响服务和 change gates 复制到相关 `feature_impl` 的 `context_files`、`architecture_constraints`、`qa_contract` 和 `test_command`。
92
+ - `forbidden_implementations` 已覆盖当前项目最容易跑偏的替代实现。
93
+ - `test_command` 包含项目适配检查、affected tests、必要契约/集成/端到端验证和 `git diff --check`。
94
+ - Stage 1 Review 对声明的架构形态给出 PASS。
95
+ - 完成声明能说明声明交付路径、测试替身和不适用边界。
@@ -0,0 +1,17 @@
1
+ # 代码语义与导航层
2
+
3
+ 本文定义项目里的导航顺序,帮助 agent 先找到入口,再进入具体实现。
4
+
5
+ ## 默认顺序
6
+
7
+ 1. `docs/ai/repo-map.md`
8
+ 2. `docs/ai/architecture-brief.md`
9
+ 3. `docs/ai/CURRENT_TASK.md`
10
+ 4. 代码语义工具或全文搜索
11
+ 5. `docs/knowledge/*`
12
+
13
+ ## 职责边界
14
+
15
+ - `docs/ai/*`: 文档导航层
16
+ - 代码语义工具: 定义、引用、调用链、影响面
17
+ - `docs/knowledge/*`: 历史经验和长期可复用知识