coding-agent-harness 1.0.1 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/CONTRIBUTING.md +98 -0
- package/README.en-US.md +14 -0
- package/README.md +230 -80
- package/README.zh-CN.md +290 -0
- package/SKILL.md +132 -198
- package/docs-release/README.md +80 -9
- package/docs-release/architecture/overview.md +298 -28
- package/docs-release/architecture/overview.zh-CN.md +292 -0
- package/docs-release/assets/dashboard-overview.png +0 -0
- package/docs-release/assets/harness-architecture.svg +163 -0
- package/docs-release/assets/harness-workflow.svg +64 -0
- package/docs-release/guides/agent-installation.en-US.md +237 -0
- package/docs-release/guides/agent-installation.md +149 -27
- package/docs-release/guides/contributing.md +100 -0
- package/docs-release/guides/contributing.zh-CN.md +99 -0
- package/docs-release/guides/document-audience-and-surfaces.en-US.md +113 -0
- package/docs-release/guides/document-audience-and-surfaces.md +113 -0
- package/docs-release/guides/full-legacy-migration-subagent-strategy.md +334 -0
- package/docs-release/guides/full-legacy-migration-subagent-strategy.zh-CN.md +334 -0
- package/docs-release/guides/legacy-migration-agent-prompt.md +373 -0
- package/docs-release/guides/legacy-migration-agent-prompt.zh-CN.md +350 -0
- package/docs-release/guides/migration-playbook.en-US.md +324 -0
- package/docs-release/guides/migration-playbook.md +328 -0
- package/docs-release/guides/parent-control-repository-pattern.en-US.md +254 -0
- package/docs-release/guides/parent-control-repository-pattern.md +254 -0
- package/docs-release/guides/preset-development.md +214 -0
- package/docs-release/guides/repository-operating-models.en-US.md +197 -0
- package/docs-release/guides/repository-operating-models.md +197 -0
- package/docs-release/guides/task-state-machine.en-US.md +207 -0
- package/docs-release/guides/task-state-machine.md +214 -0
- package/docs-release/intl/README.md +15 -0
- package/docs-release/intl/de-DE.md +18 -0
- package/docs-release/intl/en-US.md +18 -0
- package/docs-release/intl/es-ES.md +18 -0
- package/docs-release/intl/fr-FR.md +18 -0
- package/docs-release/intl/ja-JP.md +18 -0
- package/docs-release/intl/ko-KR.md +18 -0
- package/docs-release/intl/zh-CN.md +18 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/brief.md +13 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/findings.md +7 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/lesson_candidates.md +24 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/progress.md +1 -1
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/task_plan.md +4 -2
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/{visual_roadmap.md → visual_map.md} +9 -1
- package/package.json +10 -3
- package/presets/legacy-migration/checks/preset-check.mjs +3 -0
- package/presets/legacy-migration/preset.yaml +134 -0
- package/presets/legacy-migration/scripts/plan-work-queue.mjs +4 -0
- package/presets/legacy-migration/scripts/scaffold-task-contracts.mjs +4 -0
- package/presets/legacy-migration/templates/execution_strategy.append.md +18 -0
- package/presets/legacy-migration/templates/findings.seed.md +17 -0
- package/presets/legacy-migration/templates/review.seed.md +12 -0
- package/presets/legacy-migration/templates/task_plan.append.md +9 -0
- package/presets/legacy-migration/templates/visual_map.append.md +12 -0
- package/presets/legacy-migration/workbench/dashboard-panels.yaml +2 -0
- package/presets/legacy-migration/workbench/migration-queue.schema.json +23 -0
- package/presets/lesson-sedimentation/preset.yaml +23 -0
- package/presets/lesson-sedimentation/templates/prompt.md +23 -0
- package/presets/module/preset.yaml +25 -0
- package/presets/module/templates/execution_strategy.append.md +8 -0
- package/presets/module/templates/task_plan.append.md +17 -0
- package/presets/standard-task/preset.yaml +31 -0
- package/presets/standard-task/templates/task_plan.append.md +7 -0
- package/references/adversarial-review-standard.md +2 -2
- package/references/agents-md-pattern.md +5 -5
- package/references/delivery-operating-model-standard.md +3 -3
- package/references/docs-directory-standard.md +53 -10
- package/references/external-source-intake-standard.md +75 -0
- package/references/harness-ledger.md +53 -94
- package/references/legacy-12-phase-bootstrap.md +41 -0
- package/references/lessons-governance.md +100 -88
- package/references/module-parallel-standard.md +14 -14
- package/references/planning-loop.md +51 -7
- package/references/project-onboarding-audit.md +10 -0
- package/references/pull-request-standard.md +118 -0
- package/references/repo-governance-standard.md +12 -1
- package/references/review-routing-standard.md +7 -1
- package/references/ssot-governance.md +67 -59
- package/references/taskr-gap-analysis.md +600 -0
- package/references/testing-standard.md +50 -0
- package/references/walkthrough-closeout.md +10 -9
- package/scripts/check-harness.mjs +111 -331
- package/scripts/commands/dashboard-command.mjs +67 -0
- package/scripts/commands/migration-command.mjs +96 -0
- package/scripts/commands/preset-command.mjs +73 -0
- package/scripts/commands/task-command.mjs +327 -0
- package/scripts/harness.mjs +106 -20
- package/scripts/lib/capability-registry.mjs +591 -0
- package/scripts/lib/check-module-parallel.mjs +237 -0
- package/scripts/lib/check-profiles.mjs +418 -0
- package/scripts/lib/check-task-contracts.mjs +47 -0
- package/scripts/lib/core-shared.mjs +196 -0
- package/scripts/lib/dashboard-data.mjs +412 -0
- package/scripts/lib/dashboard-workbench.mjs +257 -0
- package/scripts/lib/dashboard-writer.mjs +107 -4
- package/scripts/lib/git-status-summary.mjs +46 -0
- package/scripts/lib/governance-index-generator.mjs +174 -0
- package/scripts/lib/governance-sync.mjs +514 -0
- package/scripts/lib/governance-table-boundary.mjs +175 -0
- package/scripts/lib/harness-core.mjs +15 -1318
- package/scripts/lib/lesson-maintenance.mjs +152 -0
- package/scripts/lib/markdown-utils.mjs +158 -0
- package/scripts/lib/migration-planner.mjs +478 -0
- package/scripts/lib/migration-support.mjs +312 -0
- package/scripts/lib/preset-audit-contracts.mjs +37 -0
- package/scripts/lib/preset-engine.mjs +497 -0
- package/scripts/lib/preset-registry.mjs +627 -0
- package/scripts/lib/preset-resource-contracts.mjs +83 -0
- package/scripts/lib/review-confirm-git-gate.mjs +248 -0
- package/scripts/lib/status-dashboard-renderer.mjs +102 -0
- package/scripts/lib/subagent-authorization-audit.mjs +196 -0
- package/scripts/lib/task-completion-consistency.mjs +16 -0
- package/scripts/lib/task-index.mjs +93 -0
- package/scripts/lib/task-lesson-candidates.mjs +242 -0
- package/scripts/lib/task-lesson-sedimentation.mjs +326 -0
- package/scripts/lib/task-lifecycle/review-confirm.mjs +101 -0
- package/scripts/lib/task-lifecycle/review-gates.mjs +70 -0
- package/scripts/lib/task-lifecycle/text-utils.mjs +24 -0
- package/scripts/lib/task-lifecycle.mjs +649 -0
- package/scripts/lib/task-review-model.mjs +469 -0
- package/scripts/lib/task-scanner.mjs +576 -0
- package/scripts/lib/task-tombstone-commands.mjs +140 -0
- package/scripts/postinstall.mjs +14 -0
- package/skills/preset-creator/SKILL.md +179 -0
- package/skills/preset-creator/references/complex-task-skeleton/README.md +31 -0
- package/skills/preset-creator/references/complex-task-skeleton/artifacts/INDEX.md +12 -0
- package/skills/preset-creator/references/complex-task-skeleton/brief.md +32 -0
- package/skills/preset-creator/references/complex-task-skeleton/execution_strategy.md +71 -0
- package/skills/preset-creator/references/complex-task-skeleton/findings.md +24 -0
- package/skills/preset-creator/references/complex-task-skeleton/lesson_candidates.md +70 -0
- package/skills/preset-creator/references/complex-task-skeleton/long-running-task-contract.md +76 -0
- package/skills/preset-creator/references/complex-task-skeleton/progress.md +33 -0
- package/skills/preset-creator/references/complex-task-skeleton/references/INDEX.md +13 -0
- package/skills/preset-creator/references/complex-task-skeleton/review.md +107 -0
- package/skills/preset-creator/references/complex-task-skeleton/task_plan.md +111 -0
- package/{templates/planning/visual_roadmap.md → skills/preset-creator/references/complex-task-skeleton/visual_map.md} +24 -2
- package/skills/preset-creator/references/preset-package-skeleton.md +296 -0
- package/templates/AGENTS.md.template +51 -36
- package/templates/architecture/Architecture-SSoT.md +21 -0
- package/templates/architecture/README.md +49 -0
- package/templates/architecture/critical-flows.md +22 -0
- package/templates/architecture/local-repo-context.md +20 -0
- package/templates/architecture/service-catalog.md +17 -0
- package/templates/architecture/services/service-template.md +31 -0
- package/templates/architecture/system-map.md +22 -0
- package/templates/dashboard/assets/app-src/00-state.js +42 -0
- package/templates/dashboard/assets/app-src/10-router.js +77 -0
- package/templates/dashboard/assets/app-src/20-overview.js +241 -0
- package/templates/dashboard/assets/app-src/30-tasks.js +409 -0
- package/templates/dashboard/assets/app-src/35-task-detail.js +246 -0
- package/templates/dashboard/assets/app-src/40-modules.js +58 -0
- package/templates/dashboard/assets/app-src/45-review.js +347 -0
- package/templates/dashboard/assets/app-src/50-migration.js +183 -0
- package/templates/dashboard/assets/app-src/60-shared.js +61 -0
- package/templates/dashboard/assets/app-src/90-bindings.js +524 -0
- package/templates/dashboard/assets/app.css +3107 -300
- package/templates/dashboard/assets/app.css.manifest.json +9 -0
- package/templates/dashboard/assets/app.js +2068 -306
- package/templates/dashboard/assets/app.manifest.json +12 -0
- package/templates/dashboard/assets/css-src/00-foundation.css +342 -0
- package/templates/dashboard/assets/css-src/10-panels-flow.css +236 -0
- package/templates/dashboard/assets/css-src/20-briefs-controls.css +398 -0
- package/templates/dashboard/assets/css-src/30-task-index.css +739 -0
- package/templates/dashboard/assets/css-src/35-review-workspace.css +507 -0
- package/templates/dashboard/assets/css-src/40-detail-modules-migration.css +427 -0
- package/templates/dashboard/assets/css-src/50-responsive-overrides.css +551 -0
- package/templates/dashboard/assets/i18n.js +531 -44
- package/templates/dashboard/assets/mermaid-renderer.js +58 -8
- package/templates/development/README.md +52 -0
- package/templates/development/codebase-map.md +11 -0
- package/templates/development/cross-repo-debugging.md +18 -0
- package/templates/development/external-context/service-template.md +33 -0
- package/templates/development/external-source-packs/README.md +24 -0
- package/templates/development/external-source-packs/digest-template.md +28 -0
- package/templates/development/local-setup.md +16 -0
- package/templates/development/stubs-and-mocks.md +11 -0
- package/templates/integrations/README.md +40 -0
- package/templates/integrations/api-contract.md +42 -0
- package/templates/integrations/event-contract.md +46 -0
- package/templates/integrations/third-party/vendor-template.md +42 -0
- package/templates/integrations/webhook-contract.md +41 -0
- package/templates/ledger/Harness-Ledger.md +13 -25
- package/templates/lessons/lesson-arch-process-change.md +1 -1
- package/templates/lessons/lesson-new-doc.md +1 -1
- package/templates/lessons/lesson-ref-change.md +1 -1
- package/templates/planning/brief.md +32 -0
- package/templates/planning/execution_strategy.md +31 -0
- package/templates/planning/lesson_candidates.md +70 -0
- package/templates/planning/long-running-task-contract.md +7 -0
- package/templates/planning/module_brief.md +25 -0
- package/templates/planning/module_session_prompt.md +6 -0
- package/templates/planning/optional/artifacts/INDEX.md +3 -3
- package/templates/planning/optional/references/INDEX.md +3 -3
- package/templates/planning/review.md +59 -0
- package/templates/planning/task_plan.md +40 -15
- package/templates/planning/visual_map.md +50 -0
- package/templates/reference/docs-library-standard.md +31 -0
- package/templates/reference/execution-workflow-standard.md +5 -2
- package/templates/reference/external-source-intake-standard.md +82 -0
- package/templates/reference/harness-ledger-standard.md +1 -0
- package/templates/reference/pull-request-standard.md +80 -0
- package/templates/reference/repo-governance-standard.md +8 -5
- package/templates/reference/review-routing-standard.md +6 -0
- package/templates/reference/walkthrough-standard.md +3 -1
- package/templates/verifier/verifier-output.md +1 -1
- package/templates/walkthrough/walkthrough-template.md +2 -2
- package/templates-zh-CN/AGENTS.md.template +73 -70
- package/templates-zh-CN/architecture/Architecture-SSoT.md +21 -0
- package/templates-zh-CN/architecture/README.md +51 -0
- package/templates-zh-CN/architecture/critical-flows.md +24 -0
- package/templates-zh-CN/architecture/local-repo-context.md +20 -0
- package/templates-zh-CN/architecture/service-catalog.md +17 -0
- package/templates-zh-CN/architecture/services/service-template.md +31 -0
- package/templates-zh-CN/architecture/system-map.md +22 -0
- package/templates-zh-CN/development/README.md +54 -0
- package/templates-zh-CN/development/codebase-map.md +11 -0
- package/templates-zh-CN/development/cross-repo-debugging.md +18 -0
- package/templates-zh-CN/development/external-context/service-template.md +33 -0
- package/templates-zh-CN/development/external-source-packs/README.md +24 -0
- package/templates-zh-CN/development/external-source-packs/digest-template.md +28 -0
- package/templates-zh-CN/development/local-setup.md +16 -0
- package/templates-zh-CN/development/stubs-and-mocks.md +11 -0
- package/templates-zh-CN/integrations/README.md +42 -0
- package/templates-zh-CN/integrations/api-contract.md +42 -0
- package/templates-zh-CN/integrations/event-contract.md +46 -0
- package/templates-zh-CN/integrations/third-party/vendor-template.md +42 -0
- package/templates-zh-CN/integrations/webhook-contract.md +41 -0
- package/templates-zh-CN/ledger/Harness-Ledger.md +17 -40
- package/templates-zh-CN/planning/brief.md +32 -0
- package/templates-zh-CN/planning/execution_strategy.md +30 -0
- package/templates-zh-CN/planning/lesson_candidates.md +70 -0
- package/templates-zh-CN/planning/long-running-task-contract.md +1 -1
- package/templates-zh-CN/planning/module_brief.md +25 -0
- package/templates-zh-CN/planning/module_plan.md +2 -2
- package/templates-zh-CN/planning/module_session_prompt.md +4 -3
- package/templates-zh-CN/planning/review.md +59 -1
- package/templates-zh-CN/planning/task_plan.md +37 -11
- package/templates-zh-CN/planning/{visual_roadmap.md → visual_map.md} +21 -2
- package/templates-zh-CN/reference/adversarial-review-standard.md +1 -1
- package/templates-zh-CN/reference/docs-library-standard.md +36 -1
- package/templates-zh-CN/reference/execution-workflow-standard.md +10 -2
- package/templates-zh-CN/reference/external-source-intake-standard.md +82 -0
- package/templates-zh-CN/reference/harness-ledger-standard.md +7 -4
- package/templates-zh-CN/reference/pull-request-standard.md +106 -0
- package/templates-zh-CN/reference/repo-governance-standard.md +4 -1
- package/templates-zh-CN/reference/review-routing-standard.md +8 -1
- package/templates-zh-CN/reference/walkthrough-standard.md +6 -5
- package/templates-zh-CN/walkthrough/Closeout-SSoT.md +2 -2
- package/templates-zh-CN/walkthrough/walkthrough-template.md +2 -2
- package/scripts/smoke-dashboard.mjs +0 -70
- package/scripts/test-harness.mjs +0 -483
- package/templates/ssot/Feature-SSoT.md +0 -43
- package/templates/ssot/Lessons-SSoT.md +0 -44
- package/templates-zh-CN/dashboard/assets/app.css +0 -399
- package/templates-zh-CN/dashboard/assets/app.js +0 -435
- package/templates-zh-CN/dashboard/assets/i18n.js +0 -47
- package/templates-zh-CN/dashboard/assets/markdown-reader.js +0 -116
- package/templates-zh-CN/dashboard/assets/mermaid-renderer.js +0 -59
- package/templates-zh-CN/dashboard/index.html +0 -18
- package/templates-zh-CN/ssot/Feature-SSoT.md +0 -49
- package/templates-zh-CN/ssot/Lessons-SSoT.md +0 -49
package/SKILL.md
CHANGED
|
@@ -5,7 +5,7 @@ description: >
|
|
|
5
5
|
做长程项目开发的团队,在用户的项目上构建一套完整的 harness 工程体系。
|
|
6
6
|
包括:项目诊断、AGENTS.md + CLAUDE.md 入口文件生成、docs/ 目录搭建、Planning Loop、SSoT 治理、
|
|
7
7
|
Delivery Operating Model、Repository Governance、CI/CD、Long-Running Task Protocol、Adversarial Review Report、Review Routing、Worktree 并行开发、
|
|
8
|
-
Regression SSoT 与 Evidence Depth 分级回归、Walkthrough / Closeout SSoT 收口、Cadence Ledger
|
|
8
|
+
Regression SSoT 与 Evidence Depth 分级回归、Walkthrough / Closeout SSoT 收口、Cadence Ledger、任务本地 lesson 候选与 promoted lesson 详情文档、
|
|
9
9
|
Harness Ledger 全局上下文回写总账。
|
|
10
10
|
当用户要求设置 coding agent 的开发流程、建立回归测试体系、设计 AGENTS.md / CLAUDE.md、
|
|
11
11
|
规划长程 agent 任务的执行框架、子代理审查循环、对抗性 review 报告、搭建 harness、或者提到 harness engineering 时,使用此技能。
|
|
@@ -24,6 +24,7 @@ description: >
|
|
|
24
24
|
- **单元测试只是底线,不是保障。** 真正的保障需要多层证据(Evidence Depth)。
|
|
25
25
|
- **先识别交付组织,再设计 harness。** 一人多 agent、多人团队、前后端分仓、program 多仓、敏捷/瀑布,对应的 SSoT 和冲突治理不同。
|
|
26
26
|
- **Repo 护栏是地基。** CI/CD、PR policy、branch protection、required checks、worktree concurrency 必须项目级定制,不能停留在模板。
|
|
27
|
+
- **外部资料先摄取,再投影。** 微服务或多仓项目的外部文档不能直接塞进执行文档;先建 source pack、digest、验证,再投影到 `03/04/06`。
|
|
27
28
|
- **长程任务先设计合同,再开放执行。** 连续跑数小时的前提是 Goal、Scope、Review Loop、Evidence、Stop Condition 都清楚。
|
|
28
29
|
- **审查必须落盘。** 对抗性 review 是独立交付物,不应只留在对话、progress 或 walkthrough 里;reviewer 必须用 Confidence Challenge 反复挑战方案,直到没有 open material finding。
|
|
29
30
|
- **Worker handoff 必须 commit-backed。** 可写 subagent 不是 reviewer;它必须在独立 worktree / branch 内实现、验证并提交,再由 coordinator 集成。
|
|
@@ -41,11 +42,13 @@ coding-agent-harness",不要重新 bootstrap 覆盖整个项目。先执行增
|
|
|
41
42
|
2. 扫描目标项目现有 `AGENTS.md`、`CLAUDE.md`、`docs/` 和 SSoT / Ledger 文件。
|
|
42
43
|
3. 输出 delta plan:哪些 harness 骨架、reference、template、SSoT、Ledger 项缺失或过期。
|
|
43
44
|
4. 只补齐新增标准和缺失结构;不得用模板覆盖已有业务事实、历史 walkthrough、
|
|
44
|
-
task progress、
|
|
45
|
+
task progress、generated ledger、Regression SSoT 或 lesson detail docs。
|
|
45
46
|
5. 对已有文档采用 merge / append / residual-with-reason;只有全新缺失文件才从模板创建。
|
|
46
|
-
6. 如果引入
|
|
47
|
-
7. 收口时写 walkthrough,必须包含 Lessons Reflection
|
|
48
|
-
`
|
|
47
|
+
6. 如果引入 Harness Ledger、lesson detail docs 或新的 reference/template,同步更新入口索引。
|
|
48
|
+
7. 收口时写 walkthrough,必须包含 Lessons Reflection;新任务先写并审查
|
|
49
|
+
`lesson_candidates.md`。如人工标记值得沉淀,默认先用 dry-run 或后续
|
|
50
|
+
lesson sedimentation 任务完成分类、冲突检查和建议 diff;只有人工明确批准后,
|
|
51
|
+
维护命令才写 `docs/01-GOVERNANCE/lessons/` 详情文档;最后在
|
|
49
52
|
`docs/Harness-Ledger.md` 与 `docs/10-WALKTHROUGH/Closeout-SSoT.md` 记录本次 harness update 的 delta 和 Lessons Check。
|
|
50
53
|
|
|
51
54
|
一句话:harness update 是 delta merge,不是重新搭一遍。
|
|
@@ -57,6 +60,12 @@ coding-agent-harness",不要重新 bootstrap 覆盖整个项目。先执行增
|
|
|
57
60
|
`docs-release/guides/agent-installation.md`。如果本 Skill 与该指南出现差异,以
|
|
58
61
|
本 Skill 的执行约束为准,并把差异记录为需要修复的文档漂移。
|
|
59
62
|
|
|
63
|
+
CLI 示例默认使用目标项目可调用的 `harness` 命令。执行前先检查
|
|
64
|
+
`command -v harness`;如果没有,不要静默全局安装,按安装指南询问用户是否
|
|
65
|
+
允许 `npm install -g coding-agent-harness`。未获明确同意时,用
|
|
66
|
+
`npx --yes coding-agent-harness <command>` 执行同一条命令。只有维护本源码
|
|
67
|
+
checkout 时,才把 `harness` 替换为 `node scripts/harness.mjs`。
|
|
68
|
+
|
|
60
69
|
### Agent 安装合同
|
|
61
70
|
|
|
62
71
|
这个 CLI 的主要操作者通常是目标项目里的 agent,而不是最终用户。Agent 不应要求用户
|
|
@@ -80,6 +89,12 @@ coding-agent-harness",不要重新 bootstrap 覆盖整个项目。先执行增
|
|
|
80
89
|
读 `references/project-onboarding-audit.md`,扫描项目技术栈、目录结构、现有文档、
|
|
81
90
|
CI、团队/agent 协作方式和风险面,输出诊断报告。
|
|
82
91
|
|
|
92
|
+
如果发现项目属于微服务、多仓、前后端分仓、平台子系统,或代码中出现外部服务、
|
|
93
|
+
SDK、API gateway、message queue、webhook、contract、schema、mock,必须询问用户是否有
|
|
94
|
+
外部资料。问题至少覆盖:是否有外部团队文档、接口文档、架构图、会议纪要、链接或导出包;
|
|
95
|
+
这些资料能否复制进仓;哪些资料是可信来源。外部资料处理方法见
|
|
96
|
+
`references/external-source-intake-standard.md`。
|
|
97
|
+
|
|
83
98
|
### Phase 2: Decide / 方案决策
|
|
84
99
|
|
|
85
100
|
与用户确认三件事:
|
|
@@ -91,6 +106,8 @@ CI、团队/agent 协作方式和风险面,输出诊断报告。
|
|
|
91
106
|
kanban-continuous。
|
|
92
107
|
3. Capability Packs:core 必装;按需选择 module-parallel、subagent-worker、
|
|
93
108
|
adversarial-review、long-running-task、dashboard、safe-adoption。
|
|
109
|
+
4. External Source Intake:如果外部资料超过 5 份、跨多个主题或会持续增长,
|
|
110
|
+
决定是否创建 `docs/04-DEVELOPMENT/external-source-packs/<source-key>/`。
|
|
94
111
|
|
|
95
112
|
Capability 选择规则必须按表执行,不得凭感觉多装:
|
|
96
113
|
|
|
@@ -124,13 +141,51 @@ Regression surface、Delivery SSoT、Module Registry、review routing 和
|
|
|
124
141
|
worktree/subagent handoff 规则。已有项目事实只能 merge/append/residual,
|
|
125
142
|
不能模板覆盖。
|
|
126
143
|
|
|
144
|
+
如果用户提供了外部资料,Configure 阶段必须按
|
|
145
|
+
`external-source-intake-standard.md` 执行:Inventory、Classify、Sanitize、Digest、
|
|
146
|
+
Project、Verify、Residual。`external-source-packs/` 只保存资料索引、摘要和投影状态;
|
|
147
|
+
稳定事实必须回写到 `03-ARCHITECTURE`、`04-DEVELOPMENT/external-context` 或
|
|
148
|
+
`06-INTEGRATIONS`。
|
|
149
|
+
|
|
150
|
+
### Phase 4b: Task Lifecycle / 任务生命周期
|
|
151
|
+
|
|
152
|
+
初始化或迁移完成后,活跃任务必须通过 CLI 创建和推进,避免 agent 手工复制模板造成漂移:
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
harness new-task <task-id> --title "<title>" --locale zh-CN|en-US /path/to/project
|
|
156
|
+
harness task-start <task-id> --message "<what started>" /path/to/project
|
|
157
|
+
harness task-log <task-id> --message "<what changed>" --evidence "command:TARGET:path:summary" /path/to/project
|
|
158
|
+
harness task-block <task-id> --message "<blocker>" /path/to/project
|
|
159
|
+
harness task-review <task-id> --message "<ready for review>" /path/to/project
|
|
160
|
+
harness review-confirm <task-id> --message "<human confirmation>" /path/to/project
|
|
161
|
+
harness task-complete <task-id> --message "<closeout>" /path/to/project
|
|
162
|
+
harness lesson-promote <task-id> <candidate-id> --dry-run /path/to/project
|
|
163
|
+
harness task-list --json /path/to/project
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
- `new-task --budget simple` 创建轻量任务目录:`brief.md`、`task_plan.md`、`visual_map.md`、`progress.md`。
|
|
167
|
+
- `new-task` 默认 `standard`,创建完整任务目录,包括 `brief.md`、计划、策略、路线图、进度、发现和审查文件。
|
|
168
|
+
- `new-task --budget complex` 在完整任务文件之外创建 optional references/artifacts 索引。
|
|
169
|
+
- 已存在任务不会被覆盖;旧项目迁移时先 `task-list --json`,再决定复用旧任务还是开新任务。
|
|
170
|
+
- 状态推进只写 `progress.md`,不得重写历史 `task_plan.md`。
|
|
171
|
+
- `simple` 任务可以直接 `in_progress -> done`;`standard` / `complex` 必须 `in_progress -> review -> done`,不能跳过 `task-review`。
|
|
172
|
+
- `task-review` 只表示 Agent Review Submission:agent/coordinator 认为材料包已准备好并提交待审。它不是人工确认。
|
|
173
|
+
- `review-confirm` 是唯一的 Human Review Confirmation 门禁。它只确认人工 review evidence / findings,不代表 closeout;closeout 仍走 walkthrough / Closeout SSoT。
|
|
174
|
+
- Review queue 只收录已提交 review packet、材料齐全、无 blocker、等待人工确认的任务。
|
|
175
|
+
- 缺文件、缺章节、缺证据、缺 lesson decision 或未执行 `task-review` 的任务进入 Missing Materials 队列,不进入 Review queue。
|
|
176
|
+
- open blocking finding、状态矛盾、审计失败或需要 human waiver 的任务进入 Blocked 队列,不进入 Review queue。
|
|
177
|
+
- 已 Human Review Confirmation 但 closeout / ledger / lesson routing 未完成的任务属于 Confirmed / Finalized 队列,不应显示成“仍在审查”。
|
|
178
|
+
- lesson candidate 进入 Lessons 队列后,默认先 dry-run 或创建后续沉淀任务;不要在 Dashboard 或普通 closeout 中直接写共享 Lessons 表。
|
|
179
|
+
- soft delete / supersede / archive 是只读可追溯生命周期,默认不 hard delete 任务目录;保留 tombstone、替代任务、原因和审计记录。
|
|
180
|
+
- 证据必须进入 `task-log` 或 `progress.md`,并继续遵守 `type:PATH:summary` 格式。
|
|
181
|
+
|
|
127
182
|
### Phase 5: Verify / 验证
|
|
128
183
|
|
|
129
184
|
运行当前 repo 支持的检查命令,例如:
|
|
130
185
|
|
|
131
186
|
```bash
|
|
132
|
-
|
|
133
|
-
|
|
187
|
+
harness check --profile target-project /path/to/project
|
|
188
|
+
harness status --json /path/to/project
|
|
134
189
|
```
|
|
135
190
|
|
|
136
191
|
如果是在开发或修改本 harness 自身,Phase 5 必须覆盖两条回归路径:
|
|
@@ -143,6 +198,15 @@ node scripts/harness.mjs status --json /path/to/project
|
|
|
143
198
|
检查失败时不能声称 harness complete;必须修复或记录 owner/action/status 明确的
|
|
144
199
|
residual。
|
|
145
200
|
|
|
201
|
+
旧项目迁移时必须先运行:
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
harness migrate-plan --json /path/to/project
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
然后按 `docs-release/guides/migration-playbook.md` 分阶段处理。不要机械迁移所有历史
|
|
208
|
+
task;先迁移活跃或重新打开的任务,再升级当前门禁相关 review 和 capability。
|
|
209
|
+
|
|
146
210
|
### Phase 6: Deliver / 交付
|
|
147
211
|
|
|
148
212
|
输出 bootstrap summary,说明创建/定制了哪些文件、启用了哪些 capability、当前
|
|
@@ -158,144 +222,11 @@ Summary 至少包含:
|
|
|
158
222
|
- residual owner / action / status
|
|
159
223
|
- 是否提交;若只是 dogfood 测试,必须清理测试产物
|
|
160
224
|
|
|
161
|
-
###
|
|
162
|
-
|
|
163
|
-
以下 12-phase 流程是历史参考,用于理解旧版 harness 的组成,不再作为 v1.0
|
|
164
|
-
`init` 的默认执行协议。
|
|
165
|
-
|
|
166
|
-
### Phase 1: 项目诊断
|
|
167
|
-
|
|
168
|
-
读 `references/project-onboarding-audit.md`,按其中的扫描清单分析用户项目现状,输出诊断报告。
|
|
169
|
-
|
|
170
|
-
### Phase 2: 确认方案
|
|
171
|
-
|
|
172
|
-
根据诊断结果,确定 harness 规模(参考 `references/project-onboarding-audit.md` 中的项目类型分支),与用户确认落地方案。
|
|
173
|
-
|
|
174
|
-
### Phase 2b: 选择 Delivery Operating Model
|
|
175
|
-
|
|
176
|
-
读 `references/delivery-operating-model-standard.md`。先判定项目的工程组织形态:
|
|
177
|
-
|
|
178
|
-
- `solo-orchestrator`:一人主控,多 agent / worktree 并行
|
|
179
|
-
- `team-feature-lead`:leader 拆 feature block,多人各带 agent 开发
|
|
180
|
-
- `split-repo-contract`:前后端或 app/service 分仓,通过接口合同协作
|
|
181
|
-
- `program-multi-repo`:主项目协调多个子仓库
|
|
182
|
-
- `waterfall-stage-gate`:需求、设计、实现、验证、发布分阶段推进
|
|
183
|
-
- `kanban-continuous`:连续流动式开发,用 WIP 和集成队列控节奏
|
|
184
|
-
|
|
185
|
-
如果是多人、多仓或传统工程流程,必须创建或更新 `docs/09-PLANNING/Delivery-SSoT.md`。
|
|
186
|
-
|
|
187
|
-
### Phase 2c: 模块识别与注册(可选)
|
|
188
|
-
|
|
189
|
-
当项目满足以下条件时启用:
|
|
190
|
-
|
|
191
|
-
- Operating Model 为 `solo-orchestrator` 或 `team-feature-lead`
|
|
192
|
-
- 存在 2+ 个可独立演进的功能域
|
|
193
|
-
- 开发者计划多会话 / 多 worktree 并行
|
|
194
|
-
|
|
195
|
-
读 `references/module-parallel-standard.md`,执行:
|
|
196
|
-
|
|
197
|
-
1. 识别项目中的独立模块(按功能域划分,不按技术层划分)
|
|
198
|
-
2. 为每个模块声明 write scope,确认无交集
|
|
199
|
-
3. 创建 `docs/09-PLANNING/Module-Registry.md`(使用 `templates/ssot/Module-Registry.md`)
|
|
200
|
-
4. 为每个活跃模块创建 `docs/09-PLANNING/MODULES/<key>/module_plan.md`(使用 `templates/planning/module_plan.md`)
|
|
201
|
-
5. 在 AGENTS.md 中添加模块冷启动指引段落
|
|
202
|
-
6. 启用检查器的模块任务反向索引规则:模块 worker 必须把活跃任务写入 `module_plan.md`,并用 Coordinator Handoff 标记总表同步需求;只有 coordinator pass 或显式 shared lock owner 写 `Module-Registry.md` / Harness Ledger。
|
|
203
|
-
|
|
204
|
-
如果项目从线性 Phase 模型迁移,还需执行迁移步骤(见 `references/module-parallel-standard.md` 的"从线性 Phase 迁移"段落)。
|
|
205
|
-
|
|
206
|
-
### Phase 3: 搭建目录结构
|
|
207
|
-
|
|
208
|
-
读 `references/docs-directory-standard.md`,在项目中创建 docs/ 目录结构。根据诊断结果裁剪不需要的目录。
|
|
225
|
+
### 旧版 Bootstrap 参考
|
|
209
226
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
同时生成 `CLAUDE.md`:
|
|
215
|
-
- 优先使用 `templates/CLAUDE.md.template`
|
|
216
|
-
- `CLAUDE.md` 只作为 Claude Code 兼容入口,指向 AGENTS.md
|
|
217
|
-
- 不要在 `CLAUDE.md` 中复制完整规范,避免 AGENTS.md 与 CLAUDE.md 漂移
|
|
218
|
-
|
|
219
|
-
### Phase 5: 生成 Reference 标准文件
|
|
220
|
-
|
|
221
|
-
读 `references/docs-directory-standard.md` 中的 reference 文件清单,根据项目需要生成对应的标准文件到 `docs/11-REFERENCE/`。使用 `templates/reference/` 下的模板。
|
|
222
|
-
标准 harness 安装必须包含 `adversarial-review-standard.md` 和
|
|
223
|
-
`review-routing-standard.md`,因为 planned task closeout 默认启用 reviewer routing。
|
|
224
|
-
标准 harness 安装也必须包含 `repo-governance-standard.md` 和 `ci-cd-standard.md`,
|
|
225
|
-
因为 CI/CD、PR policy、branch protection、required checks 和 worktree concurrency 是 base guardrails。
|
|
226
|
-
标准 harness 安装还必须包含 `delivery-operating-model-standard.md`,
|
|
227
|
-
因为 harness 必须先知道自己服务的是哪一种工程组织形态。
|
|
228
|
-
|
|
229
|
-
### Phase 5b: 初始化 Repository Governance / CI-CD
|
|
230
|
-
|
|
231
|
-
读 `references/repo-governance-standard.md` 和 `references/ci-cd-standard.md`。
|
|
232
|
-
根据项目技术栈和远端平台定制:
|
|
233
|
-
|
|
234
|
-
- repo platform profile
|
|
235
|
-
- branch model
|
|
236
|
-
- PR policy
|
|
237
|
-
- required checks
|
|
238
|
-
- branch protection plan
|
|
239
|
-
- CI workflow 或 blocked-with-owner residual
|
|
240
|
-
- worktree concurrency
|
|
241
|
-
|
|
242
|
-
如果是 GitHub 项目,优先生成或更新 `.github/pull_request_template.md` 和
|
|
243
|
-
`.github/workflows/ci.yml`。如果 agent 没有权限设置 branch protection,必须写 manual setup residual,
|
|
244
|
-
不能把 `designed` 冒充成 `verified`。
|
|
245
|
-
|
|
246
|
-
### Phase 6: 初始化 Planning Loop
|
|
247
|
-
|
|
248
|
-
读 `references/planning-loop.md`,在 `docs/09-PLANNING/TASKS/` 下建立任务模板目录。使用 `templates/planning/` 下的任务模板。
|
|
249
|
-
模板目录必须额外包含 `review.md`,用于 reviewer agent / subagent / 自审写入对抗性 review 报告。
|
|
250
|
-
|
|
251
|
-
### Phase 7: 初始化 Long-Running Task Protocol
|
|
252
|
-
|
|
253
|
-
读 `references/long-running-task-standard.md`,在 `docs/11-REFERENCE/` 中生成长程任务标准。使用 `templates/reference/long-running-task-standard.md`,并把 `templates/planning/long-running-task-contract.md` 放入任务模板目录。
|
|
254
|
-
|
|
255
|
-
### Phase 8: 初始化 SSoT
|
|
256
|
-
|
|
257
|
-
读 `references/ssot-governance.md`,创建 Feature SSoT 和 Regression SSoT。使用 `templates/ssot/` 下的模板。
|
|
258
|
-
|
|
259
|
-
### Phase 8b: 初始化经验沉淀体系
|
|
260
|
-
|
|
261
|
-
读 `references/lessons-governance.md`,创建 Lessons SSoT。使用 `templates/ssot/Lessons-SSoT.md` 作为模板。同时在 `docs/01-GOVERNANCE/` 下创建 `lessons/` 和 `_archive/` 目录(含 `.gitkeep`)。
|
|
262
|
-
|
|
263
|
-
### Phase 8c: 初始化 Harness Ledger
|
|
264
|
-
|
|
265
|
-
读 `references/harness-ledger.md`,在 `docs/` 根目录创建 `Harness-Ledger.md`。使用 `templates/ledger/Harness-Ledger.md` 作为模板。
|
|
266
|
-
|
|
267
|
-
### Phase 9: 初始化 Regression 体系
|
|
268
|
-
|
|
269
|
-
读 `references/regression-system.md` 和 `references/cadence-ledger.md`,根据项目的关键 surface 建立回归 gate 和 cadence 规则。使用 `templates/regression/` 下的模板。
|
|
270
|
-
|
|
271
|
-
### Phase 10: 初始化 Walkthrough 流程
|
|
272
|
-
|
|
273
|
-
读 `references/walkthrough-closeout.md`,建立 walkthrough 模板和 Closeout SSoT。
|
|
274
|
-
使用 `templates/walkthrough/` 下的模板。
|
|
275
|
-
|
|
276
|
-
### Phase 11: 初始化 Worktree 规范
|
|
277
|
-
|
|
278
|
-
读 `references/worktree-parallel.md`,确认 worktree 命名、分支规范、subagent worker
|
|
279
|
-
handoff 和 coordinator integration 规则,写入 AGENTS.md 或对应 reference 文件。
|
|
280
|
-
|
|
281
|
-
### Phase 11b: 初始化模块并行启动 Prompt(如启用)
|
|
282
|
-
|
|
283
|
-
如果项目启用模块并行开发,读 `references/module-parallel-standard.md`,并为每个 active module 创建:
|
|
284
|
-
|
|
285
|
-
- `docs/09-PLANNING/Module-Registry.md`
|
|
286
|
-
- `docs/09-PLANNING/MODULES/<key>/module_plan.md`
|
|
287
|
-
- `docs/09-PLANNING/MODULES/Session-Prompt-Pack.md` 或 `docs/09-PLANNING/MODULES/<key>/session_prompt.md`
|
|
288
|
-
|
|
289
|
-
使用 `templates/planning/module_session_prompt.md` 填充每个模块的启动 prompt。Prompt 必须包含 start gate、worktree/branch preflight、Subagent Worker Invariant、write scope、shared coordination、verification、review/Lessons/Closeout 收口。
|
|
290
|
-
|
|
291
|
-
### Phase 12: 输出 Bootstrap Summary
|
|
292
|
-
|
|
293
|
-
输出一份 harness bootstrap 总结,包括:
|
|
294
|
-
- 创建了哪些文件
|
|
295
|
-
- 每个文件的用途
|
|
296
|
-
- 建议的首批任务
|
|
297
|
-
- 下一步行动
|
|
298
|
-
- `node scripts/check-harness.mjs <project-root>` 的结果;未通过不得声称 bootstrap complete
|
|
227
|
+
旧 12 阶段 bootstrap 只作为兼容迁移参考,不再放在 Skill 主执行协议里。
|
|
228
|
+
需要理解旧项目结构或把旧任务迁移到 v1.0 时,读取
|
|
229
|
+
`references/legacy-12-phase-bootstrap.md`。
|
|
299
230
|
|
|
300
231
|
---
|
|
301
232
|
|
|
@@ -303,7 +234,7 @@ handoff 和 coordinator integration 规则,写入 AGENTS.md 或对应 referenc
|
|
|
303
234
|
|
|
304
235
|
harness bootstrap 完成后,项目中至少应存在以下文件:
|
|
305
236
|
|
|
306
|
-
- [ ] `AGENTS.md
|
|
237
|
+
- [ ] `AGENTS.md`,默认 80-160 行,宪章 + 阅读矩阵,不承载安装教程
|
|
307
238
|
- [ ] `CLAUDE.md`,Claude Code 兼容 shim,指向 `AGENTS.md`(不复制完整规范)
|
|
308
239
|
- [ ] `docs/11-REFERENCE/` 下至少 3 个标准文件
|
|
309
240
|
- [ ] `docs/09-PLANNING/TASKS/_task-template/` 包含 task plan / findings / progress / review 模板
|
|
@@ -319,10 +250,10 @@ harness bootstrap 完成后,项目中至少应存在以下文件:
|
|
|
319
250
|
- [ ] `docs/05-TEST-QA/Cadence-Ledger.md`
|
|
320
251
|
- [ ] `docs/10-WALKTHROUGH/_walkthrough-template.md`
|
|
321
252
|
- [ ] `docs/10-WALKTHROUGH/Closeout-SSoT.md`
|
|
322
|
-
- [ ] `docs/01-GOVERNANCE/Lessons-SSoT.md`
|
|
323
253
|
- [ ] `docs/01-GOVERNANCE/lessons/`(空目录 + .gitkeep)
|
|
324
254
|
- [ ] `docs/01-GOVERNANCE/_archive/`(空目录 + .gitkeep)
|
|
325
255
|
- [ ] `docs/Harness-Ledger.md`
|
|
256
|
+
- [ ] `docs/11-REFERENCE/external-source-intake-standard.md`
|
|
326
257
|
- [ ] `docs/11-REFERENCE/harness-ledger-standard.md`
|
|
327
258
|
- [ ] `.github/pull_request_template.md` 或 platform-specific PR template / residual
|
|
328
259
|
- [ ] CI workflow 或 `ci-cd-standard.md` 中的 blocked-with-owner residual
|
|
@@ -334,7 +265,6 @@ harness bootstrap 完成后,项目中至少应存在以下文件:
|
|
|
334
265
|
- [ ] 如启用模块并行:每个 active module 有 `docs/09-PLANNING/MODULES/<key>/module_plan.md`
|
|
335
266
|
- [ ] 如启用模块并行:模块 task template / shared lock / dependency readiness 规则已落地
|
|
336
267
|
- [ ] Harness checker 已通过,或 residual 写明 owner/action/status
|
|
337
|
-
- [ ] Feature SSoT 文件(位置由项目决定)
|
|
338
268
|
- [ ] Bootstrap Summary 已输出给用户
|
|
339
269
|
|
|
340
270
|
---
|
|
@@ -347,77 +277,81 @@ harness 搭建完成后,每个 feature 从想法到代码的标准流程:
|
|
|
347
277
|
2. **Planning with Files** — 建任务目录,task plan / findings / progress / review 文件
|
|
348
278
|
3. **Long-Running Contract(如适用)** — 明确连续执行权限、review loop、evidence、stop condition
|
|
349
279
|
4. **Delivery Operating Model** — 确认本轮属于 solo / team / split-repo / program / stage-gate / kanban 哪种交付形态
|
|
350
|
-
5.
|
|
280
|
+
5. **任务生命周期事实** — 更新任务本地事实文件;任务生命周期总表由 CLI 生成。模块并行时 worker 回写 module_plan + Coordinator Handoff,coordinator pass 回写 Module Registry;多人/多仓时维护 Delivery SSoT
|
|
351
281
|
6. **Repo Governance / CI-CD** — 确认 PR policy、required checks、branch protection、worktree concurrency
|
|
352
282
|
7. **Worktree / Branch 并行开发** — 按 operating model 决定 worktree、feature branch、contract branch 或 release branch
|
|
353
283
|
8. **Subagent Worker Handoff(如适用)** — coordinator 分配独立 worktree / branch / write scope;worker 提交自己的 commit 并 handoff commit SHA / checks / residuals
|
|
354
|
-
9. **Adversarial Review Report(如适用)** — 在任务目录写 `review.md`,记录 material findings / no-finding / residual risk
|
|
355
|
-
10. **Review Routing** — planned task 收口前自动触发 subagent / reviewer 审查,或记录 skip reason
|
|
284
|
+
9. **Adversarial Review Report(如适用)** — 在任务目录写 `review.md`,记录 Agent Review Submission、material findings / no-finding / residual risk;这一步只表示提交待审,不等于人工批准
|
|
285
|
+
10. **Review Routing** — planned task 收口前自动触发 subagent / reviewer 审查,或记录 skip reason;Review queue 只等待 Human Review Confirmation,缺材料和 blocker 分别进入 Missing Materials / Blocked 队列
|
|
356
286
|
11. **Merge + 自动回归** — Cadence Ledger 触发对应回归面;coordinator 只集成 worker commit,不混合多个 worker 的未提交改动
|
|
357
287
|
12. **Walkthrough 收口** — 写收口记录并引用 review report
|
|
358
288
|
13. **Closeout SSoT 回写** — 每个 closed 任务必须记录 walkthrough 路径或受控 skip reason
|
|
359
|
-
14. **Lessons Reflection** — 写 walkthrough
|
|
360
|
-
15. **
|
|
289
|
+
14. **Lessons Reflection** — 写 walkthrough 时主动反思共性/反复问题;新任务用 `lesson_candidates.md` 承载人工判定,`queued-promotion` 进入 Lessons 队列;默认先 dry-run 或创建沉淀任务,不直接写共享 Lessons 表;`checked-created` 必须有 promoted lesson 详情文档,旧任务兼容的 `checked-none` 必须写明原因
|
|
290
|
+
15. **Generated Ledger 刷新** — 由 lifecycle CLI 或 `harness governance rebuild` 生成任务生命周期总索引
|
|
361
291
|
16. **Worktree 清理** — 删除已 merge 的 worktree
|
|
362
292
|
|
|
363
293
|
---
|
|
364
294
|
|
|
365
295
|
## Reference 索引
|
|
366
296
|
|
|
297
|
+
旧 12 阶段编号只保留在 `references/legacy-12-phase-bootstrap.md`。下面按 v1.0
|
|
298
|
+
能力和任务场景路由,不再使用旧 Phase 编号。
|
|
299
|
+
|
|
367
300
|
| 模块 | Reference | 何时读取 |
|
|
368
301
|
|------|-----------|---------|
|
|
369
|
-
| 项目诊断 | `references/project-onboarding-audit.md` |
|
|
370
|
-
| AGENTS.md + CLAUDE.md | `references/agents-md-pattern.md` |
|
|
371
|
-
| 目录结构 | `references/docs-directory-standard.md` |
|
|
372
|
-
|
|
|
373
|
-
|
|
|
374
|
-
|
|
|
375
|
-
|
|
|
376
|
-
|
|
|
377
|
-
|
|
|
378
|
-
| Review
|
|
379
|
-
|
|
|
380
|
-
|
|
|
381
|
-
|
|
|
382
|
-
|
|
|
383
|
-
|
|
|
384
|
-
|
|
|
385
|
-
|
|
|
302
|
+
| 项目诊断 | `references/project-onboarding-audit.md` | Diagnose 阶段判断项目形态、风险和 harness 深度 |
|
|
303
|
+
| AGENTS.md + CLAUDE.md | `references/agents-md-pattern.md` | Scaffold / Configure 入口路由文件时 |
|
|
304
|
+
| 目录结构 | `references/docs-directory-standard.md` | Scaffold docs 结构或检查目录边界时 |
|
|
305
|
+
| 外部资料摄取 | `references/external-source-intake-standard.md` | 项目依赖微服务、多仓、外部团队资料或用户提供资料包时 |
|
|
306
|
+
| Delivery Operating Model | `references/delivery-operating-model-standard.md` | Decide 阶段选择 solo / team / split-repo / program / stage-gate / kanban |
|
|
307
|
+
| Repository Governance | `references/repo-governance-standard.md` | 配置 PR、分支、worktree、提交和发布边界时 |
|
|
308
|
+
| CI/CD | `references/ci-cd-standard.md` | 配置或验证 required checks、release gate、CI residual 时 |
|
|
309
|
+
| Planning Loop | `references/planning-loop.md` | 创建、推进或迁移任务计划时 |
|
|
310
|
+
| Long-Running Task | `references/long-running-task-standard.md` | 任务需要连续执行、长上下文或 stop condition 时 |
|
|
311
|
+
| Adversarial Review | `references/adversarial-review-standard.md` | 需要独立审查报告、信心挑战或 material finding 分级时 |
|
|
312
|
+
| Review Routing | `references/review-routing-standard.md` | 决定 self-review、subagent、外部 reviewer 或人工审查时 |
|
|
313
|
+
| SSoT 治理 | `references/ssot-governance.md` | 维护 Delivery / Regression 等非任务生命周期事实时 |
|
|
314
|
+
| 经验沉淀 | `references/lessons-governance.md` | walkthrough 收口后判断是否沉淀 lesson 时 |
|
|
315
|
+
| Harness Ledger | `references/harness-ledger.md` | 理解 generated task lifecycle ledger 与非任务治理表边界时 |
|
|
316
|
+
| Regression | `references/regression-system.md` | 设计或更新回归面、evidence depth 和 gate 时 |
|
|
317
|
+
| Cadence Ledger | `references/cadence-ledger.md` | 根据改动类型触发回归批次时 |
|
|
318
|
+
| Walkthrough | `references/walkthrough-closeout.md` | 收口、Closeout SSoT 和交付说明时 |
|
|
319
|
+
| Worktree | `references/worktree-parallel.md` | 并行开发、worker handoff 或隔离分支时 |
|
|
386
320
|
|
|
387
321
|
## Template 索引
|
|
388
322
|
|
|
389
323
|
| 模板 | 路径 | 用途 |
|
|
390
324
|
|------|------|------|
|
|
391
|
-
| AGENTS.md | `templates/AGENTS.md.template` |
|
|
392
|
-
| CLAUDE.md | `templates/CLAUDE.md.template` |
|
|
393
|
-
|
|
|
394
|
-
|
|
|
395
|
-
|
|
|
396
|
-
| Delivery SSoT | `templates/ssot/Delivery-SSoT.md` | Phase 2b |
|
|
397
|
-
| Harness Ledger | `templates/ledger/Harness-Ledger.md` | Phase 8c |
|
|
325
|
+
| AGENTS.md | `templates/AGENTS.md.template` | 目标项目 agent 入口:宪章 + 阅读矩阵 |
|
|
326
|
+
| CLAUDE.md | `templates/CLAUDE.md.template` | Claude Code 兼容 shim,指向 AGENTS.md |
|
|
327
|
+
| Regression SSoT | `templates/ssot/Regression-SSoT.md` | 回归面、证据深度、gate 状态 |
|
|
328
|
+
| Delivery SSoT | `templates/ssot/Delivery-SSoT.md` | 多人、多仓、阶段性交付计划 |
|
|
329
|
+
| Harness Ledger | `templates/ledger/Harness-Ledger.md` | CLI 生成的任务生命周期总索引 |
|
|
398
330
|
| Lesson (ref-change) | `templates/lessons/lesson-ref-change.md` | Walkthrough 收口后 |
|
|
399
331
|
| Lesson (new-doc) | `templates/lessons/lesson-new-doc.md` | Walkthrough 收口后 |
|
|
400
332
|
| Lesson (arch/process) | `templates/lessons/lesson-arch-process-change.md` | Walkthrough 收口后 |
|
|
401
|
-
| Cadence Ledger | `templates/regression/Cadence-Ledger.md` |
|
|
402
|
-
| Task Plan | `templates/planning/task_plan.md` |
|
|
403
|
-
| Findings | `templates/planning/findings.md` |
|
|
404
|
-
| Progress | `templates/planning/progress.md` |
|
|
405
|
-
| Review Report | `templates/planning/review.md` |
|
|
406
|
-
| Long-Running Task Contract | `templates/planning/long-running-task-contract.md` |
|
|
333
|
+
| Cadence Ledger | `templates/regression/Cadence-Ledger.md` | 回归触发节奏和批次记录 |
|
|
334
|
+
| Task Plan | `templates/planning/task_plan.md` | 当前任务计划 |
|
|
335
|
+
| Findings | `templates/planning/findings.md` | 发现、风险和 residual |
|
|
336
|
+
| Progress | `templates/planning/progress.md` | 生命周期状态和执行日志 |
|
|
337
|
+
| Review Report | `templates/planning/review.md` | 审查发现、确认和残余风险 |
|
|
338
|
+
| Long-Running Task Contract | `templates/planning/long-running-task-contract.md` | 长程任务授权、review loop 和停止条件 |
|
|
407
339
|
| Module Session Prompt | `templates/planning/module_session_prompt.md` | 模块并行开发会话冷启动 |
|
|
408
|
-
| Walkthrough | `templates/walkthrough/walkthrough-template.md` |
|
|
409
|
-
| Closeout SSoT | `templates/walkthrough/Closeout-SSoT.md` |
|
|
410
|
-
| Testing Standard | `templates/reference/testing-standard.md` |
|
|
411
|
-
| Execution Workflow | `templates/reference/execution-workflow-standard.md` |
|
|
412
|
-
| Delivery Operating Model Standard | `templates/reference/delivery-operating-model-standard.md` |
|
|
413
|
-
| Repository Governance Standard | `templates/reference/repo-governance-standard.md` |
|
|
414
|
-
|
|
|
415
|
-
|
|
|
416
|
-
|
|
|
417
|
-
| Review
|
|
418
|
-
|
|
|
419
|
-
|
|
|
420
|
-
|
|
|
421
|
-
|
|
|
422
|
-
|
|
|
423
|
-
|
|
|
340
|
+
| Walkthrough | `templates/walkthrough/walkthrough-template.md` | 任务收口记录 |
|
|
341
|
+
| Closeout SSoT | `templates/walkthrough/Closeout-SSoT.md` | closed task 索引和收口证据 |
|
|
342
|
+
| Testing Standard | `templates/reference/testing-standard.md` | 测试、冒烟和回归规范 |
|
|
343
|
+
| Execution Workflow | `templates/reference/execution-workflow-standard.md` | 执行、提交、PR 和证据记录 |
|
|
344
|
+
| Delivery Operating Model Standard | `templates/reference/delivery-operating-model-standard.md` | 交付组织模型选择 |
|
|
345
|
+
| Repository Governance Standard | `templates/reference/repo-governance-standard.md` | repo、分支、PR、worktree 规则 |
|
|
346
|
+
| Pull Request Standard | `templates/reference/pull-request-standard.md` | PR 描述、中英双语、版本影响、验证和引用 |
|
|
347
|
+
| CI/CD Standard | `templates/reference/ci-cd-standard.md` | CI/CD、required checks、release residual |
|
|
348
|
+
| Long-Running Task Standard | `templates/reference/long-running-task-standard.md` | 长程任务协议 |
|
|
349
|
+
| Adversarial Review Standard | `templates/reference/adversarial-review-standard.md` | 对抗性审查协议 |
|
|
350
|
+
| Review Routing Standard | `templates/reference/review-routing-standard.md` | reviewer / subagent / human review 路由 |
|
|
351
|
+
| Docs Library | `templates/reference/docs-library-standard.md` | 文档结构、命名和归档 |
|
|
352
|
+
| External Source Intake Standard | `templates/reference/external-source-intake-standard.md` | 外部资料摄取、摘要和投影 |
|
|
353
|
+
| Harness Ledger Standard | `templates/reference/harness-ledger-standard.md` | Harness Ledger 写入规范 |
|
|
354
|
+
| Regression Governance | `templates/reference/regression-ssot-governance.md` | Regression SSoT 治理 |
|
|
355
|
+
| Walkthrough Standard | `templates/reference/walkthrough-standard.md` | walkthrough / closeout / lessons 收口规范 |
|
|
356
|
+
| Worktree Standard | `templates/reference/worktree-standard.md` | worktree、分支和 worker handoff |
|
|
357
|
+
| Engineering Standard | `templates/reference/engineering-standard.md` | 工程和架构约束 |
|
package/docs-release/README.md
CHANGED
|
@@ -1,7 +1,25 @@
|
|
|
1
1
|
# Coding Agent Harness Docs Release
|
|
2
2
|
|
|
3
3
|
This directory is the public-facing documentation library for Coding Agent Harness.
|
|
4
|
-
It is separate from
|
|
4
|
+
It is separate from maintainer-only operating records for this source repository.
|
|
5
|
+
|
|
6
|
+
简体中文说明:这个目录只放可公开发布的方法论、架构和使用指南。它不记录本仓库自己的私有任务计划、审查草稿、ledger 或本地运行状态。
|
|
7
|
+
|
|
8
|
+
## Language Entry / 语言入口
|
|
9
|
+
|
|
10
|
+
English is the canonical public language for GitHub and npm discovery. Simplified Chinese is fully supported for README, guides, prompts, and executable templates. Other languages currently provide short introductions and route users to the English docs.
|
|
11
|
+
|
|
12
|
+
英文是 GitHub 和 npm 公开传播的主语言。简体中文保留完整支持,包括 README、指南、prompt 和可执行模板。其他语言目前提供简介入口,并引导用户阅读英文文档。
|
|
13
|
+
|
|
14
|
+
| Language | Entry | Support |
|
|
15
|
+
| --- | --- | --- |
|
|
16
|
+
| English | [`../README.md`](../README.md), [`intl/en-US.md`](intl/en-US.md) | Full docs and templates |
|
|
17
|
+
| 简体中文 | [`../README.zh-CN.md`](../README.zh-CN.md), [`intl/zh-CN.md`](intl/zh-CN.md) | Full docs and templates |
|
|
18
|
+
| 日本語 | [`intl/ja-JP.md`](intl/ja-JP.md) | Intro only |
|
|
19
|
+
| 한국어 | [`intl/ko-KR.md`](intl/ko-KR.md) | Intro only |
|
|
20
|
+
| Français | [`intl/fr-FR.md`](intl/fr-FR.md) | Intro only |
|
|
21
|
+
| Español | [`intl/es-ES.md`](intl/es-ES.md) | Intro only |
|
|
22
|
+
| Deutsch | [`intl/de-DE.md`](intl/de-DE.md) | Intro only |
|
|
5
23
|
|
|
6
24
|
## Boundary
|
|
7
25
|
|
|
@@ -9,22 +27,75 @@ Public docs in this directory explain the product architecture, concepts, and re
|
|
|
9
27
|
roadmap. They must not contain private task ledgers, local review drafts, internal
|
|
10
28
|
handoffs, or user/project-specific operating state.
|
|
11
29
|
|
|
12
|
-
|
|
13
|
-
|
|
30
|
+
Maintainer-only operating state for this repository is kept outside the public
|
|
31
|
+
documentation tree and outside the public release package.
|
|
32
|
+
|
|
33
|
+
## How To Read This Library / 如何阅读
|
|
34
|
+
|
|
35
|
+
Not every document is written for the same reader.
|
|
36
|
+
|
|
37
|
+
不是所有文档都给同一种读者看。先判断自己是要理解方法、执行迁移,还是给目标项目里的 Agent 建立合同。
|
|
38
|
+
|
|
39
|
+
| Reader / 读者 | Start here / 从这里开始 | Purpose / 用途 |
|
|
40
|
+
| --- | --- | --- |
|
|
41
|
+
| Product / engineering leaders 产品和工程负责人 | `guides/repository-operating-models.md` / `guides/repository-operating-models.en-US.md` | Choose single-repo, independent multi-repo, or parent-control repository mode. 选择单仓、多仓独立或主控仓库模式。 |
|
|
42
|
+
| Architects / tech leads 架构负责人 | `architecture/overview.md` / `architecture/overview.zh-CN.md` | Understand the product architecture and task lifecycle. 理解产品架构和任务生命周期。 |
|
|
43
|
+
| Review owners / maintainers 审查负责人和维护者 | `guides/task-state-machine.md` / `guides/task-state-machine.en-US.md` | Understand task state, review status, closeout, and review queue semantics. 理解任务状态、审查状态、收口和审查队列语义。 |
|
|
44
|
+
| External contributors 外部贡献者 | `../CONTRIBUTING.md`, `guides/contributing.md` / `guides/contributing.zh-CN.md` | Prepare a focused PR with the right local checks and CI expectations. 按正确的本地检查和 CI 预期提交聚焦 PR。 |
|
|
45
|
+
| Teams adopting Harness 项目接入团队 | `guides/agent-installation.md` / `guides/agent-installation.en-US.md` | Install and operate the agent entrypoint in a target project. 在目标项目中安装和运行 Agent 入口。 |
|
|
46
|
+
| Agents running a migration 执行迁移的 Agent | `guides/legacy-migration-agent-prompt.md` / `guides/legacy-migration-agent-prompt.zh-CN.md` | Follow an executable migration contract. 按可执行迁移合同工作。 |
|
|
47
|
+
| Maintainers deciding what to publish 维护者 | `guides/document-audience-and-surfaces.md` / `guides/document-audience-and-surfaces.en-US.md` | Separate human docs, agent docs, and private operating state. 区分人读文档、Agent 执行文档和私有运行状态。 |
|
|
48
|
+
|
|
49
|
+
## Public Docs / 公开文档
|
|
50
|
+
|
|
51
|
+
### International Intros / 多语言简介
|
|
52
|
+
|
|
53
|
+
- `intl/README.md` — language support matrix and intro page index. 语言支持矩阵和简介页索引。
|
|
54
|
+
- `intl/en-US.md`, `intl/zh-CN.md`, `intl/ja-JP.md`, `intl/ko-KR.md`, `intl/fr-FR.md`, `intl/es-ES.md`, `intl/de-DE.md` — short public introductions for global discovery. 面向国际传播的短简介入口。
|
|
55
|
+
|
|
56
|
+
### Architecture / 架构
|
|
57
|
+
|
|
58
|
+
- `architecture/overview.md` / `architecture/overview.zh-CN.md` — public architecture overview, including the CLI, dashboard, task lifecycle, migration rails, review gate, and release package surface. 公开架构总览,覆盖 CLI、Dashboard、任务生命周期、迁移轨道、审查门禁和发布包表面。
|
|
59
|
+
|
|
60
|
+
### Methodology / 方法论
|
|
61
|
+
|
|
62
|
+
- `guides/contributing.md` / `guides/contributing.zh-CN.md` — public contributor workflow, local checks, PR expectations, and GUI submodule validation. 公开贡献者流程、本地检查、PR 要求和 GUI 子模块验证。
|
|
63
|
+
- `guides/document-audience-and-surfaces.md` / `guides/document-audience-and-surfaces.en-US.md` — explains which docs are for humans, which docs are for agents, and which state must stay out of public release docs. 说明哪些文档给人看,哪些给 Agent 执行,以及哪些状态不能进入公开发布文档。
|
|
64
|
+
- `guides/repository-operating-models.md` / `guides/repository-operating-models.en-US.md` — compares single-repo, independent multi-repo, and parent-control repository operating models. 对比单仓、多仓独立、主控仓库三种运行模式。
|
|
65
|
+
- `guides/parent-control-repository-pattern.md` / `guides/parent-control-repository-pattern.en-US.md` — describes the control-plane pattern for products with many child repositories, services, SDKs, or upstream references. 解释多子仓库、多服务、SDK、上游参考仓库场景下的控制面模式。
|
|
66
|
+
- `guides/task-state-machine.md` / `guides/task-state-machine.en-US.md` — explains task state, derived lifecycle, review status, closeout, review queue buckets, and human confirmation flow. 解释任务状态、派生生命周期、审查状态、收口、审查队列分桶和人工确认流程。
|
|
67
|
+
|
|
68
|
+
### Adoption And Migration / 接入与迁移
|
|
69
|
+
|
|
70
|
+
- `guides/agent-installation.md` / `guides/agent-installation.en-US.md` — operational installation guide for target-project agents. 目标项目 Agent 的安装和运行指南。
|
|
71
|
+
- `guides/migration-playbook.md` / `guides/migration-playbook.en-US.md` — smooth migration guide for existing legacy harness projects. 旧 Harness 项目的平滑迁移指南。
|
|
72
|
+
- `guides/legacy-migration-agent-prompt.md` / `guides/legacy-migration-agent-prompt.zh-CN.md` — prompt contract for agents running baseline or full legacy migration. 给迁移 Agent 使用的执行合同。
|
|
73
|
+
- `guides/full-legacy-migration-subagent-strategy.md` / `guides/full-legacy-migration-subagent-strategy.zh-CN.md` — full readable cutover strategy with subagent roles, adversarial review, and dashboard/CLI proof gates. 完整可读迁移的 subagent 分工、对抗审查和 Dashboard/CLI 证据门禁。
|
|
74
|
+
|
|
75
|
+
## Repository Operating Models / 仓库运行模式
|
|
76
|
+
|
|
77
|
+
Coding Agent Harness supports three common repository shapes:
|
|
78
|
+
|
|
79
|
+
Coding Agent Harness 支持三种常见仓库形态:
|
|
80
|
+
|
|
81
|
+
| Model / 模式 | Summary / 摘要 | Primary doc / 主文档 |
|
|
82
|
+
| --- | --- | --- |
|
|
83
|
+
| Single-repo Harness 单仓模式 | One code repository owns code, plans, regression, and closeout. 一个代码仓库同时承载代码、计划、回归和收口。 | `guides/repository-operating-models.md` |
|
|
84
|
+
| Independent multi-repo Harness 多仓独立模式 | Each code repository owns its own local Harness; cross-repo context must be documented in architecture, development, and integration docs. 每个代码仓库有自己的局部 Harness,跨仓上下文必须写进 architecture、development、integration 文档。 | `guides/repository-operating-models.md` |
|
|
85
|
+
| Parent-control repository Harness 主控仓库模式 | One parent repository owns the Harness control plane; child repositories own implementation facts. 一个父仓库管理 Harness 控制面,子仓库只承载代码执行事实。 | `guides/parent-control-repository-pattern.md` |
|
|
14
86
|
|
|
15
|
-
|
|
87
|
+
The parent-control pattern is the recommended default when one product spans many repositories but still needs one release plan, one task source of truth, and one agent startup point.
|
|
16
88
|
|
|
17
|
-
|
|
18
|
-
- `guides/agent-installation.md` — operational installation guide for target-project agents.
|
|
89
|
+
当一个产品跨多个仓库,但仍然需要一个 release 计划、一个任务事实源和一个 Agent 启动入口时,推荐优先采用主控仓库模式。
|
|
19
90
|
|
|
20
91
|
Release roadmaps, staged plans, task execution strategy, final-check walkthroughs,
|
|
21
92
|
and maintainer publishing notes are project operating state. Keep them in
|
|
22
|
-
|
|
93
|
+
maintainer-only operating records, not in this public documentation tree.
|
|
23
94
|
|
|
24
|
-
## Rule
|
|
95
|
+
## Release Rule
|
|
25
96
|
|
|
26
97
|
If a document tells users how the harness works, it belongs here or under
|
|
27
98
|
`references/`.
|
|
28
99
|
|
|
29
100
|
If a document records how this repository is being operated, reviewed, migrated, or
|
|
30
|
-
closed out, it
|
|
101
|
+
closed out, keep it outside the public documentation tree.
|