@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.
- package/README.md +164 -27
- package/bin/harness.js +7 -7
- package/lib/commands/doctor.js +12 -12
- package/lib/commands/init.js +105 -105
- package/lib/commands/run.js +22 -22
- package/lib/commands/verify.js +12 -12
- package/lib/main.js +62 -62
- package/lib/powershell/find-powershell.js +20 -20
- package/lib/powershell/invoke-script.js +34 -34
- package/lib/project/assert-initialized.js +20 -20
- package/lib/project/detect-project-root.js +5 -5
- package/lib/release/cache-layout.js +34 -34
- package/lib/release/download-release.js +25 -25
- package/lib/release/package-source-layout.js +13 -13
- package/lib/release/release-config.js +6 -6
- package/lib/release/release-manifest.js +76 -76
- package/lib/release/resolve-package-source.js +21 -21
- package/lib/release/resolve-version.js +26 -26
- package/lib/release/unpack-zip.js +25 -25
- package/lib/release/verify-sha256.js +16 -16
- package/package-source/AGENTS.md +48 -57
- package/package-source/PACKAGE.md +7 -7
- package/package-source/README.md +85 -81
- package/package-source/docs/codex-harness-engineering/templates/AGENTS.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/README.md +21 -20
- package/package-source/docs/codex-harness-engineering/templates/bootstrap-codex-harness.ps1 +144 -110
- package/package-source/docs/codex-harness-engineering/templates/ci/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/ci/github-action-codex-review.yml +110 -110
- package/package-source/docs/codex-harness-engineering/templates/config/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/config/agents/architect.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/backend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-researcher.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-worker.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/explorer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/failure-triage.toml +19 -18
- package/package-source/docs/codex-harness-engineering/templates/config/agents/frontend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/harness-writer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/planner.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/readonly-research.toml +14 -13
- package/package-source/docs/codex-harness-engineering/templates/config/agents/reviewer.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/security-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage1-reviewer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage2-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-planner.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-runner.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/visual-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/codex-agent-roles.md +24 -24
- package/package-source/docs/codex-harness-engineering/templates/config/codex-config.toml +12 -12
- package/package-source/docs/codex-harness-engineering/templates/config/codex-readme.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/config/env-check.ps1 +44 -40
- package/package-source/docs/codex-harness-engineering/templates/config/env.example +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/global-AGENTS.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/config/global-config.toml +19 -19
- package/package-source/docs/codex-harness-engineering/templates/config/rules/agents.md +118 -115
- package/package-source/docs/codex-harness-engineering/templates/config/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/config/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/config/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/config/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/config/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/context/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CHANGELOG_AI.md +11 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +114 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DB_SCHEMA.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DECISIONS.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/KNOWN_ISSUES.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/PROJECT_CONTEXT.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/architecture-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/context/dev-plan.md +89 -83
- package/package-source/docs/codex-harness-engineering/templates/context/feature-pack.md +101 -101
- package/package-source/docs/codex-harness-engineering/templates/context/repo-map.md +102 -78
- package/package-source/docs/codex-harness-engineering/templates/context/service-dependency-matrix.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/contracts/AGENTS.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/contracts/README.md +24 -16
- package/package-source/docs/codex-harness-engineering/templates/contracts/openapi.yaml +182 -182
- package/package-source/docs/codex-harness-engineering/templates/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -34
- package/package-source/docs/codex-harness-engineering/templates/design/AGENTS.md +21 -0
- package/package-source/docs/codex-harness-engineering/templates/design/ai-image-brief.md +122 -122
- package/package-source/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/docs/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/architecture-constraints.md +97 -83
- package/package-source/docs/codex-harness-engineering/templates/docs/code-semantics-and-navigation.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/directory-structure-template.md +88 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +165 -138
- package/package-source/docs/codex-harness-engineering/templates/docs/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/docs/harness-architecture.md +78 -78
- package/package-source/docs/codex-harness-engineering/templates/docs/install-manifest-governance.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-architecture.md +241 -219
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-import.md +108 -108
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-lint.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-checklist.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-usage.md +107 -43
- package/package-source/docs/codex-harness-engineering/templates/docs/project-agents-template.md +211 -154
- package/package-source/docs/codex-harness-engineering/templates/docs/prompt-knowledge-integration.md +100 -89
- package/package-source/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -45
- package/package-source/docs/codex-harness-engineering/templates/docs/requirement-prep-kit/README.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/docs/rule-governance.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/service-dependency-matrix.md +70 -55
- package/package-source/docs/codex-harness-engineering/templates/docs/task-session-strategy.md +133 -116
- package/package-source/docs/codex-harness-engineering/templates/docs/team-knowledge-sync.md +187 -187
- package/package-source/docs/codex-harness-engineering/templates/docs/trace-format.md +44 -32
- package/package-source/docs/codex-harness-engineering/templates/governance/AGENTS.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/governance/branch-protection-checklist.md +50 -50
- package/package-source/docs/codex-harness-engineering/templates/governance/feedback-evolution-loop.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/governance/retry-budget.yaml +30 -30
- package/package-source/docs/codex-harness-engineering/templates/governance/risk-levels.yaml +53 -53
- package/package-source/docs/codex-harness-engineering/templates/governance/sandbox-policy.md +13 -13
- package/package-source/docs/codex-harness-engineering/templates/hooks/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/hooks/hook-stop-verify.ps1 +171 -118
- package/package-source/docs/codex-harness-engineering/templates/hooks/hooks.json +40 -40
- package/package-source/docs/codex-harness-engineering/templates/knowledge/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/knowledge/catalog.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/knowledge/decisions/DECISION-HARNESS-001.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/knowledge/guidelines/GUIDELINE-RULES-001.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/knowledge/knowledge-catalog.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/plan-template.md +252 -252
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/spec-template.md +145 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/tasks-template.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/package-assets/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/AGENTS.md +25 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/README.md +118 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/START-HERE.md +66 -53
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/agent-ecosystem-practices.md +140 -140
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/best-practices.md +9 -9
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/codex-global-rules-example.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/goal-templates.md +380 -380
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/README.md +64 -64
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/openapi.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/orval.config.ts +20 -20
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/ui/TicketFilterBar.tsx +72 -72
- 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
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/progress.txt +1 -1
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/stories/TicketFilterBar.stories.tsx +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/task.json +54 -54
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/verify.ps1 +42 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/global-rules-and-bootstrap.md +157 -157
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/goal-harness-integration-guide.md +364 -364
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-flow.md +7 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-guide.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/knowledge-surface-map.md +186 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/mode-matrix.md +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/new-project-usage.md +176 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/project-agents-template.md +168 -154
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/superpowers-codex-solo-builder-playbook.md +676 -676
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/AGENTS.md +22 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +89 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/dev-plan.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/README.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +161 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/trace-format.md +86 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/11-security-design.md +43 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +690 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +23 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/verify-matrix.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/README.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/commands/e2e.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/README.md +60 -60
- 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
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/catalog.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/architecture.md +358 -358
- 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
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/catalog.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/initial-content.md +296 -296
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/integration-roadmap.md +221 -221
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/architecture-constraints.md +95 -83
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-semantics-and-navigation.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/frontend-quality-rules.md +138 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/service-dependency-matrix.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/speckit-requirements-gate.md +124 -124
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/PACKAGE.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/README.md +52 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/install-agent-here.ps1 +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/agents.md +115 -115
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/HOW_TO_USE_SKILLS.md +79 -79
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/academic-mermaid-diagrams/SKILL.md +172 -172
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/SKILL.md +152 -152
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/references/command-recipes.md +92 -92
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/auto-commit/SKILL.md +324 -322
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/better-icons/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/references/windows-openrouter-clash-playbook.md +94 -94
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/diagnose-openrouter-route.ps1 +282 -282
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/ensure-openrouter-rule.ps1 +101 -101
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/fixing-metadata/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/frontend-design/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/git-xianyu-analyzer/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/SKILL.md +204 -188
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/current-repo-sync-matrix.md +150 -110
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/stale-patterns.md +65 -65
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/init-autopilot/SKILL.md +17 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/log-analysis-optimization/SKILL.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/prd-writer-skill/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-planner/SKILL.md +11 -11
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-runner/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-mock-cleaner/SKILL.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/SKILL.md +67 -67
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/agents/openai.yaml +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/scripts/configure-qoder-codex-api.ps1 +278 -278
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/requirements-design-template/SKILL.md +87 -87
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/skills-index.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-analyze/SKILL.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-checklist/SKILL.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-clarify/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-e2e-tasks/SKILL.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-implement/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-plan/SKILL.md +140 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-specify/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-tasks/SKILL.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-verify/SKILL.md +144 -142
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/SKILL.md +145 -143
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/current-repo-notes.md +42 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/github-samples.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/scripts/collect-root-doc-facts.ps1 +174 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/ai-integrity-and-originality.md +191 -191
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/citation-templates.md +99 -99
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/final-checklist.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/photographer-booking-paper.md +85 -85
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/test-result-templates.md +22 -22
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/thesis-analysis-template.md +63 -63
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/update-codemaps/SKILL.md +31 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/README.md +15 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.analyze.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.checklist.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.clarify.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.e2e-testing.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.implement.md +56 -56
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.plan.md +137 -134
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.specify.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.tasks.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.verify.md +130 -130
- package/package-source/docs/codex-harness-engineering/templates/product/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/product/acceptance-criteria.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/difficulty-research.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/page-inventory.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -158
- package/package-source/docs/codex-harness-engineering/templates/product/requirement-interface-matrix.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -105
- package/package-source/docs/codex-harness-engineering/templates/prompts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/prompts/controller-loop.md +88 -88
- package/package-source/docs/codex-harness-engineering/templates/prompts/failure-triage.md +71 -69
- package/package-source/docs/codex-harness-engineering/templates/prompts/harness-audit.md +54 -52
- package/package-source/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -148
- package/package-source/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -67
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-one-task.md +45 -43
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage1-spec.md +111 -109
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage2-quality.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/prompts/visual-evaluator.md +80 -78
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/backend-worker.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/docs-worker.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/frontend-worker.md +46 -46
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/harness-writer.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/test-runner.md +27 -27
- package/package-source/docs/codex-harness-engineering/templates/runtime/AGENTS.md +66 -50
- package/package-source/docs/codex-harness-engineering/templates/runtime/codex-loop.ps1 +2129 -231
- package/package-source/docs/codex-harness-engineering/templates/runtime/doctor.ps1 +224 -224
- package/package-source/docs/codex-harness-engineering/templates/runtime/project-task-template.json +42 -39
- package/package-source/docs/codex-harness-engineering/templates/runtime/scripts/test-install-modes.ps1 +2 -2
- package/package-source/docs/codex-harness-engineering/templates/runtime/smoke-task.json +52 -52
- package/package-source/docs/codex-harness-engineering/templates/runtime/task-run-profile.json +86 -86
- package/package-source/docs/codex-harness-engineering/templates/runtime/task.json +11 -8
- package/package-source/docs/codex-harness-engineering/templates/runtime/verify.ps1 +21 -21
- package/package-source/docs/codex-harness-engineering/templates/scripts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/spec/10-data-model.md +23 -7
- package/package-source/docs/codex-harness-engineering/templates/spec/11-security-design.md +30 -13
- package/package-source/docs/codex-harness-engineering/templates/spec/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_CRITERIA.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_EXAMPLES.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/testing/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -48
- package/package-source/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +5 -4
- package/package-source/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -20
- package/package-source/docs/codex-harness-engineering/templates/testing/RISK_BASED_TEST_PLAN.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -97
- package/package-source/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +6 -5
- package/package-source/docs/codex-harness-engineering/templates/testing/coverage-policy.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/testing/e2e-plan.md +139 -139
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-findings.example.json +3 -3
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-triage.md +62 -62
- package/package-source/docs/codex-harness-engineering/templates/testing/test-data-plan.md +36 -36
- package/package-source/docs/codex-harness-engineering/templates/testing/test-report.md +85 -41
- package/package-source/docs/codex-harness-engineering/templates/testing/verify-matrix.md +15 -5
- package/package-source/docs/codex-harness-engineering/templates/tools/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/acceptance-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/architecture-lint.ps1 +150 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/backend-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/business-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/component-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/config-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/context-lint.ps1 +187 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/contract-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/data-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/directory-lint.ps1 +152 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/docs-lint.ps1 +40 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/impact-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/integration-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/mobile-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/observability-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/performance-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/refactor-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/security-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/session-lint.ps1 +126 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/spec-lint.ps1 +285 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/state-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/style-lint.ps1 +155 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/testing-lint.ps1 +192 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/ui-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/eval-case.yaml +24 -24
- package/package-source/docs/codex-harness-engineering/templates/trace/trace.schema.json +101 -101
- package/package-source/install-manifest.json +149 -79
- package/package-source/tools/install/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/tools/install/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/tools/install/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/tools/install/bootstrap-codex-harness.ps1 +145 -129
- package/package-source/tools/install/env-check.ps1 +40 -40
- package/package-source/tools/install/init-project.ps1 +1 -1
- package/package-source/tools/install/install-agent-here.ps1 +57 -57
- package/package-source/tools/install/install-agent.ps1 +33 -31
- package/package.json +23 -23
|
@@ -1,358 +1,358 @@
|
|
|
1
|
-
# AI 软件工程质量知识库项目架构
|
|
2
|
-
|
|
3
|
-
本文把外挂总知识库定义为一个完整项目,而不是一组散落 Markdown。项目暂名 `team-wiki`,定位是面向 AI 编程的质量管理与软件工程知识系统。
|
|
4
|
-
|
|
5
|
-
## 1. 项目定位
|
|
6
|
-
|
|
7
|
-
`team-wiki` 不是泛技术百科,也不是简单文档站。它服务于 Codex、reviewer、test-runner、planner 和人类维护者,目标是解决 AI 编程中的质量痛点:
|
|
8
|
-
|
|
9
|
-
- 需求没收敛就开始编码。
|
|
10
|
-
- 任务拆分过大、owned paths 不清。
|
|
11
|
-
- AI 编造完成状态或绕过验证。
|
|
12
|
-
- 测试替身、demo、mock 冒充声明交付路径。
|
|
13
|
-
- review 只看代码风格,不看需求、架构和证据。
|
|
14
|
-
- release 阶段才第一次补测试范围。
|
|
15
|
-
- 多 Agent 并行写冲突。
|
|
16
|
-
- 经验无法复用,每个项目重复踩坑。
|
|
17
|
-
- 规则、prompt、模板越写越重,缺少升级和衰减治理。
|
|
18
|
-
|
|
19
|
-
第一版核心知识域必须围绕质量管理和软件工程,不优先建设 React、Django、Docker 这类技术栈百科。技术栈知识只有在它直接影响质量门禁、验证或工程治理时才进入第一版。
|
|
20
|
-
|
|
21
|
-
允许按领域增加独立扩展包,但扩展包必须服务于生产准入、验证、合规、发布治理或行业风险控制。例如 `app/` 领域扩展用于移动端和全平台 App 的生产可上线检查,不作为泛移动开发教程。
|
|
22
|
-
|
|
23
|
-
## 2. 产品边界
|
|
24
|
-
|
|
25
|
-
### 用户角色
|
|
26
|
-
|
|
27
|
-
| 角色 | 需求 |
|
|
28
|
-
| --- | --- |
|
|
29
|
-
| Codex 实现会话 | 在实现前读取少量高相关质量规则和历史坑 |
|
|
30
|
-
| Planner / Architect | 拆任务、定义架构约束、设计验证闭环 |
|
|
31
|
-
| Stage Reviewer | 根据成熟知识检查需求、架构、验证和风险 |
|
|
32
|
-
| Test Runner | 选择 affected tests、识别假验证和环境坑 |
|
|
33
|
-
| Maintainer | 审批知识晋级、冲突裁决、规则升级 |
|
|
34
|
-
| 新项目接入者 | 快速获得 AI 编程质量基线和项目画像模板 |
|
|
35
|
-
|
|
36
|
-
### 非目标
|
|
37
|
-
|
|
38
|
-
- 不做完整技术百科。
|
|
39
|
-
- 不复制 GitHub 项目的 Wiki、README 或代码。
|
|
40
|
-
- 不替代当前项目 PRD、架构约束、测试矩阵。
|
|
41
|
-
- 不让外部知识库成为 driver 的硬依赖。
|
|
42
|
-
- 不让 Codex 静默把 `draft` 知识升级为 `proven`。
|
|
43
|
-
|
|
44
|
-
## 3. 系统模块
|
|
45
|
-
|
|
46
|
-
```text
|
|
47
|
-
team-wiki/
|
|
48
|
-
content/ # 知识源文件,Git + Markdown
|
|
49
|
-
catalogs/ # 汇总索引和 Agent 查询入口
|
|
50
|
-
schemas/ # frontmatter 和配置 schema
|
|
51
|
-
scripts/ # lint、resolve、export、index
|
|
52
|
-
contributions/ # Codex 或项目导出的 pending/conflict 候选
|
|
53
|
-
reports/ # lint、sync、promotion、decay 报告
|
|
54
|
-
docs/ # 使用说明和治理协议
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
模块职责:
|
|
58
|
-
|
|
59
|
-
| 模块 | 职责 |
|
|
60
|
-
| --- | --- |
|
|
61
|
-
| Content Store | 保存知识条目,是唯一事实源 |
|
|
62
|
-
| Catalog Index | 给人和 Agent 提供低成本查询入口 |
|
|
63
|
-
| Source Resolver | 读取项目 `.knowledge-sources.yml`,解析外挂知识路径 |
|
|
64
|
-
| Lint Engine | 检查 frontmatter、catalog、重复、冲突、成熟度越权 |
|
|
65
|
-
| Sync Engine | 从项目 `docs/knowledge/` 导出团队候选 |
|
|
66
|
-
| Promotion Workflow | 维护 draft/verified/proven 晋级和衰减 |
|
|
67
|
-
| Retrieval Adapter | 第一阶段用 catalog;后续可接 RAG,但 RAG 不做事实源 |
|
|
68
|
-
|
|
69
|
-
## 4. 知识域架构
|
|
70
|
-
|
|
71
|
-
第一版目录按 AI 编程质量问题组织:
|
|
72
|
-
|
|
73
|
-
```text
|
|
74
|
-
team-wiki/
|
|
75
|
-
README.md
|
|
76
|
-
knowledge-catalog.md
|
|
77
|
-
.knowledge-config.yaml
|
|
78
|
-
log.md
|
|
79
|
-
quality-management/
|
|
80
|
-
catalog.md
|
|
81
|
-
requirements-quality/
|
|
82
|
-
verification-engineering/
|
|
83
|
-
review-gates/
|
|
84
|
-
risk-management/
|
|
85
|
-
software-engineering/
|
|
86
|
-
catalog.md
|
|
87
|
-
task-decomposition/
|
|
88
|
-
architecture-constraints/
|
|
89
|
-
integration-quality/
|
|
90
|
-
change-management/
|
|
91
|
-
agent-engineering/
|
|
92
|
-
catalog.md
|
|
93
|
-
workflow-control/
|
|
94
|
-
prompt-and-rule-governance/
|
|
95
|
-
multi-agent-coordination/
|
|
96
|
-
knowledge-governance/
|
|
97
|
-
app/
|
|
98
|
-
catalog.md
|
|
99
|
-
production-readiness/
|
|
100
|
-
project-profiles/
|
|
101
|
-
catalog.md
|
|
102
|
-
contributions/
|
|
103
|
-
pending/
|
|
104
|
-
conflicts/
|
|
105
|
-
reports/
|
|
106
|
-
archive/
|
|
107
|
-
schemas/
|
|
108
|
-
scripts/
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### 质量管理域
|
|
112
|
-
|
|
113
|
-
| 子域 | 解决的问题 |
|
|
114
|
-
| --- | --- |
|
|
115
|
-
| `requirements-quality/` | 需求可测试性、验收标准、Requirement ID、追溯矩阵 |
|
|
116
|
-
| `verification-engineering/` | affected tests、fresh evidence、失败态证据、假验证 |
|
|
117
|
-
| `review-gates/` | Stage 1/2 分工、finding 格式、repair queue |
|
|
118
|
-
| `risk-management/` | 外部依赖、安全、权限、数据、部署风险 |
|
|
119
|
-
|
|
120
|
-
### 软件工程域
|
|
121
|
-
|
|
122
|
-
| 子域 | 解决的问题 |
|
|
123
|
-
| --- | --- |
|
|
124
|
-
| `task-decomposition/` | task.json 拆分、owned paths、dependencies、单任务闭环 |
|
|
125
|
-
| `architecture-constraints/` | 交付形态、公开入口、数据边界、异步边界、禁止伪实现 |
|
|
126
|
-
| `integration-quality/` | contract first、真实依赖、mock 切真实接口、联调证据 |
|
|
127
|
-
| `change-management/` | 变更范围、回归、兼容性、迁移和发布收口 |
|
|
128
|
-
|
|
129
|
-
### Agent 工程域
|
|
130
|
-
|
|
131
|
-
| 子域 | 解决的问题 |
|
|
132
|
-
| --- | --- |
|
|
133
|
-
| `workflow-control/` | driver-first、truth source、BLOCKED 协议、不伪造状态 |
|
|
134
|
-
| `prompt-and-rule-governance/` | AGENTS/prompt/template 的写入边界和升级条件 |
|
|
135
|
-
| `multi-agent-coordination/` | 并行任务、写路径隔离、handoff、review 复验 |
|
|
136
|
-
| `knowledge-governance/` | draft/verified/proven、冲突、衰减、归档、团队同步 |
|
|
137
|
-
|
|
138
|
-
### App 生产可上线域
|
|
139
|
-
|
|
140
|
-
`app/` 是领域扩展包,不属于第一版核心三大域的替代项。它面向移动端和全平台 App 的生产发布质量,只有在任务涉及 App、H5 / WebView、Hybrid、小程序、商店审核、支付、隐私、安全、灰度、回滚、移动端 QA 或行业专项时才按需读取。
|
|
141
|
-
|
|
142
|
-
| 子域 | 解决的问题 |
|
|
143
|
-
| --- | --- |
|
|
144
|
-
| `production-readiness/` | iOS、Android、H5 / WebView、小程序、后台、服务端、支付、隐私、安全、商店审核、灰度、回滚和 Release Gate |
|
|
145
|
-
| `industry-cases/` | 电商、宠物商城等行业案例、P0 测试用例、高风险边界和行业专项 Release Gate |
|
|
146
|
-
|
|
147
|
-
## 5. 数据模型
|
|
148
|
-
|
|
149
|
-
### 知识条目
|
|
150
|
-
|
|
151
|
-
```yaml
|
|
152
|
-
id: GUIDELINE-VERIFY-001
|
|
153
|
-
type: guideline
|
|
154
|
-
domain: quality-management
|
|
155
|
-
subdomain: verification-engineering
|
|
156
|
-
maturity: draft
|
|
157
|
-
tags: [verification, ai-coding, evidence]
|
|
158
|
-
applicable_phases: [plan, implement, review, verify]
|
|
159
|
-
source_references:
|
|
160
|
-
- project: codex-herness
|
|
161
|
-
ref: docs/harness/regression-rules.md
|
|
162
|
-
validated_projects: []
|
|
163
|
-
last_referenced:
|
|
164
|
-
contradictions: []
|
|
165
|
-
contributors:
|
|
166
|
-
- codex
|
|
167
|
-
owner:
|
|
168
|
-
not_applicable_when: []
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
正文必须包含:
|
|
172
|
-
|
|
173
|
-
```markdown
|
|
174
|
-
# 标题
|
|
175
|
-
|
|
176
|
-
## Problem
|
|
177
|
-
|
|
178
|
-
## Guidance
|
|
179
|
-
|
|
180
|
-
## Not Applicable When
|
|
181
|
-
|
|
182
|
-
## Evidence
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
### 项目画像
|
|
186
|
-
|
|
187
|
-
```yaml
|
|
188
|
-
project_slug:
|
|
189
|
-
domains: []
|
|
190
|
-
tech_stack: []
|
|
191
|
-
delivery_shape:
|
|
192
|
-
quality_profile:
|
|
193
|
-
critical_paths: []
|
|
194
|
-
required_gates: []
|
|
195
|
-
verification_baseline: []
|
|
196
|
-
knowledge_sources:
|
|
197
|
-
project: docs/knowledge
|
|
198
|
-
team:
|
|
199
|
-
validated_rules: []
|
|
200
|
-
known_conflicts: []
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
项目画像用于过滤团队知识,避免把不相关技术栈或业务域注入到当前任务。
|
|
204
|
-
|
|
205
|
-
### 贡献候选
|
|
206
|
-
|
|
207
|
-
```yaml
|
|
208
|
-
candidate_id:
|
|
209
|
-
source_project:
|
|
210
|
-
source_entry:
|
|
211
|
-
target_domain:
|
|
212
|
-
target_subdomain:
|
|
213
|
-
suggested_action: add | merge | promote | conflict | decay
|
|
214
|
-
evidence:
|
|
215
|
-
review_required: true
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
候选只进入 `contributions/pending/` 或 `contributions/conflicts/`,不直接改主干条目。
|
|
219
|
-
|
|
220
|
-
## 6. 来源策略
|
|
221
|
-
|
|
222
|
-
`team-wiki` 不是复制别人的 Wiki,而是把可授权、可追溯、可验证的来源提炼成团队自己的短条目。
|
|
223
|
-
|
|
224
|
-
| 来源 | 优先级 | 用法 | 初始成熟度 |
|
|
225
|
-
| --- | --- | --- | --- |
|
|
226
|
-
| 团队真实项目经验 | 最高 | 从 trace、review、失败记录、事故复盘和测试缺口提炼 | `draft`,复用验证后升级 |
|
|
227
|
-
| 官方文档和标准 | 高 | 摘要规则、链接来源、写明版本或适用范围 | `draft` 或 `verified` |
|
|
228
|
-
| 优秀开源项目实践 | 中 | 借鉴目录、流程、测试、CI、ADR 和治理模式,不复制原文 | `draft` |
|
|
229
|
-
| 公开文章和案例 | 中低 | 作为启发和候选,不作为强约束 | `draft` |
|
|
230
|
-
| 人工访谈和团队约定 | 高 | 记录来源人、日期、适用项目和验证计划 | `draft` |
|
|
231
|
-
|
|
232
|
-
禁止事项:
|
|
233
|
-
|
|
234
|
-
- 不直接复制 GitHub 项目的 README、Wiki、文档或代码作为知识条目。
|
|
235
|
-
- 不复制许可证不清晰的大段文本。
|
|
236
|
-
- 不把别人项目的具体路径、命令、部署和业务规则当成通用规则。
|
|
237
|
-
- 不把博客观点直接写成 `proven`。
|
|
238
|
-
- 不收录 token、cookie、私钥、客户数据、内部密钥或真实敏感配置。
|
|
239
|
-
|
|
240
|
-
## 7. 成熟度和治理
|
|
241
|
-
|
|
242
|
-
| 成熟度 | 定义 | 使用边界 |
|
|
243
|
-
| --- | --- | --- |
|
|
244
|
-
| `draft` | 单项目、单任务或人工导入候选 | 只能启发分析,不能作为阻塞性 review 依据 |
|
|
245
|
-
| `verified` | 至少一个真实任务引用并通过验证 | 可作为 reviewer 辅助依据 |
|
|
246
|
-
| `proven` | 至少两个不同任务或项目验证,或 maintainer 审批 | 可提升为规则、模板、prompt 或默认检查 |
|
|
247
|
-
|
|
248
|
-
规则:
|
|
249
|
-
|
|
250
|
-
- `draft -> verified` 需要真实任务引用和验证证据。
|
|
251
|
-
- `verified -> proven` 需要两个不同任务或项目证据,或 maintainer 明确审批。
|
|
252
|
-
- 冲突条目保留较低成熟度,并进入 `contributions/conflicts/`。
|
|
253
|
-
- 长期未引用条目进入 decay candidate,不自动删除。
|
|
254
|
-
- 只有 `proven` 或用户明确要求,才考虑升级到 `AGENTS.md`、prompt、模板或脚本。
|
|
255
|
-
|
|
256
|
-
## 8. 查询和接入
|
|
257
|
-
|
|
258
|
-
项目根目录使用 `.knowledge-sources.yml` 声明外挂知识:
|
|
259
|
-
|
|
260
|
-
```yaml
|
|
261
|
-
schema_version: 1
|
|
262
|
-
sources:
|
|
263
|
-
project:
|
|
264
|
-
path: docs/knowledge
|
|
265
|
-
required: true
|
|
266
|
-
team:
|
|
267
|
-
path: ../team-wiki
|
|
268
|
-
required: false
|
|
269
|
-
catalogs:
|
|
270
|
-
- knowledge-catalog.md
|
|
271
|
-
- quality-management/catalog.md
|
|
272
|
-
- software-engineering/catalog.md
|
|
273
|
-
- agent-engineering/catalog.md
|
|
274
|
-
- app/catalog.md
|
|
275
|
-
query:
|
|
276
|
-
max_catalogs: 4
|
|
277
|
-
max_entries: 8
|
|
278
|
-
prefer_maturity: [proven, verified, draft]
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
Codex 查询顺序:
|
|
282
|
-
|
|
283
|
-
1. 当前项目 truth source:PRD、架构约束、测试矩阵、项目 `docs/knowledge/`。
|
|
284
|
-
2. `.knowledge-sources.yml` 中可用的团队 catalog。
|
|
285
|
-
3. 按 domain、subdomain、tags、phase、maturity 过滤。
|
|
286
|
-
4. 读取少量相关条目。
|
|
287
|
-
5. 最终报告列出 `knowledge_references`,包括 `source=project|team`。
|
|
288
|
-
|
|
289
|
-
外挂知识不可用时只降级 warning,不能阻塞本地实现验证。
|
|
290
|
-
|
|
291
|
-
长文档接入规则:
|
|
292
|
-
|
|
293
|
-
- catalog 是默认入口,完整长文档不是默认上下文。
|
|
294
|
-
- 长文档必须通过 catalog 暴露摘要、适用阶段、使用边界和路径。
|
|
295
|
-
- 只有任务显式命中相关平台、行业、发布或验证风险时,才读取长文档相关章节。
|
|
296
|
-
- 如果长文档中的 `draft` 建议与项目 truth source 冲突,以项目事实为准,并输出 conflict candidate。
|
|
297
|
-
|
|
298
|
-
## 9. 脚本和接口
|
|
299
|
-
|
|
300
|
-
第一版至少需要:
|
|
301
|
-
|
|
302
|
-
```text
|
|
303
|
-
scripts/
|
|
304
|
-
resolve-sources.ps1 # 解析 .knowledge-sources.yml
|
|
305
|
-
lint-knowledge.ps1 # 检查条目和 catalog
|
|
306
|
-
export-team-candidates.ps1 # 从项目知识导出 pending/conflict
|
|
307
|
-
build-agent-index.ps1 # 生成给 Agent 快速读取的摘要索引
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
脚本边界:
|
|
311
|
-
|
|
312
|
-
- 不自动删除知识。
|
|
313
|
-
- 不静默提升为 `proven`。
|
|
314
|
-
- 不修改外部仓库主干,只写 pending/conflicts/report。
|
|
315
|
-
- 外挂库不可用时 exit 0 + warning,除非用户显式要求强制同步。
|
|
316
|
-
|
|
317
|
-
## 10. 质量门禁
|
|
318
|
-
|
|
319
|
-
项目自身必须有质量门禁:
|
|
320
|
-
|
|
321
|
-
| 门禁 | 命令或检查 |
|
|
322
|
-
| --- | --- |
|
|
323
|
-
| Markdown 格式 | `git diff --check` |
|
|
324
|
-
| Frontmatter 完整 | `lint-knowledge.ps1` |
|
|
325
|
-
| Catalog 一致 | `lint-knowledge.ps1` |
|
|
326
|
-
| 敏感信息扫描 | 禁止 token、cookie、私钥、客户数据 |
|
|
327
|
-
| 成熟度越权 | proven 必须有多项目证据或审批 |
|
|
328
|
-
| 冲突检查 | 相反指导进入 conflicts |
|
|
329
|
-
|
|
330
|
-
## 11. 与 RAG 的关系
|
|
331
|
-
|
|
332
|
-
第一阶段不需要向量库。满足以下条件再接 RAG:
|
|
333
|
-
|
|
334
|
-
- 条目超过 300 条。
|
|
335
|
-
- catalog-first 检索已经不足。
|
|
336
|
-
- frontmatter、chunk、权限和引用格式稳定。
|
|
337
|
-
|
|
338
|
-
RAG 只做召回层。事实来源仍是 Git 中的 Markdown 条目,最终引用必须指向 Markdown 文件。
|
|
339
|
-
|
|
340
|
-
## 12. MVP 范围
|
|
341
|
-
|
|
342
|
-
第一版 MVP 只做:
|
|
343
|
-
|
|
344
|
-
1. `team-wiki` 仓库骨架。
|
|
345
|
-
2. 三大知识域:`quality-management`、`software-engineering`、`agent-engineering`。
|
|
346
|
-
3. 10-20 条 `draft` 种子知识。
|
|
347
|
-
4. `.knowledge-config.yaml` 和 `knowledge-catalog.md`。
|
|
348
|
-
5. `lint-knowledge.ps1` 和 `resolve-sources.ps1`。
|
|
349
|
-
6. 项目侧 `.knowledge-sources.yml` 示例。
|
|
350
|
-
7. Codex prompt 查询协议更新。
|
|
351
|
-
|
|
352
|
-
不做:
|
|
353
|
-
|
|
354
|
-
- Web UI。
|
|
355
|
-
- 向量库。
|
|
356
|
-
- 自动写团队知识主干。
|
|
357
|
-
- 技术栈百科。
|
|
358
|
-
- 自动升级 `proven`。
|
|
1
|
+
# AI 软件工程质量知识库项目架构
|
|
2
|
+
|
|
3
|
+
本文把外挂总知识库定义为一个完整项目,而不是一组散落 Markdown。项目暂名 `team-wiki`,定位是面向 AI 编程的质量管理与软件工程知识系统。
|
|
4
|
+
|
|
5
|
+
## 1. 项目定位
|
|
6
|
+
|
|
7
|
+
`team-wiki` 不是泛技术百科,也不是简单文档站。它服务于 Codex、reviewer、test-runner、planner 和人类维护者,目标是解决 AI 编程中的质量痛点:
|
|
8
|
+
|
|
9
|
+
- 需求没收敛就开始编码。
|
|
10
|
+
- 任务拆分过大、owned paths 不清。
|
|
11
|
+
- AI 编造完成状态或绕过验证。
|
|
12
|
+
- 测试替身、demo、mock 冒充声明交付路径。
|
|
13
|
+
- review 只看代码风格,不看需求、架构和证据。
|
|
14
|
+
- release 阶段才第一次补测试范围。
|
|
15
|
+
- 多 Agent 并行写冲突。
|
|
16
|
+
- 经验无法复用,每个项目重复踩坑。
|
|
17
|
+
- 规则、prompt、模板越写越重,缺少升级和衰减治理。
|
|
18
|
+
|
|
19
|
+
第一版核心知识域必须围绕质量管理和软件工程,不优先建设 React、Django、Docker 这类技术栈百科。技术栈知识只有在它直接影响质量门禁、验证或工程治理时才进入第一版。
|
|
20
|
+
|
|
21
|
+
允许按领域增加独立扩展包,但扩展包必须服务于生产准入、验证、合规、发布治理或行业风险控制。例如 `app/` 领域扩展用于移动端和全平台 App 的生产可上线检查,不作为泛移动开发教程。
|
|
22
|
+
|
|
23
|
+
## 2. 产品边界
|
|
24
|
+
|
|
25
|
+
### 用户角色
|
|
26
|
+
|
|
27
|
+
| 角色 | 需求 |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| Codex 实现会话 | 在实现前读取少量高相关质量规则和历史坑 |
|
|
30
|
+
| Planner / Architect | 拆任务、定义架构约束、设计验证闭环 |
|
|
31
|
+
| Stage Reviewer | 根据成熟知识检查需求、架构、验证和风险 |
|
|
32
|
+
| Test Runner | 选择 affected tests、识别假验证和环境坑 |
|
|
33
|
+
| Maintainer | 审批知识晋级、冲突裁决、规则升级 |
|
|
34
|
+
| 新项目接入者 | 快速获得 AI 编程质量基线和项目画像模板 |
|
|
35
|
+
|
|
36
|
+
### 非目标
|
|
37
|
+
|
|
38
|
+
- 不做完整技术百科。
|
|
39
|
+
- 不复制 GitHub 项目的 Wiki、README 或代码。
|
|
40
|
+
- 不替代当前项目 PRD、架构约束、测试矩阵。
|
|
41
|
+
- 不让外部知识库成为 driver 的硬依赖。
|
|
42
|
+
- 不让 Codex 静默把 `draft` 知识升级为 `proven`。
|
|
43
|
+
|
|
44
|
+
## 3. 系统模块
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
team-wiki/
|
|
48
|
+
content/ # 知识源文件,Git + Markdown
|
|
49
|
+
catalogs/ # 汇总索引和 Agent 查询入口
|
|
50
|
+
schemas/ # frontmatter 和配置 schema
|
|
51
|
+
scripts/ # lint、resolve、export、index
|
|
52
|
+
contributions/ # Codex 或项目导出的 pending/conflict 候选
|
|
53
|
+
reports/ # lint、sync、promotion、decay 报告
|
|
54
|
+
docs/ # 使用说明和治理协议
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
模块职责:
|
|
58
|
+
|
|
59
|
+
| 模块 | 职责 |
|
|
60
|
+
| --- | --- |
|
|
61
|
+
| Content Store | 保存知识条目,是唯一事实源 |
|
|
62
|
+
| Catalog Index | 给人和 Agent 提供低成本查询入口 |
|
|
63
|
+
| Source Resolver | 读取项目 `.knowledge-sources.yml`,解析外挂知识路径 |
|
|
64
|
+
| Lint Engine | 检查 frontmatter、catalog、重复、冲突、成熟度越权 |
|
|
65
|
+
| Sync Engine | 从项目 `docs/knowledge/` 导出团队候选 |
|
|
66
|
+
| Promotion Workflow | 维护 draft/verified/proven 晋级和衰减 |
|
|
67
|
+
| Retrieval Adapter | 第一阶段用 catalog;后续可接 RAG,但 RAG 不做事实源 |
|
|
68
|
+
|
|
69
|
+
## 4. 知识域架构
|
|
70
|
+
|
|
71
|
+
第一版目录按 AI 编程质量问题组织:
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
team-wiki/
|
|
75
|
+
README.md
|
|
76
|
+
knowledge-catalog.md
|
|
77
|
+
.knowledge-config.yaml
|
|
78
|
+
log.md
|
|
79
|
+
quality-management/
|
|
80
|
+
catalog.md
|
|
81
|
+
requirements-quality/
|
|
82
|
+
verification-engineering/
|
|
83
|
+
review-gates/
|
|
84
|
+
risk-management/
|
|
85
|
+
software-engineering/
|
|
86
|
+
catalog.md
|
|
87
|
+
task-decomposition/
|
|
88
|
+
architecture-constraints/
|
|
89
|
+
integration-quality/
|
|
90
|
+
change-management/
|
|
91
|
+
agent-engineering/
|
|
92
|
+
catalog.md
|
|
93
|
+
workflow-control/
|
|
94
|
+
prompt-and-rule-governance/
|
|
95
|
+
multi-agent-coordination/
|
|
96
|
+
knowledge-governance/
|
|
97
|
+
app/
|
|
98
|
+
catalog.md
|
|
99
|
+
production-readiness/
|
|
100
|
+
project-profiles/
|
|
101
|
+
catalog.md
|
|
102
|
+
contributions/
|
|
103
|
+
pending/
|
|
104
|
+
conflicts/
|
|
105
|
+
reports/
|
|
106
|
+
archive/
|
|
107
|
+
schemas/
|
|
108
|
+
scripts/
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 质量管理域
|
|
112
|
+
|
|
113
|
+
| 子域 | 解决的问题 |
|
|
114
|
+
| --- | --- |
|
|
115
|
+
| `requirements-quality/` | 需求可测试性、验收标准、Requirement ID、追溯矩阵 |
|
|
116
|
+
| `verification-engineering/` | affected tests、fresh evidence、失败态证据、假验证 |
|
|
117
|
+
| `review-gates/` | Stage 1/2 分工、finding 格式、repair queue |
|
|
118
|
+
| `risk-management/` | 外部依赖、安全、权限、数据、部署风险 |
|
|
119
|
+
|
|
120
|
+
### 软件工程域
|
|
121
|
+
|
|
122
|
+
| 子域 | 解决的问题 |
|
|
123
|
+
| --- | --- |
|
|
124
|
+
| `task-decomposition/` | task.json 拆分、owned paths、dependencies、单任务闭环 |
|
|
125
|
+
| `architecture-constraints/` | 交付形态、公开入口、数据边界、异步边界、禁止伪实现 |
|
|
126
|
+
| `integration-quality/` | contract first、真实依赖、mock 切真实接口、联调证据 |
|
|
127
|
+
| `change-management/` | 变更范围、回归、兼容性、迁移和发布收口 |
|
|
128
|
+
|
|
129
|
+
### Agent 工程域
|
|
130
|
+
|
|
131
|
+
| 子域 | 解决的问题 |
|
|
132
|
+
| --- | --- |
|
|
133
|
+
| `workflow-control/` | driver-first、truth source、BLOCKED 协议、不伪造状态 |
|
|
134
|
+
| `prompt-and-rule-governance/` | AGENTS/prompt/template 的写入边界和升级条件 |
|
|
135
|
+
| `multi-agent-coordination/` | 并行任务、写路径隔离、handoff、review 复验 |
|
|
136
|
+
| `knowledge-governance/` | draft/verified/proven、冲突、衰减、归档、团队同步 |
|
|
137
|
+
|
|
138
|
+
### App 生产可上线域
|
|
139
|
+
|
|
140
|
+
`app/` 是领域扩展包,不属于第一版核心三大域的替代项。它面向移动端和全平台 App 的生产发布质量,只有在任务涉及 App、H5 / WebView、Hybrid、小程序、商店审核、支付、隐私、安全、灰度、回滚、移动端 QA 或行业专项时才按需读取。
|
|
141
|
+
|
|
142
|
+
| 子域 | 解决的问题 |
|
|
143
|
+
| --- | --- |
|
|
144
|
+
| `production-readiness/` | iOS、Android、H5 / WebView、小程序、后台、服务端、支付、隐私、安全、商店审核、灰度、回滚和 Release Gate |
|
|
145
|
+
| `industry-cases/` | 电商、宠物商城等行业案例、P0 测试用例、高风险边界和行业专项 Release Gate |
|
|
146
|
+
|
|
147
|
+
## 5. 数据模型
|
|
148
|
+
|
|
149
|
+
### 知识条目
|
|
150
|
+
|
|
151
|
+
```yaml
|
|
152
|
+
id: GUIDELINE-VERIFY-001
|
|
153
|
+
type: guideline
|
|
154
|
+
domain: quality-management
|
|
155
|
+
subdomain: verification-engineering
|
|
156
|
+
maturity: draft
|
|
157
|
+
tags: [verification, ai-coding, evidence]
|
|
158
|
+
applicable_phases: [plan, implement, review, verify]
|
|
159
|
+
source_references:
|
|
160
|
+
- project: codex-herness
|
|
161
|
+
ref: docs/harness/regression-rules.md
|
|
162
|
+
validated_projects: []
|
|
163
|
+
last_referenced:
|
|
164
|
+
contradictions: []
|
|
165
|
+
contributors:
|
|
166
|
+
- codex
|
|
167
|
+
owner:
|
|
168
|
+
not_applicable_when: []
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
正文必须包含:
|
|
172
|
+
|
|
173
|
+
```markdown
|
|
174
|
+
# 标题
|
|
175
|
+
|
|
176
|
+
## Problem
|
|
177
|
+
|
|
178
|
+
## Guidance
|
|
179
|
+
|
|
180
|
+
## Not Applicable When
|
|
181
|
+
|
|
182
|
+
## Evidence
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### 项目画像
|
|
186
|
+
|
|
187
|
+
```yaml
|
|
188
|
+
project_slug:
|
|
189
|
+
domains: []
|
|
190
|
+
tech_stack: []
|
|
191
|
+
delivery_shape:
|
|
192
|
+
quality_profile:
|
|
193
|
+
critical_paths: []
|
|
194
|
+
required_gates: []
|
|
195
|
+
verification_baseline: []
|
|
196
|
+
knowledge_sources:
|
|
197
|
+
project: docs/knowledge
|
|
198
|
+
team:
|
|
199
|
+
validated_rules: []
|
|
200
|
+
known_conflicts: []
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
项目画像用于过滤团队知识,避免把不相关技术栈或业务域注入到当前任务。
|
|
204
|
+
|
|
205
|
+
### 贡献候选
|
|
206
|
+
|
|
207
|
+
```yaml
|
|
208
|
+
candidate_id:
|
|
209
|
+
source_project:
|
|
210
|
+
source_entry:
|
|
211
|
+
target_domain:
|
|
212
|
+
target_subdomain:
|
|
213
|
+
suggested_action: add | merge | promote | conflict | decay
|
|
214
|
+
evidence:
|
|
215
|
+
review_required: true
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
候选只进入 `contributions/pending/` 或 `contributions/conflicts/`,不直接改主干条目。
|
|
219
|
+
|
|
220
|
+
## 6. 来源策略
|
|
221
|
+
|
|
222
|
+
`team-wiki` 不是复制别人的 Wiki,而是把可授权、可追溯、可验证的来源提炼成团队自己的短条目。
|
|
223
|
+
|
|
224
|
+
| 来源 | 优先级 | 用法 | 初始成熟度 |
|
|
225
|
+
| --- | --- | --- | --- |
|
|
226
|
+
| 团队真实项目经验 | 最高 | 从 trace、review、失败记录、事故复盘和测试缺口提炼 | `draft`,复用验证后升级 |
|
|
227
|
+
| 官方文档和标准 | 高 | 摘要规则、链接来源、写明版本或适用范围 | `draft` 或 `verified` |
|
|
228
|
+
| 优秀开源项目实践 | 中 | 借鉴目录、流程、测试、CI、ADR 和治理模式,不复制原文 | `draft` |
|
|
229
|
+
| 公开文章和案例 | 中低 | 作为启发和候选,不作为强约束 | `draft` |
|
|
230
|
+
| 人工访谈和团队约定 | 高 | 记录来源人、日期、适用项目和验证计划 | `draft` |
|
|
231
|
+
|
|
232
|
+
禁止事项:
|
|
233
|
+
|
|
234
|
+
- 不直接复制 GitHub 项目的 README、Wiki、文档或代码作为知识条目。
|
|
235
|
+
- 不复制许可证不清晰的大段文本。
|
|
236
|
+
- 不把别人项目的具体路径、命令、部署和业务规则当成通用规则。
|
|
237
|
+
- 不把博客观点直接写成 `proven`。
|
|
238
|
+
- 不收录 token、cookie、私钥、客户数据、内部密钥或真实敏感配置。
|
|
239
|
+
|
|
240
|
+
## 7. 成熟度和治理
|
|
241
|
+
|
|
242
|
+
| 成熟度 | 定义 | 使用边界 |
|
|
243
|
+
| --- | --- | --- |
|
|
244
|
+
| `draft` | 单项目、单任务或人工导入候选 | 只能启发分析,不能作为阻塞性 review 依据 |
|
|
245
|
+
| `verified` | 至少一个真实任务引用并通过验证 | 可作为 reviewer 辅助依据 |
|
|
246
|
+
| `proven` | 至少两个不同任务或项目验证,或 maintainer 审批 | 可提升为规则、模板、prompt 或默认检查 |
|
|
247
|
+
|
|
248
|
+
规则:
|
|
249
|
+
|
|
250
|
+
- `draft -> verified` 需要真实任务引用和验证证据。
|
|
251
|
+
- `verified -> proven` 需要两个不同任务或项目证据,或 maintainer 明确审批。
|
|
252
|
+
- 冲突条目保留较低成熟度,并进入 `contributions/conflicts/`。
|
|
253
|
+
- 长期未引用条目进入 decay candidate,不自动删除。
|
|
254
|
+
- 只有 `proven` 或用户明确要求,才考虑升级到 `AGENTS.md`、prompt、模板或脚本。
|
|
255
|
+
|
|
256
|
+
## 8. 查询和接入
|
|
257
|
+
|
|
258
|
+
项目根目录使用 `.knowledge-sources.yml` 声明外挂知识:
|
|
259
|
+
|
|
260
|
+
```yaml
|
|
261
|
+
schema_version: 1
|
|
262
|
+
sources:
|
|
263
|
+
project:
|
|
264
|
+
path: docs/knowledge
|
|
265
|
+
required: true
|
|
266
|
+
team:
|
|
267
|
+
path: ../team-wiki
|
|
268
|
+
required: false
|
|
269
|
+
catalogs:
|
|
270
|
+
- knowledge-catalog.md
|
|
271
|
+
- quality-management/catalog.md
|
|
272
|
+
- software-engineering/catalog.md
|
|
273
|
+
- agent-engineering/catalog.md
|
|
274
|
+
- app/catalog.md
|
|
275
|
+
query:
|
|
276
|
+
max_catalogs: 4
|
|
277
|
+
max_entries: 8
|
|
278
|
+
prefer_maturity: [proven, verified, draft]
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
Codex 查询顺序:
|
|
282
|
+
|
|
283
|
+
1. 当前项目 truth source:PRD、架构约束、测试矩阵、项目 `docs/knowledge/`。
|
|
284
|
+
2. `.knowledge-sources.yml` 中可用的团队 catalog。
|
|
285
|
+
3. 按 domain、subdomain、tags、phase、maturity 过滤。
|
|
286
|
+
4. 读取少量相关条目。
|
|
287
|
+
5. 最终报告列出 `knowledge_references`,包括 `source=project|team`。
|
|
288
|
+
|
|
289
|
+
外挂知识不可用时只降级 warning,不能阻塞本地实现验证。
|
|
290
|
+
|
|
291
|
+
长文档接入规则:
|
|
292
|
+
|
|
293
|
+
- catalog 是默认入口,完整长文档不是默认上下文。
|
|
294
|
+
- 长文档必须通过 catalog 暴露摘要、适用阶段、使用边界和路径。
|
|
295
|
+
- 只有任务显式命中相关平台、行业、发布或验证风险时,才读取长文档相关章节。
|
|
296
|
+
- 如果长文档中的 `draft` 建议与项目 truth source 冲突,以项目事实为准,并输出 conflict candidate。
|
|
297
|
+
|
|
298
|
+
## 9. 脚本和接口
|
|
299
|
+
|
|
300
|
+
第一版至少需要:
|
|
301
|
+
|
|
302
|
+
```text
|
|
303
|
+
scripts/
|
|
304
|
+
resolve-sources.ps1 # 解析 .knowledge-sources.yml
|
|
305
|
+
lint-knowledge.ps1 # 检查条目和 catalog
|
|
306
|
+
export-team-candidates.ps1 # 从项目知识导出 pending/conflict
|
|
307
|
+
build-agent-index.ps1 # 生成给 Agent 快速读取的摘要索引
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
脚本边界:
|
|
311
|
+
|
|
312
|
+
- 不自动删除知识。
|
|
313
|
+
- 不静默提升为 `proven`。
|
|
314
|
+
- 不修改外部仓库主干,只写 pending/conflicts/report。
|
|
315
|
+
- 外挂库不可用时 exit 0 + warning,除非用户显式要求强制同步。
|
|
316
|
+
|
|
317
|
+
## 10. 质量门禁
|
|
318
|
+
|
|
319
|
+
项目自身必须有质量门禁:
|
|
320
|
+
|
|
321
|
+
| 门禁 | 命令或检查 |
|
|
322
|
+
| --- | --- |
|
|
323
|
+
| Markdown 格式 | `git diff --check` |
|
|
324
|
+
| Frontmatter 完整 | `lint-knowledge.ps1` |
|
|
325
|
+
| Catalog 一致 | `lint-knowledge.ps1` |
|
|
326
|
+
| 敏感信息扫描 | 禁止 token、cookie、私钥、客户数据 |
|
|
327
|
+
| 成熟度越权 | proven 必须有多项目证据或审批 |
|
|
328
|
+
| 冲突检查 | 相反指导进入 conflicts |
|
|
329
|
+
|
|
330
|
+
## 11. 与 RAG 的关系
|
|
331
|
+
|
|
332
|
+
第一阶段不需要向量库。满足以下条件再接 RAG:
|
|
333
|
+
|
|
334
|
+
- 条目超过 300 条。
|
|
335
|
+
- catalog-first 检索已经不足。
|
|
336
|
+
- frontmatter、chunk、权限和引用格式稳定。
|
|
337
|
+
|
|
338
|
+
RAG 只做召回层。事实来源仍是 Git 中的 Markdown 条目,最终引用必须指向 Markdown 文件。
|
|
339
|
+
|
|
340
|
+
## 12. MVP 范围
|
|
341
|
+
|
|
342
|
+
第一版 MVP 只做:
|
|
343
|
+
|
|
344
|
+
1. `team-wiki` 仓库骨架。
|
|
345
|
+
2. 三大知识域:`quality-management`、`software-engineering`、`agent-engineering`。
|
|
346
|
+
3. 10-20 条 `draft` 种子知识。
|
|
347
|
+
4. `.knowledge-config.yaml` 和 `knowledge-catalog.md`。
|
|
348
|
+
5. `lint-knowledge.ps1` 和 `resolve-sources.ps1`。
|
|
349
|
+
6. 项目侧 `.knowledge-sources.yml` 示例。
|
|
350
|
+
7. Codex prompt 查询协议更新。
|
|
351
|
+
|
|
352
|
+
不做:
|
|
353
|
+
|
|
354
|
+
- Web UI。
|
|
355
|
+
- 向量库。
|
|
356
|
+
- 自动写团队知识主干。
|
|
357
|
+
- 技术栈百科。
|
|
358
|
+
- 自动升级 `proven`。
|