dev-playbooks-cn 1.0.6 → 1.0.7
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/package.json +1 -1
- package/templates/dev-playbooks/README.md +21 -14
- package/templates/dev-playbooks/docs/DevBooks/345/256/211/350/243/205/346/217/220/347/244/272/350/257/215.md +42 -0
- package/templates/dev-playbooks/docs/DevBooks/351/233/206/346/210/220/346/250/241/346/235/277/357/274/210/345/215/217/350/256/256/346/227/240/345/205/263/357/274/211.md +120 -0
- package/templates/dev-playbooks/docs/Slash /345/221/275/344/273/244/344/275/277/347/224/250/346/214/207/345/215/227.md" +485 -0
- package/templates/dev-playbooks/docs//346/216/250/350/215/220MCP.md +1923 -0
package/package.json
CHANGED
|
@@ -130,7 +130,7 @@ DevBooks 使用两个目录根:
|
|
|
130
130
|
| `<truth-root>` | 当前规格(只读真理) | `dev-playbooks/specs/` |
|
|
131
131
|
| `<change-root>` | 变更包(工作区) | `dev-playbooks/changes/` |
|
|
132
132
|
|
|
133
|
-
详见
|
|
133
|
+
详见 `docs/DevBooks集成模板(协议无关).md` 或使用 `docs/DevBooks安装提示词.md` 让 AI 自动配置。
|
|
134
134
|
|
|
135
135
|
---
|
|
136
136
|
|
|
@@ -414,7 +414,7 @@ DevBooks Skills 支持 MCP(Model Context Protocol)优雅降级:在没有 M
|
|
|
414
414
|
- 超时/失败 → 静默降级到基础模式,不阻塞执行
|
|
415
415
|
- 无需手动选择"基础/增强"模式
|
|
416
416
|
|
|
417
|
-
如需启用增强能力:按
|
|
417
|
+
如需启用增强能力:按 `docs/推荐MCP.md` 配置 CKB,并运行 `/devbooks:index` 生成 `index.scip`。
|
|
418
418
|
|
|
419
419
|
</details>
|
|
420
420
|
|
|
@@ -511,26 +511,33 @@ dev-playbooks-cn migrate --from speckit --keep-old
|
|
|
511
511
|
|
|
512
512
|
---
|
|
513
513
|
|
|
514
|
-
##
|
|
514
|
+
## 目录结构
|
|
515
515
|
|
|
516
516
|
```
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
517
|
+
dev-playbooks/
|
|
518
|
+
├── README.md # 本文档
|
|
519
|
+
├── constitution.md # 项目宪法(GIP 原则)
|
|
520
|
+
├── project.md # 项目上下文(技术栈/约定)
|
|
521
|
+
├── specs/ # 当前规格(只读真理)
|
|
522
|
+
│ ├── _meta/ # 元数据(术语表、项目画像)
|
|
523
|
+
│ └── architecture/ # 架构规格(fitness-rules)
|
|
524
|
+
├── changes/ # 变更包(工作区)
|
|
525
|
+
├── scripts/ # 辅助脚本
|
|
526
|
+
└── docs/ # 文档
|
|
527
|
+
├── Slash 命令使用指南.md
|
|
528
|
+
├── 推荐MCP.md
|
|
529
|
+
├── DevBooks集成模板(协议无关).md
|
|
530
|
+
└── DevBooks安装提示词.md
|
|
523
531
|
```
|
|
524
532
|
|
|
525
533
|
---
|
|
526
534
|
|
|
527
535
|
## 文档
|
|
528
536
|
|
|
529
|
-
- [Slash 命令使用指南](
|
|
530
|
-
- [
|
|
531
|
-
- [
|
|
532
|
-
- [
|
|
533
|
-
- [安装提示词](../docs/DevBooks安装提示词.md)
|
|
537
|
+
- [Slash 命令使用指南](docs/Slash%20命令使用指南.md)
|
|
538
|
+
- [MCP 配置建议](docs/推荐MCP.md)
|
|
539
|
+
- [集成模板(协议无关)](docs/DevBooks集成模板(协议无关).md)
|
|
540
|
+
- [安装提示词](docs/DevBooks安装提示词.md)
|
|
534
541
|
|
|
535
542
|
---
|
|
536
543
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
```text
|
|
2
|
+
你是“DevBooks 上下文协议适配器安装员(DevBooks Context Protocol Adapter Installer)”。你的目标是在目标项目中,把 DevBooks 的协议无关约定(<truth-root>/<change-root> + 角色隔离 + DoD + Skills 索引)集成到该项目的上下文协议里。
|
|
3
|
+
|
|
4
|
+
前置条件(先检查,缺失则停止并说明原因):
|
|
5
|
+
- 系统依赖已安装(必需:jq、ripgrep;推荐:scc、radon)
|
|
6
|
+
检查命令:command -v jq rg scc radon
|
|
7
|
+
若缺失,运行:<devbooks-root>/scripts/install-dependencies.sh
|
|
8
|
+
- 你能定位该项目的“标牌文件(signpost file)”(由上下文协议决定,常见:CLAUDE.md / AGENTS.md / PROJECT.md / <protocol>/project.md)。
|
|
9
|
+
|
|
10
|
+
硬约束(必须遵守):
|
|
11
|
+
1) 本次安装只允许改“上下文/文档标牌”,不得修改业务代码、tests、也不得引入新依赖。
|
|
12
|
+
2) 若目标项目已有“上下文协议托管区块(managed block)”,自定义内容必须放在托管区块之外,避免被后续自动更新覆盖。
|
|
13
|
+
3) 安装必须明确写出两个目录根:
|
|
14
|
+
- <truth-root>:当前真理目录根
|
|
15
|
+
- <change-root>:变更包目录根
|
|
16
|
+
|
|
17
|
+
任务(按顺序执行):
|
|
18
|
+
0) 检查系统依赖:
|
|
19
|
+
- 运行:command -v jq rg scc radon
|
|
20
|
+
- 若缺失必需依赖(jq、rg),提示用户先运行:./scripts/install-dependencies.sh
|
|
21
|
+
- 若缺失推荐依赖(scc、radon),说明这是可选项,用于启用“复杂度加权热点”等能力
|
|
22
|
+
1) 识别上下文协议类型(至少两条分支):
|
|
23
|
+
- 若检测到 DevBooks(存在 dev-playbooks/project.md):使用 DevBooks 默认值(<truth-root>=dev-playbooks/specs,<change-root>=dev-playbooks/changes)
|
|
24
|
+
- 否则:使用 `docs/DevBooks集成模板(协议无关).md` 进行集成
|
|
25
|
+
2) 为该项目确定目录根:
|
|
26
|
+
- 若项目已有 specs/changes 等目录约定:直接沿用作为 <truth-root>/<change-root>
|
|
27
|
+
- 若项目没有定义:推荐在仓库根目录使用 `specs/` 与 `changes/`
|
|
28
|
+
3) 将模板内容合入标牌文件(以追加方式合并):
|
|
29
|
+
- 写入:<truth-root>/<change-root>、变更包结构约定、角色隔离、DoD、devbooks-* Skills 索引
|
|
30
|
+
4) 验证(必须输出检查结果):
|
|
31
|
+
- 产物落点是否一致(proposal/design/tasks/verification/specs/evidence)
|
|
32
|
+
- 是否包含 Test Owner/Coder 隔离与“Coder 禁止修改 tests”
|
|
33
|
+
- 是否包含 DoD(MECE)
|
|
34
|
+
- 是否包含 devbooks-* Skills 索引
|
|
35
|
+
|
|
36
|
+
完成后输出:
|
|
37
|
+
- 系统依赖检查结果(哪些已安装、哪些缺失)
|
|
38
|
+
- 你修改了哪些文件(列表)
|
|
39
|
+
- 该项目最终的 <truth-root>/<change-root> 值
|
|
40
|
+
- 下一步最短路径示例(用自然语言点 2-3 个关键 skills)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# DevBooks 集成模板(协议无关)
|
|
2
|
+
|
|
3
|
+
> 目标:把 DevBooks 的**角色隔离**、**DoD(完成定义)**、**目录约定**、以及 `devbooks-*` Skills 索引,写入目标项目的“项目标牌文件(signpost file)”里(无需依赖 DevBooks 本体)。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## DevBooks 上下文(协议无关约定)
|
|
8
|
+
|
|
9
|
+
将以下信息添加到你的“项目标牌文件”(由项目上下文协议决定,常见候选:`CLAUDE.md`、`AGENTS.md`、`PROJECT.md` 等):
|
|
10
|
+
|
|
11
|
+
- 目录根(Directory Roots):
|
|
12
|
+
- `<truth-root>`:当前真理目录根(默认建议:`specs/`)
|
|
13
|
+
- `<change-root>`:变更包目录根(默认建议:`changes/`)
|
|
14
|
+
|
|
15
|
+
- 单次变更包文件落点(目录约定):
|
|
16
|
+
- `(<change-root>/<change-id>/proposal.md)`:提案
|
|
17
|
+
- `(<change-root>/<change-id>/design.md)`:设计文档
|
|
18
|
+
- `(<change-root>/<change-id>/tasks.md)`:编码计划
|
|
19
|
+
- `(<change-root>/<change-id>/verification.md)`:验证与追溯(含追溯矩阵、MANUAL-* 清单、证据要求)
|
|
20
|
+
- `(<change-root>/<change-id>/specs/**)`:本次变更的规格增量
|
|
21
|
+
- `(<change-root>/<change-id>/evidence/**)`:证据(按需)
|
|
22
|
+
|
|
23
|
+
- 当前真理目录建议结构(非强制,但建议保持一致):
|
|
24
|
+
- `(<truth-root>/_meta/project-profile.md)`:项目画像/约束/闸门/格式约定
|
|
25
|
+
- `(<truth-root>/_meta/glossary.md)`:统一语言术语表
|
|
26
|
+
- `(<truth-root>/architecture/c4.md)`:C4 架构地图(当前真理)
|
|
27
|
+
- `(<truth-root>/engineering/pitfalls.md)`:高 ROI 坑库(可选)
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 角色隔离(强制)
|
|
32
|
+
|
|
33
|
+
- Test Owner 与 Coder 必须在**独立对话/独立实例**中工作;允许并行,但不允许共享上下文造成“自证式测试”。
|
|
34
|
+
- Coder **禁止修改** `tests/**`;如需调整测试,必须交回 Test Owner 决策与修改。
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## DoD(完成定义,MECE)
|
|
39
|
+
|
|
40
|
+
每次变更至少要声明覆盖哪些闸门;未覆盖项必须写明原因与补救计划(建议写入 `(<change-root>/<change-id>/verification.md)`):
|
|
41
|
+
|
|
42
|
+
- 行为:unit/integration/e2e(按项目类型选择最小集合)
|
|
43
|
+
- 契约:OpenAPI/Proto/Schema/事件信封 + contract tests
|
|
44
|
+
- 结构:分层/依赖方向/无环(fitness tests)
|
|
45
|
+
- 静态/安全:lint/typecheck/build + SAST/secret scan
|
|
46
|
+
- 证据(按需):截图/录屏/报告(UI、性能、安全排查)
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## DevBooks Skills 索引(协议无关)
|
|
51
|
+
|
|
52
|
+
建议把下面的索引放入项目标牌文件,用来指导“什么时候用哪个 Skill”。
|
|
53
|
+
|
|
54
|
+
### 按角色
|
|
55
|
+
|
|
56
|
+
- Router:`devbooks-router` → 不确定下一步/阶段时做路由与产物落点建议(支持 Prototype 模式)
|
|
57
|
+
- Proposal Author:`devbooks-proposal-author` → `(<change-root>/<change-id>/proposal.md)`
|
|
58
|
+
- Proposal Challenger:`devbooks-proposal-challenger` → 质疑报告(可选写入变更包)
|
|
59
|
+
- Proposal Judge:`devbooks-proposal-judge` → 裁决回写到 `proposal.md`
|
|
60
|
+
- Impact Analyst:`devbooks-impact-analysis` → 影响分析(建议写回 proposal 的 Impact 部分)
|
|
61
|
+
- Design Owner:`devbooks-design-doc` → `(<change-root>/<change-id>/design.md)`
|
|
62
|
+
- Spec & Contract Owner:`devbooks-spec-contract` → `(<change-root>/<change-id>/specs/**)` + 契约计划
|
|
63
|
+
- Planner:`devbooks-implementation-plan` → `(<change-root>/<change-id>/tasks.md)`
|
|
64
|
+
- Test Owner:`devbooks-test-owner` → `(<change-root>/<change-id>/verification.md)` + `tests/**`
|
|
65
|
+
- Coder:`devbooks-coder` → 按 `tasks.md` 实现(禁止改 tests)
|
|
66
|
+
- Reviewer:`devbooks-code-review` → 评审意见(不改代码)
|
|
67
|
+
- Spec Gardener:`devbooks-spec-gardener` → 归档前修剪 `(<truth-root>/**)`
|
|
68
|
+
- C4 Map Maintainer:`devbooks-c4-map` → `(<truth-root>/architecture/c4.md)`
|
|
69
|
+
- Design Backport:`devbooks-design-backport` → 回写设计缺口/冲突
|
|
70
|
+
|
|
71
|
+
### 按工作流
|
|
72
|
+
|
|
73
|
+
- Proposal Debate:`devbooks-proposal-debate-workflow` → Author/Challenger/Judge 三角对辩
|
|
74
|
+
- Delivery Workflow:`devbooks-delivery-workflow` → 变更闭环 + 确定性脚本(scaffold/check/evidence)
|
|
75
|
+
- Brownfield Bootstrap:`devbooks-brownfield-bootstrap` → 存量项目初始化(`<truth-root>` 为空时)
|
|
76
|
+
|
|
77
|
+
### 按度量
|
|
78
|
+
|
|
79
|
+
- Entropy Monitor:`devbooks-entropy-monitor` → 系统熵度量(结构/变更/测试/依赖熵)+ 重构预警
|
|
80
|
+
|
|
81
|
+
### 按索引
|
|
82
|
+
|
|
83
|
+
- Index Bootstrap:`devbooks-index-bootstrap` → 生成 SCIP 索引,启用图基分析
|
|
84
|
+
- Federation:`devbooks-federation` → 跨仓库联邦分析与契约同步
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## CI/CD 集成(可选)
|
|
89
|
+
|
|
90
|
+
把 `templates/ci/` 里的模板复制到目标项目的 `.github/workflows/`:
|
|
91
|
+
|
|
92
|
+
- `devbooks-guardrail.yml`:在 PR 上做复杂度/热点/分层违规/环依赖检查
|
|
93
|
+
- `devbooks-cod-update.yml`:push 后自动更新 COD 模型(模块图/热点/概念)
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 跨仓库联邦(可选)
|
|
98
|
+
|
|
99
|
+
多仓库项目可配置 `.devbooks/federation.yaml` 定义上下游依赖:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
cp skills/devbooks-federation/templates/federation.yaml .devbooks/federation.yaml
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
详见 `skills/devbooks-federation/SKILL.md`
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## 自动 Skill 路由规则(无感集成)
|
|
110
|
+
|
|
111
|
+
> 这些规则让 AI 可以根据用户意图自动选择 Skills,不需要用户显式点名。
|
|
112
|
+
|
|
113
|
+
### 意图识别与自动路由
|
|
114
|
+
|
|
115
|
+
| 用户意图模式 | 自动选择 Skills |
|
|
116
|
+
|-------------|------------------|
|
|
117
|
+
| “修 bug”、“定位问题”、“为什么报错” | `devbooks-impact-analysis` → `devbooks-coder` |
|
|
118
|
+
| “重构”、“优化代码”、“消除重复” | `devbooks-code-review` → `devbooks-coder` |
|
|
119
|
+
| “新功能”、“增加 XX”、“实现 XX” | `devbooks-router` → 输出闭环路线 |
|
|
120
|
+
| “写测试”、“补测试” | `devbooks-test-owner` |
|