coding-agent-harness 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/README.en-US.md +14 -0
- package/README.md +111 -86
- package/README.zh-CN.md +270 -0
- package/SKILL.md +116 -189
- package/docs-release/README.md +72 -5
- package/docs-release/architecture/overview.md +286 -28
- package/docs-release/architecture/overview.zh-CN.md +288 -0
- package/docs-release/assets/dashboard-overview-en.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 +214 -0
- package/docs-release/guides/agent-installation.md +123 -26
- package/docs-release/guides/document-audience-and-surfaces.en-US.md +112 -0
- package/docs-release/guides/document-audience-and-surfaces.md +112 -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 +384 -0
- package/docs-release/guides/legacy-migration-agent-prompt.zh-CN.md +361 -0
- package/docs-release/guides/migration-playbook.en-US.md +325 -0
- package/docs-release/guides/migration-playbook.md +329 -0
- package/docs-release/guides/parent-control-repository-pattern.en-US.md +252 -0
- package/docs-release/guides/parent-control-repository-pattern.md +252 -0
- package/docs-release/guides/repository-operating-models.en-US.md +196 -0
- package/docs-release/guides/repository-operating-models.md +196 -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/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 +3 -1
- package/references/agents-md-pattern.md +3 -3
- package/references/docs-directory-standard.md +47 -3
- package/references/external-source-intake-standard.md +75 -0
- package/references/harness-ledger.md +5 -3
- package/references/legacy-12-phase-bootstrap.md +41 -0
- package/references/lessons-governance.md +23 -6
- package/references/planning-loop.md +41 -3
- package/references/project-onboarding-audit.md +10 -0
- package/references/repo-governance-standard.md +2 -0
- package/references/testing-standard.md +50 -0
- package/references/walkthrough-closeout.md +6 -5
- package/scripts/check-harness.mjs +76 -35
- package/scripts/harness.mjs +303 -12
- package/scripts/lib/capability-registry.mjs +533 -0
- package/scripts/lib/check-profiles.mjs +510 -0
- package/scripts/lib/core-shared.mjs +186 -0
- package/scripts/lib/dashboard-data.mjs +389 -0
- package/scripts/lib/dashboard-workbench.mjs +217 -0
- package/scripts/lib/dashboard-writer.mjs +93 -2
- package/scripts/lib/harness-core.mjs +10 -1318
- package/scripts/lib/lesson-maintenance.mjs +145 -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/task-lifecycle.mjs +755 -0
- package/scripts/lib/task-scanner.mjs +682 -0
- package/scripts/smoke-dashboard.mjs +22 -0
- package/scripts/test-harness.mjs +926 -14
- package/templates/AGENTS.md.template +41 -30
- 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 +41 -0
- package/templates/dashboard/assets/app-src/10-router.js +76 -0
- package/templates/dashboard/assets/app-src/20-overview.js +235 -0
- package/templates/dashboard/assets/app-src/30-tasks.js +563 -0
- package/templates/dashboard/assets/app-src/40-modules.js +58 -0
- package/templates/dashboard/assets/app-src/45-review.js +128 -0
- package/templates/dashboard/assets/app-src/50-migration.js +169 -0
- package/templates/dashboard/assets/app-src/60-shared.js +61 -0
- package/templates/dashboard/assets/app-src/90-bindings.js +382 -0
- package/templates/dashboard/assets/app.css +2575 -310
- package/templates/dashboard/assets/app.js +1498 -307
- package/templates/dashboard/assets/app.manifest.json +11 -0
- package/templates/dashboard/assets/i18n.js +429 -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/planning/brief.md +32 -0
- package/templates/planning/lesson_candidates.md +58 -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/task_plan.md +7 -5
- package/templates/planning/{visual_roadmap.md → visual_map.md} +24 -2
- package/templates/reference/docs-library-standard.md +31 -0
- package/templates/reference/execution-workflow-standard.md +4 -2
- package/templates/reference/external-source-intake-standard.md +82 -0
- package/templates/reference/harness-ledger-standard.md +1 -0
- package/templates/reference/repo-governance-standard.md +6 -4
- package/templates/reference/walkthrough-standard.md +2 -1
- package/templates/walkthrough/walkthrough-template.md +2 -2
- package/templates-zh-CN/AGENTS.md.template +69 -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/planning/brief.md +32 -0
- package/templates-zh-CN/planning/lesson_candidates.md +58 -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/task_plan.md +10 -4
- package/templates-zh-CN/planning/{visual_roadmap.md → visual_map.md} +21 -2
- package/templates-zh-CN/reference/docs-library-standard.md +35 -0
- package/templates-zh-CN/reference/execution-workflow-standard.md +9 -2
- package/templates-zh-CN/reference/external-source-intake-standard.md +82 -0
- package/templates-zh-CN/reference/harness-ledger-standard.md +5 -2
- package/templates-zh-CN/reference/repo-governance-standard.md +2 -0
- package/templates-zh-CN/reference/walkthrough-standard.md +4 -4
- package/templates-zh-CN/walkthrough/Closeout-SSoT.md +2 -2
- package/templates-zh-CN/walkthrough/walkthrough-template.md +2 -2
- 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
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# External Source Intake Standard
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This standard defines how agents receive, filter, organize, and project large external documentation sets from other projects, microservice teams, or platform owners. The goal is executable context, not a document dump.
|
|
6
|
+
|
|
7
|
+
## Core Model
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
external source material -> source pack index -> digest -> 03/04/06 execution projection
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
`03-ARCHITECTURE`, `04-DEVELOPMENT`, and `06-INTEGRATIONS` only hold facts that have been distilled enough to guide work. Raw external files, long documents, screenshots, exported chats, diagrams, and historical packets first go through `docs/04-DEVELOPMENT/external-source-packs/`.
|
|
14
|
+
|
|
15
|
+
## When To Ask The User
|
|
16
|
+
|
|
17
|
+
During Diagnose / Decide, the agent must ask whether external source material exists when any of these signals appear:
|
|
18
|
+
|
|
19
|
+
- The repository is part of a multi-repo, microservice, split frontend/backend, or platform system.
|
|
20
|
+
- The code references external services, SDKs, API gateways, message queues, webhooks, contracts, schemas, or mocks.
|
|
21
|
+
- The user mentions other repositories, upstream/downstream services, interface docs, business knowledge, or system-level design.
|
|
22
|
+
- The agent cannot determine service responsibility, integration contracts, or local debugging behavior from the current repository alone.
|
|
23
|
+
|
|
24
|
+
Recommended questions:
|
|
25
|
+
|
|
26
|
+
1. Does this project depend on external services or other repositories?
|
|
27
|
+
2. Do you have architecture docs, API docs, diagrams, meeting notes, source links, code paths, or exported packets from those teams?
|
|
28
|
+
3. Can those materials be copied into this repository? If not, should the Harness store only local paths or URLs?
|
|
29
|
+
4. Which sources are authoritative, and which are historical references only?
|
|
30
|
+
|
|
31
|
+
## Storage Rules
|
|
32
|
+
|
|
33
|
+
| Case | Storage |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| Only 1-4 stable external documents | No separate source pack is required; link them from `Source Evidence` in the relevant `03/04/06` docs |
|
|
36
|
+
| More than 5 documents, multiple topics, or continuing growth | Create `docs/04-DEVELOPMENT/external-source-packs/<source-key>/` |
|
|
37
|
+
| Material contains secrets, customer data, private links, or cannot be committed | Do not copy raw files; record external location, owner, access condition, and digest only |
|
|
38
|
+
| Material is safe to commit | Raw files may go under `raw/`, but only digested facts may be projected into execution docs |
|
|
39
|
+
|
|
40
|
+
Recommended structure:
|
|
41
|
+
|
|
42
|
+
```text
|
|
43
|
+
docs/04-DEVELOPMENT/external-source-packs/<source-key>/
|
|
44
|
+
├── README.md # source index and projection status
|
|
45
|
+
├── digests/ # digest for each source or source group
|
|
46
|
+
├── raw/ # commit-safe raw material only
|
|
47
|
+
└── raw-index.md # path/URL/owner index when raw material cannot be committed
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Do not replicate a full `03/04/06` tree for every microservice. The source pack is the intake layer. The stable execution entries remain:
|
|
51
|
+
|
|
52
|
+
- `docs/03-ARCHITECTURE/service-catalog.md`
|
|
53
|
+
- `docs/03-ARCHITECTURE/services/<service-key>.md`
|
|
54
|
+
- `docs/04-DEVELOPMENT/external-context/<service-key>.md`
|
|
55
|
+
- `docs/06-INTEGRATIONS/<contract>.md`
|
|
56
|
+
|
|
57
|
+
## Intake Flow
|
|
58
|
+
|
|
59
|
+
1. **Inventory**: list sources, owners, dates, trust level, and commit eligibility.
|
|
60
|
+
2. **Classify**: tag each source as architecture, development, integration, security, operations, product, or unknown.
|
|
61
|
+
3. **Sanitize**: check for secrets, tokens, customer data, personal information, internal accounts, and private links; keep non-committable material as references only.
|
|
62
|
+
4. **Digest**: extract facts, questions, unsafe assumptions, and evidence with the digest template.
|
|
63
|
+
5. **Project**: move stable facts into `03/04/06`, then mark the source as projected in the source pack README.
|
|
64
|
+
6. **Verify**: use code evidence, contract tests, owner confirmation, or runtime checks where feasible; update `Last Verified` and `Confidence`.
|
|
65
|
+
7. **Residual**: keep unverified or conflicting facts in the source pack or in `Do Not Assume`; do not treat them as execution facts.
|
|
66
|
+
|
|
67
|
+
## Projection Rules
|
|
68
|
+
|
|
69
|
+
| Source Content | Projection Target |
|
|
70
|
+
| --- | --- |
|
|
71
|
+
| Service responsibility, upstream/downstream relationship, owner, data ownership, topology | `03-ARCHITECTURE/service-catalog.md` or `services/<service-key>.md` |
|
|
72
|
+
| Local mocks, stubs, startup, debugging, cross-repo development behavior | `04-DEVELOPMENT/external-context/<service-key>.md` |
|
|
73
|
+
| Endpoint, payload, auth, error, event, webhook, SDK, contract test | `06-INTEGRATIONS/<contract>.md` |
|
|
74
|
+
| Unconfirmed, conflicting, stale, or background-only material | Keep in source pack README / digest; do not project into execution docs |
|
|
75
|
+
|
|
76
|
+
## Prohibited
|
|
77
|
+
|
|
78
|
+
- Do not copy large external document sets directly into `03-ARCHITECTURE`, `04-DEVELOPMENT`, or `06-INTEGRATIONS`.
|
|
79
|
+
- Do not treat an external-source digest as verified fact without `Source Evidence`, `Last Verified`, and `Confidence`.
|
|
80
|
+
- Do not keep long raw excerpts, chat logs, or meeting transcripts inside execution docs.
|
|
81
|
+
- Do not commit secrets, production tokens, customer data, personal information, or non-public raw material.
|
|
82
|
+
- Do not create one full directory tree per microservice for completeness; create source packs only for large external source sets.
|
|
@@ -13,6 +13,7 @@ Define when and how the Harness Ledger records durable changes to the agent oper
|
|
|
13
13
|
5. Do not store secrets, personal data, large logs, or raw generated output in the ledger.
|
|
14
14
|
6. If a lesson changes a reference standard, record both the lesson and the reference update.
|
|
15
15
|
7. If no ledger update is needed, closeout should say why.
|
|
16
|
+
8. New task closeout should route lesson review through `lesson_candidates.md`; record `checked-candidate:<LC-ID>`, `queued-promotion:<LC-ID>`, or `checked-created:<L-ID>` as the final lesson outcome.
|
|
16
17
|
|
|
17
18
|
## Required Artifacts
|
|
18
19
|
|
|
@@ -10,9 +10,10 @@ Define repository-level rules for branches, commits, pull requests, ownership, g
|
|
|
10
10
|
2. Use task-scoped branches and worktrees for non-trivial changes, especially when multiple workers are active.
|
|
11
11
|
3. Keep commits focused on the requested scope and avoid mixing unrelated cleanup with feature work.
|
|
12
12
|
4. Generated files, caches, build output, local runtime state, and secrets must be ignored or stored in the approved location.
|
|
13
|
-
5.
|
|
14
|
-
6.
|
|
15
|
-
7.
|
|
13
|
+
5. Commit verified, meaningful slices proactively. Deferred commits require an explicit reason and owner.
|
|
14
|
+
6. Pull requests must describe intent, changed surfaces, checks run, checks not run, review status, and residual risk.
|
|
15
|
+
7. Required checks and material review findings block merge unless an approved exception is recorded.
|
|
16
|
+
8. Merge or release ownership must be explicit when several branches or workers contribute to the same outcome.
|
|
16
17
|
|
|
17
18
|
## Required Checklist
|
|
18
19
|
|
|
@@ -20,10 +21,11 @@ Define repository-level rules for branches, commits, pull requests, ownership, g
|
|
|
20
21
|
- Allowed and forbidden paths are respected.
|
|
21
22
|
- Dirty worktree state was checked before edits.
|
|
22
23
|
- Generated and private files are not accidentally staged.
|
|
24
|
+
- Verified slices have commit SHAs, or deferred commit rationale is recorded.
|
|
23
25
|
- PR summary includes evidence and residuals.
|
|
24
26
|
- Review findings are resolved or explicitly accepted.
|
|
25
27
|
- Merge strategy and rollback or revert path are understood.
|
|
26
28
|
|
|
27
29
|
## Closeout Expectations
|
|
28
30
|
|
|
29
|
-
Repository closeout must list changed paths, confirm scope boundaries were honored, report git status relevant to the task, summarize checks, and identify unrelated dirty files left untouched.
|
|
31
|
+
Repository closeout must list changed paths, confirm scope boundaries were honored, report git status relevant to the task, cite relevant commit SHAs or deferred-commit rationale, summarize checks, and identify unrelated dirty files left untouched.
|
|
@@ -10,7 +10,7 @@ Define the closeout walkthrough that converts implementation work into durable p
|
|
|
10
10
|
2. A walkthrough must explain what changed, why it changed, how it was verified, what review found, and what residual risk remains.
|
|
11
11
|
3. Do not paste large raw logs. Link to evidence files, commands, PRs, screenshots, or CI runs.
|
|
12
12
|
4. Material findings and their resolution must be visible.
|
|
13
|
-
5. Lessons that change future behavior must be routed to the appropriate SSoT, reference standard, or Harness Ledger.
|
|
13
|
+
5. Lessons that change future behavior must first be routed through `lesson_candidates.md`; accepted candidates are then routed to the appropriate SSoT, reference standard, or Harness Ledger.
|
|
14
14
|
6. Walkthroughs must be written from the final integrated state, not from a single worker's partial view.
|
|
15
15
|
7. If work is incomplete, the walkthrough must identify the next safe action and stop reason.
|
|
16
16
|
|
|
@@ -21,6 +21,7 @@ Define the closeout walkthrough that converts implementation work into durable p
|
|
|
21
21
|
- Review summary with material findings and disposition.
|
|
22
22
|
- Residual risk section.
|
|
23
23
|
- Lesson or follow-up section.
|
|
24
|
+
- Lesson candidate decision: `checked-candidate:<LC-ID>`, `queued-promotion:<LC-ID>`, `checked-created:<L-ID>`, or legacy `checked-none:<reason>`.
|
|
24
25
|
- Links to updated SSoT, Regression SSoT, or Harness Ledger entries when applicable.
|
|
25
26
|
|
|
26
27
|
## Closeout Expectations
|
|
@@ -49,8 +49,8 @@ One sentence describing what changed and why it matters.
|
|
|
49
49
|
| --- | --- |
|
|
50
50
|
| Did this reveal a reusable reference, workflow, or checker gap? | yes / no, reason |
|
|
51
51
|
| Could a future agent repeat the same mistake? | yes / no, reason |
|
|
52
|
-
| Was a lesson
|
|
53
|
-
| Lessons detail doc |
|
|
52
|
+
| Was a lesson candidate reviewed? | checked-candidate:LC-... / queued-promotion:LC-... / checked-created:L-YYYY-MM-DD-001 / legacy checked-none: reason |
|
|
53
|
+
| Lessons detail doc | lesson_candidates.md, governance detail doc, or none |
|
|
54
54
|
|
|
55
55
|
## Closeout Links
|
|
56
56
|
|
|
@@ -1,92 +1,91 @@
|
|
|
1
1
|
# [项目名称]
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
这个文件是 Agent 进入本仓库时的工作入口。它只负责说明硬规则和阅读路由;
|
|
4
|
+
详细规范放在 `docs/11-REFERENCE/`,不要把操作手册全部塞进这里。
|
|
4
5
|
|
|
5
6
|
## 项目概况
|
|
6
7
|
|
|
7
8
|
- **项目名**:[项目名称]
|
|
8
9
|
- **技术栈**:[语言 / 框架 / 运行时]
|
|
9
10
|
- **仓库形态**:[单仓 / monorepo / 多仓协作]
|
|
10
|
-
- **主要模块**:[
|
|
11
|
-
- **默认分支**:[
|
|
11
|
+
- **主要模块**:[模块列表]
|
|
12
|
+
- **默认分支**:[main / master / 其他]
|
|
12
13
|
|
|
13
14
|
## 不可违反的规则
|
|
14
15
|
|
|
15
|
-
1.
|
|
16
|
-
2.
|
|
17
|
-
3.
|
|
18
|
-
4.
|
|
16
|
+
1. 遵守 `docs/11-REFERENCE/engineering-standard.md` 中的架构边界。
|
|
17
|
+
2. 不提交密钥、令牌、私有接口、用户隐私数据或生产凭据。
|
|
18
|
+
3. 非平凡任务先在 `docs/09-PLANNING/TASKS/` 下建立任务目录。
|
|
19
|
+
4. 声称完成前必须记录证据。
|
|
20
|
+
5. 保护无关工作区改动,不回滚任务范围外文件。
|
|
21
|
+
6. 已验证的、有意义的工作切片要主动提交,除非用户明确说不要提交。
|
|
19
22
|
|
|
20
23
|
## 任务阅读矩阵
|
|
21
24
|
|
|
22
|
-
|
|
25
|
+
按任务类型读取最少但足够的上下文,不要一次性加载整套文档。
|
|
23
26
|
|
|
24
27
|
| 任务类型 | 先读文件 |
|
|
25
28
|
| --- | --- |
|
|
26
29
|
| 架构、核心模块、跨模块改动 | `docs/11-REFERENCE/engineering-standard.md` |
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
30
|
+
| 系统地图、服务职责、外部系统关系 | `docs/03-ARCHITECTURE/README.md`、`docs/03-ARCHITECTURE/service-catalog.md` |
|
|
31
|
+
| 本地开发、mock、stub、跨仓调试 | `docs/04-DEVELOPMENT/README.md`、`docs/04-DEVELOPMENT/codebase-map.md` |
|
|
32
|
+
| API、event、webhook、SDK、第三方契约 | `docs/06-INTEGRATIONS/README.md` 和相关契约文件 |
|
|
33
|
+
| 测试、冒烟、回归 | `docs/11-REFERENCE/testing-standard.md`、`docs/05-TEST-QA/Regression-SSoT.md` |
|
|
34
|
+
| 开发执行、提交、PR、发布 | `docs/11-REFERENCE/execution-workflow-standard.md`、`docs/11-REFERENCE/repo-governance-standard.md`、`docs/11-REFERENCE/ci-cd-standard.md` |
|
|
35
|
+
| 创建或推进任务 | `docs/09-PLANNING/TASKS/` 下的当前任务目录;如果本项目已配置 Harness CLI,优先用 CLI |
|
|
36
|
+
| Brief、Execution Strategy、Visual Map | 当前任务的 `brief.md`、`execution_strategy.md`、`visual_map.md` |
|
|
37
|
+
| 长程任务 | `docs/11-REFERENCE/long-running-task-standard.md` |
|
|
38
|
+
| reviewer、subagent、对抗性审查 | `docs/11-REFERENCE/review-routing-standard.md`、`docs/11-REFERENCE/adversarial-review-standard.md` |
|
|
39
|
+
| 多人协作、多仓交付、阶段性交付 | `docs/11-REFERENCE/delivery-operating-model-standard.md`、`docs/09-PLANNING/Delivery-SSoT.md` |
|
|
40
|
+
| 模块并行 | `docs/09-PLANNING/Module-Registry.md` 和相关 module plan |
|
|
41
|
+
| 文档治理或 Harness 更新 | `docs/11-REFERENCE/docs-library-standard.md`、`.harness-capabilities.json` |
|
|
42
|
+
| 外部资料摄取 | `docs/11-REFERENCE/external-source-intake-standard.md` |
|
|
37
43
|
| Regression SSoT 维护 | `docs/11-REFERENCE/regression-ssot-governance.md` |
|
|
38
|
-
|
|
|
39
|
-
| Worktree
|
|
40
|
-
| [前端任务] | `docs/11-REFERENCE/frontend-standard.md` |
|
|
41
|
-
| [API 任务] | `docs/11-REFERENCE/api-standard.md` |
|
|
44
|
+
| 收口、walkthrough、Lessons | `docs/11-REFERENCE/walkthrough-standard.md`、`docs/10-WALKTHROUGH/Closeout-SSoT.md`、`docs/01-GOVERNANCE/Lessons-SSoT.md` |
|
|
45
|
+
| Worktree、并行开发隔离 | `docs/11-REFERENCE/worktree-standard.md` |
|
|
42
46
|
|
|
43
47
|
## 标准执行流程
|
|
44
48
|
|
|
45
|
-
1.
|
|
46
|
-
2.
|
|
47
|
-
3.
|
|
48
|
-
4.
|
|
49
|
-
5.
|
|
50
|
-
6.
|
|
51
|
-
7.
|
|
52
|
-
8.
|
|
53
|
-
9.
|
|
54
|
-
10.
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
- `
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
- **CI/CD 标准**:`docs/11-REFERENCE/ci-cd-standard.md`
|
|
89
|
-
|
|
90
|
-
## 协作补充
|
|
91
|
-
|
|
92
|
-
[按项目实际填写:模块 owner、共享文件锁、merge 顺序、发布审批人、环境限制等。]
|
|
49
|
+
1. 先确认请求、范围和受影响文件。
|
|
50
|
+
2. 非平凡任务先创建或更新任务计划,再改代码。
|
|
51
|
+
3. 只读取任务阅读矩阵要求的 reference 文档。
|
|
52
|
+
4. 保留已有项目事实;新增上下文使用 merge / append,不覆盖历史。
|
|
53
|
+
5. 需要隔离或并行时,使用独立 worktree 或分支。
|
|
54
|
+
6. 只在确认范围内实现。
|
|
55
|
+
7. 运行相关检查,并把证据写入任务记录。
|
|
56
|
+
8. 按需触发 review,关闭阻塞发现。
|
|
57
|
+
9. 写入或更新 walkthrough 与 closeout 记录。
|
|
58
|
+
10. 只更新本任务实际触达的 SSoT / ledger。
|
|
59
|
+
|
|
60
|
+
## 协作规则
|
|
61
|
+
|
|
62
|
+
- reviewer 默认只读,除非明确分配写入范围。
|
|
63
|
+
- worker 只能编辑分配给自己的分支、worktree 和文件范围。
|
|
64
|
+
- 共享 ledger、registry 和 SSoT 默认由 coordinator 维护,除非明确登记锁。
|
|
65
|
+
- worker 交接必须包含分支或 worktree、改动文件、检查、证据和残余风险。
|
|
66
|
+
|
|
67
|
+
## 单一事实源
|
|
68
|
+
|
|
69
|
+
- Feature SSoT:`docs/09-PLANNING/Feature-SSoT.md`
|
|
70
|
+
- Delivery SSoT:`docs/09-PLANNING/Delivery-SSoT.md`
|
|
71
|
+
- Module Registry:`docs/09-PLANNING/Module-Registry.md`
|
|
72
|
+
- Regression SSoT:`docs/05-TEST-QA/Regression-SSoT.md`
|
|
73
|
+
- Cadence Ledger:`docs/05-TEST-QA/Cadence-Ledger.md`
|
|
74
|
+
- Lessons SSoT:`docs/01-GOVERNANCE/Lessons-SSoT.md`
|
|
75
|
+
- Closeout SSoT:`docs/10-WALKTHROUGH/Closeout-SSoT.md`
|
|
76
|
+
- Harness Ledger:`docs/Harness-Ledger.md`
|
|
77
|
+
|
|
78
|
+
## 本地命令
|
|
79
|
+
|
|
80
|
+
| 用途 | 命令 |
|
|
81
|
+
| --- | --- |
|
|
82
|
+
| 安装 | `[install command]` |
|
|
83
|
+
| 测试 | `[test command]` |
|
|
84
|
+
| Lint | `[lint command]` |
|
|
85
|
+
| 构建 | `[build command]` |
|
|
86
|
+
| 冒烟 | `[smoke command]` |
|
|
87
|
+
|
|
88
|
+
## 完成标准
|
|
89
|
+
|
|
90
|
+
只有当请求的改动已经实现、证据已经记录、必要审查已经处理、相关 SSoT 或
|
|
91
|
+
ledger 已经更新时,任务才算完成。
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# 架构事实源 / Architecture SSoT
|
|
2
|
+
|
|
3
|
+
Context Doc Type: architecture-ssot
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## System Summary
|
|
9
|
+
|
|
10
|
+
[用中文描述当前仓库,以及它参与的更大系统。保留关键服务名、仓库名和接口名原文。]
|
|
11
|
+
|
|
12
|
+
## Current Architecture Facts
|
|
13
|
+
|
|
14
|
+
| ID | Fact | Source Evidence | Last Verified | Confidence | Read Before |
|
|
15
|
+
| --- | --- | --- | --- | --- | --- |
|
|
16
|
+
| ARCH-001 | [事实,尽量一行说清] | [代码/文档/负责人说明/命令输出] | unknown | low | [path] |
|
|
17
|
+
|
|
18
|
+
## Promotion Log
|
|
19
|
+
|
|
20
|
+
| Source Task | Promoted Fact | Destination | Decision | Date |
|
|
21
|
+
| --- | --- | --- | --- | --- |
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# 架构 / Architecture
|
|
2
|
+
|
|
3
|
+
Context Doc Type: architecture-index
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
这个文件夹是系统结构事实源。它说明当前仓库负责什么、属于哪个更大的系统、以及 Agent 改代码前必须理解哪些服务、流程和架构决策。
|
|
11
|
+
|
|
12
|
+
Keep the English field names and file names because CLI checks rely on them.
|
|
13
|
+
|
|
14
|
+
## Read Order
|
|
15
|
+
|
|
16
|
+
1. `Architecture-SSoT.md`
|
|
17
|
+
2. `local-repo-context.md`
|
|
18
|
+
3. `system-map.md`
|
|
19
|
+
4. `service-catalog.md`
|
|
20
|
+
5. `critical-flows.md`
|
|
21
|
+
6. `services/<service-key>.md`
|
|
22
|
+
7. `decisions/ADR-*.md`
|
|
23
|
+
|
|
24
|
+
## Boundary
|
|
25
|
+
|
|
26
|
+
- 系统结构、服务责任、归属关系、关键流程放这里。
|
|
27
|
+
- Payload、endpoint 参数、event schema、SDK 细节放 `docs/06-INTEGRATIONS/`。
|
|
28
|
+
- 本地启动、mock、stub、跨仓调试经验放 `docs/04-DEVELOPMENT/`。
|
|
29
|
+
|
|
30
|
+
## Structure Contract
|
|
31
|
+
|
|
32
|
+
| 文件 / 路径 | 必须维护的事实 | 写入规则 |
|
|
33
|
+
| --- | --- | --- |
|
|
34
|
+
| `Architecture-SSoT.md` | 当前架构状态、关键决策、已知风险 | 只写跨任务仍成立的系统事实 |
|
|
35
|
+
| `local-repo-context.md` | 当前仓库在整体系统中的职责和边界 | 说明本仓负责什么、不负责什么 |
|
|
36
|
+
| `system-map.md` | 服务/模块拓扑、上下游关系、部署边界 | 用图或表表达全局关系,不写 payload |
|
|
37
|
+
| `service-catalog.md` | 服务总表;每个服务/微服务一行 | 新增服务先加这里,再决定是否建 profile |
|
|
38
|
+
| `services/<service-key>.md` | 单个服务的职责、数据、接口摘要、阅读入口 | 一个服务一个文件,不要多个服务混写 |
|
|
39
|
+
| `critical-flows.md` | 跨服务关键流程 | 写业务/系统流,不写接口字段明细 |
|
|
40
|
+
|
|
41
|
+
## Microservice Rule
|
|
42
|
+
|
|
43
|
+
如果系统有多个微服务,`service-catalog.md` 是总索引。每个已知服务至少有一行;只要该服务会影响本仓开发、调试、接口或任务判断,就为它创建 `services/<service-key>.md`。
|
|
44
|
+
|
|
45
|
+
每个 `services/<service-key>.md` 只回答三个问题:
|
|
46
|
+
|
|
47
|
+
1. 这个服务负责什么、拥有什么数据。
|
|
48
|
+
2. 它和本仓有什么关系。
|
|
49
|
+
3. Agent 修改本仓前还需要读哪些 `04-DEVELOPMENT` 和 `06-INTEGRATIONS` 文档。
|
|
50
|
+
|
|
51
|
+
不要在 `03-ARCHITECTURE` 里堆接口字段、mock 指令或临时调试记录。那些内容分别放到 `06-INTEGRATIONS` 和 `04-DEVELOPMENT`。
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# 关键流程 / Critical Flows
|
|
2
|
+
|
|
3
|
+
Context Doc Type: critical-flows
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Flow Index
|
|
9
|
+
|
|
10
|
+
| Flow ID | Name | Trigger | Services | Business Impact | Source Evidence | Last Verified | Confidence |
|
|
11
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
12
|
+
|
|
13
|
+
## Flow Template
|
|
14
|
+
|
|
15
|
+
下面只是示例。按真实业务选择 sequenceDiagram、flowchart 或 stateDiagram,不需要为每个任务强行画图。
|
|
16
|
+
|
|
17
|
+
```mermaid
|
|
18
|
+
sequenceDiagram
|
|
19
|
+
participant User
|
|
20
|
+
participant CurrentRepo
|
|
21
|
+
participant ExternalService
|
|
22
|
+
User->>CurrentRepo: request
|
|
23
|
+
CurrentRepo->>ExternalService: call
|
|
24
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# 本仓上下文 / Local Repo Context
|
|
2
|
+
|
|
3
|
+
Context Doc Type: local-repo-context
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Responsibility
|
|
9
|
+
|
|
10
|
+
[说明这个仓库的职责边界。不要把外部系统的实现细节写成当前仓库事实。]
|
|
11
|
+
|
|
12
|
+
## Main Components
|
|
13
|
+
|
|
14
|
+
| Component | Path | Responsibility | Source Evidence | Last Verified | Confidence |
|
|
15
|
+
| --- | --- | --- | --- | --- | --- |
|
|
16
|
+
|
|
17
|
+
## External Dependencies
|
|
18
|
+
|
|
19
|
+
| Dependency | Why It Matters | Architecture Link | Integration Link | Development Link |
|
|
20
|
+
| --- | --- | --- | --- | --- |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# 服务目录 / Service Catalog
|
|
2
|
+
|
|
3
|
+
Context Doc Type: service-catalog
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Services
|
|
9
|
+
|
|
10
|
+
| Service Key | Service / Component | Owner | Repo / Path | Responsibility | Interfaces | Data Owned | Dependencies | Service Profile | Development Context | Source Pack | Contract Index | Source Evidence | Last Verified | Stale After | Confidence |
|
|
11
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
12
|
+
|
|
13
|
+
## Boundary Rule
|
|
14
|
+
|
|
15
|
+
这个目录只放服务责任、接口摘要和跳转链接。Payload、auth、error code、event schema 放 `docs/06-INTEGRATIONS/`。
|
|
16
|
+
|
|
17
|
+
一个服务或微服务只占一行。只要该服务影响本仓开发或判断,就补 `services/<service-key>.md`、`docs/04-DEVELOPMENT/external-context/<service-key>.md` 和相关 `docs/06-INTEGRATIONS/<contract>.md` 链接。
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# 服务:<service-key> / Service: <service-key>
|
|
2
|
+
|
|
3
|
+
Context Doc Type: service-profile
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Index Links
|
|
9
|
+
|
|
10
|
+
| Catalog Row | Development Context | Source Pack | Integration Contracts | Last Verified | Confidence |
|
|
11
|
+
| --- | --- | --- | --- | --- | --- |
|
|
12
|
+
| `docs/03-ARCHITECTURE/service-catalog.md` | `docs/04-DEVELOPMENT/external-context/<service-key>.md` | `docs/04-DEVELOPMENT/external-source-packs/<source-key>/README.md` 或 N/A | `docs/06-INTEGRATIONS/<contract>.md` | unknown | low |
|
|
13
|
+
|
|
14
|
+
## Responsibility
|
|
15
|
+
|
|
16
|
+
[说明该服务拥有的职责、数据和边界。外部服务只写可验证事实。]
|
|
17
|
+
|
|
18
|
+
## Interfaces Summary
|
|
19
|
+
|
|
20
|
+
| Interface | Direction | Contract Link | Source Evidence | Last Verified | Confidence |
|
|
21
|
+
| --- | --- | --- | --- | --- | --- |
|
|
22
|
+
|
|
23
|
+
## Agent Read Before
|
|
24
|
+
|
|
25
|
+
- [架构链接 / architecture link]
|
|
26
|
+
- [开发上下文链接 / development context link]
|
|
27
|
+
- [接口契约链接 / integration contract link]
|
|
28
|
+
|
|
29
|
+
## Placement Rule
|
|
30
|
+
|
|
31
|
+
本文件只描述一个服务。不要把多个服务的职责、接口细节、mock 指令或临时调试记录合并到这里。
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# 系统图谱 / System Map
|
|
2
|
+
|
|
3
|
+
Context Doc Type: system-map
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Scope
|
|
9
|
+
|
|
10
|
+
[描述当前仓库所在的系统边界。图谱只表达结构关系,不承载 payload 或本地 mock 细节。]
|
|
11
|
+
|
|
12
|
+
## Mermaid Map
|
|
13
|
+
|
|
14
|
+
```mermaid
|
|
15
|
+
flowchart LR
|
|
16
|
+
current["Current Repository"] --> external["External Service"]
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Map Evidence
|
|
20
|
+
|
|
21
|
+
| Node | Meaning | Source Evidence | Last Verified | Confidence |
|
|
22
|
+
| --- | --- | --- | --- | --- |
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# 开发上下文 / Development Context
|
|
2
|
+
|
|
3
|
+
Context Doc Type: development-index
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
这个文件夹是 Agent 的开发输入包。它说明如何在本仓工作、外部服务不可见时如何开发、哪些内容只能 mock 或 stub、以及哪些假设不能直接成立。
|
|
11
|
+
|
|
12
|
+
Keep the English field names and section headings because CLI checks rely on them.
|
|
13
|
+
|
|
14
|
+
## Boundary
|
|
15
|
+
|
|
16
|
+
- 本地启动、代码地图、外部服务开发摘要、mock、stub、跨仓调试放这里。
|
|
17
|
+
- 长期系统结构放 `docs/03-ARCHITECTURE/`。
|
|
18
|
+
- API、event、webhook 等具体契约放 `docs/06-INTEGRATIONS/`。
|
|
19
|
+
|
|
20
|
+
## Structure Contract
|
|
21
|
+
|
|
22
|
+
| 文件 / 路径 | 必须维护的事实 | 写入规则 |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| `local-setup.md` | 本仓启动、依赖、环境变量、常见失败 | 只写开发启动事实,不写生产架构 |
|
|
25
|
+
| `codebase-map.md` | 本仓代码入口、目录职责、阅读顺序 | Agent 改代码前先看这里 |
|
|
26
|
+
| `external-context/<service-key>.md` | 外部服务对本仓开发的影响、mock/stub、调试入口 | 一个外部服务一个文件 |
|
|
27
|
+
| `external-source-packs/` | 外部团队提供的大量资料、索引、摘要、投影状态 | 资料摄取层,不是最终事实层 |
|
|
28
|
+
| `stubs-and-mocks.md` | 本仓可用 mock/stub 策略 | 写可执行路径或命令 |
|
|
29
|
+
| `cross-repo-debugging.md` | 跨仓问题定位顺序和证据 | 写调试流程,不写服务职责总览 |
|
|
30
|
+
|
|
31
|
+
## External Service Rule
|
|
32
|
+
|
|
33
|
+
如果本仓依赖多个微服务,不要把所有外部知识写进一个大文档。只要某个外部服务会影响本仓开发或测试,就创建:
|
|
34
|
+
|
|
35
|
+
- `docs/03-ARCHITECTURE/services/<service-key>.md`:该服务是什么、负责什么。
|
|
36
|
+
- `docs/04-DEVELOPMENT/external-context/<service-key>.md`:本仓开发时如何 mock、stub、调试它。
|
|
37
|
+
- `docs/06-INTEGRATIONS/<contract>.md`:具体 API/event/webhook 契约。
|
|
38
|
+
|
|
39
|
+
`04-DEVELOPMENT` 只放“开发时怎么处理这个外部服务”。不要在这里维护完整系统拓扑,也不要把 payload schema 塞进来。
|
|
40
|
+
|
|
41
|
+
## External Source Pack Rule
|
|
42
|
+
|
|
43
|
+
如果外部团队给了多份文档、截图、导出包、会议纪要或链接,不要直接塞进 `03/04/06`。先读 `docs/11-REFERENCE/external-source-intake-standard.md`,再决定是否创建 `external-source-packs/<source-key>/`。
|
|
44
|
+
|
|
45
|
+
`external-source-packs/` 只负责资料索引、摘要和投影状态。稳定结论必须回写到:
|
|
46
|
+
|
|
47
|
+
- `docs/03-ARCHITECTURE/services/<service-key>.md`
|
|
48
|
+
- `docs/04-DEVELOPMENT/external-context/<service-key>.md`
|
|
49
|
+
- `docs/06-INTEGRATIONS/<contract>.md`
|
|
50
|
+
|
|
51
|
+
## External Context Index
|
|
52
|
+
|
|
53
|
+
| Service Key | Why It Matters To This Repo | Local Stub / Mock | Debug Entry | Architecture Link | Contract Link | Last Verified | Confidence |
|
|
54
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# 代码地图 / Codebase Map
|
|
2
|
+
|
|
3
|
+
Context Doc Type: codebase-map
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Entry Points
|
|
9
|
+
|
|
10
|
+
| Area | Path | Responsibility | Read When | Source Evidence | Last Verified | Confidence |
|
|
11
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# 跨仓调试 / Cross-Repo Debugging
|
|
2
|
+
|
|
3
|
+
Context Doc Type: cross-repo-debugging
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Debug Flow
|
|
9
|
+
|
|
10
|
+
1. 先定位失败的 interface 或 flow。
|
|
11
|
+
2. 读 `docs/03-ARCHITECTURE/service-catalog.md`,确认归属和上下游服务。
|
|
12
|
+
3. 读对应的 `docs/06-INTEGRATIONS/` 契约。
|
|
13
|
+
4. 读 `docs/04-DEVELOPMENT/external-context/<service-key>.md`,使用其中的 mock、stub 和本地调试说明。
|
|
14
|
+
|
|
15
|
+
## Known Failure Modes
|
|
16
|
+
|
|
17
|
+
| Symptom | Likely Service | First Check | Source Evidence | Last Verified | Confidence |
|
|
18
|
+
| --- | --- | --- | --- | --- | --- |
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# 外部服务开发上下文:<service-key> / External Development Context: <service-key>
|
|
2
|
+
|
|
3
|
+
Context Doc Type: external-development-context
|
|
4
|
+
Owner: project coordinator
|
|
5
|
+
Last Verified: unknown
|
|
6
|
+
Confidence: low
|
|
7
|
+
|
|
8
|
+
## Index Links
|
|
9
|
+
|
|
10
|
+
| Service Profile | Source Pack | Integration Contracts | Last Verified | Confidence |
|
|
11
|
+
| --- | --- | --- | --- | --- |
|
|
12
|
+
| `docs/03-ARCHITECTURE/services/<service-key>.md` | `docs/04-DEVELOPMENT/external-source-packs/<source-key>/README.md` 或 N/A | `docs/06-INTEGRATIONS/<contract>.md` | unknown | low |
|
|
13
|
+
|
|
14
|
+
## Development Use
|
|
15
|
+
|
|
16
|
+
[说明 Agent 修改本仓时需要知道的外部服务事实。只写可验证事实、mock 方式和调试入口。]
|
|
17
|
+
|
|
18
|
+
## Do Not Assume
|
|
19
|
+
|
|
20
|
+
- [未查看外部仓库或未问负责人前不能成立的假设。]
|
|
21
|
+
|
|
22
|
+
## Mocks / Stubs
|
|
23
|
+
|
|
24
|
+
| Scenario | Stub / Mock | Command or Path | Source Evidence |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
|
|
27
|
+
## Cross-Repo Debug Notes
|
|
28
|
+
|
|
29
|
+
[当问题涉及这个外部服务时,按什么顺序定位、用哪些命令或日志确认。]
|
|
30
|
+
|
|
31
|
+
## Placement Rule
|
|
32
|
+
|
|
33
|
+
本文件只写本仓开发、测试、调试这个外部服务时需要的上下文。服务职责放 `03-ARCHITECTURE`,接口字段和 schema 放 `06-INTEGRATIONS`。
|