@nathan33/nao-skill 0.10.0 → 0.11.0
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/.agents/checklists/pm.md
CHANGED
|
@@ -56,7 +56,7 @@ description: PM 交付核对清单（按需，交付/派发前读取）
|
|
|
56
56
|
- [ ] Issue 与 `docs/` 双源（正文抄进 Issue，或状态只留平台）？
|
|
57
57
|
- [ ] 未过验收 / 门禁未绿就打 tag 或 release，或 tag 指向非 main 合并提交？（见 `github-flow.md`）
|
|
58
58
|
- [ ] `git push --force` 到 main/共享分支（未经用户明确授权并指明分支）？
|
|
59
|
-
- [ ] release notes 不可读（纯编号/类名/路径），或未落盘 `docs/releases/`？（规范：@.agents/common/release-notes.md ——
|
|
59
|
+
- [ ] release notes 不可读（纯编号/类名/路径），或未落盘 `docs/releases/`？（规范：@.agents/common/release-notes.md —— 面向用户「本次更新」置顶、内部信息下沉、正文不用表格）
|
|
60
60
|
- [ ] 降级（无 `gh` / 无远端）未在 `tasks-state` 与回执中标注？
|
|
61
61
|
|
|
62
62
|
## 交付检查清单（完整 36 项）
|
|
@@ -11,7 +11,7 @@ description: 发版说明写作规范（面向用户、说人话；写 / 验收
|
|
|
11
11
|
|
|
12
12
|
## 一、硬约束（必须遵守）
|
|
13
13
|
|
|
14
|
-
1.
|
|
14
|
+
1. **必须有面向用户的「本次更新」段，且置于正文最前。**
|
|
15
15
|
- GitHub Release 正文 与 仓库 `docs/releases/vX.Y.Z.md` 的**顶部口径一致**（同一份文字、同一版本）。
|
|
16
16
|
- 读者 = **最终用户**，不是开发者；看完前几行就知道「这版对我有什么变化」。
|
|
17
17
|
2. **正文 ⛔ 不得出现内部术语 / 编号。** 一律不写：任务或缺陷编号（`DEF-xx` / `Txxx` / `#123`）、提交哈希、文件名与函数名、内部属性名（如 `aria-disabled` / `dirty`）、测试例数与通过率、守卫名、内部模块名。
|
|
@@ -28,9 +28,9 @@ description: 发版说明写作规范（面向用户、说人话；写 / 验收
|
|
|
28
28
|
3. **🐛 修好了** —— 修掉的问题（用户视角现象 → 现在）。
|
|
29
29
|
4. **⚠️ 请留意** —— 行为变更 / 需要用户配合的事。
|
|
30
30
|
5. **📦 更小更快** —— 体积 / 性能 / 启动等可感知收益。
|
|
31
|
-
6.
|
|
32
|
-
7. **技术细节（可略过）** —— 编号 / 哈希 / 依赖版本 / 门禁数字 / 文档链接。
|
|
31
|
+
6. **技术细节（可略过）** —— 编号 / 哈希 / 依赖版本 / 门禁数字 / 文档链接。
|
|
33
32
|
|
|
33
|
+
- **已知问题出口**：会影响用户 ⇒ 写入「⚠️ 请留意」；否则下沉「技术细节（可略过）」。
|
|
34
34
|
- **纯内部仓**（无面向用户交付）可省略第 2–5 段的「面向用户」写法，但**结构保留**（仍按「概括 → 变化 → 技术细节」分层）。
|
|
35
35
|
- **排版**：本文件与其他文档同受 @.agents/checklists/deliverable-docs.md 「默认不使用表格」约束 —— release notes 正文尤其不要用表格。
|
|
36
36
|
|
|
@@ -43,10 +43,10 @@ description: 发版说明写作规范（面向用户、说人话；写 / 验收
|
|
|
43
43
|
|
|
44
44
|
## 四、发布前核对
|
|
45
45
|
|
|
46
|
-
- [ ]
|
|
46
|
+
- [ ] 正文最前有面向用户的**「本次更新」**段（用户看得懂）。
|
|
47
47
|
- [ ] 正文**无**编号 / 哈希 / 文件名 / 函数名 / 内部属性名 / 测试例数 / 守卫名 / 内部模块名。
|
|
48
48
|
- [ ] 行为变更写了**用户视角的后果**（不是内部机制）。
|
|
49
|
-
- [ ] 结构完整（一句话 → 变化 →
|
|
49
|
+
- [ ] 结构完整（一句话 → 变化 → 技术细节）；内部信息集中在「技术细节」段。
|
|
50
50
|
- [ ] 正文**未使用表格**（改用有序 / 无序列表；见 @.agents/checklists/deliverable-docs.md）。
|
|
51
51
|
- [ ] `docs/releases/<version>.md` 与 GitHub Release 正文同源。
|
|
52
52
|
|
|
@@ -54,5 +54,5 @@ description: 发版说明写作规范（面向用户、说人话；写 / 验收
|
|
|
54
54
|
|
|
55
55
|
- [ ] 只写内部机制、用户看不懂？
|
|
56
56
|
- [ ] 正文里直接出现编号 / 哈希 / 类名 / 属性名 / 测试例数？
|
|
57
|
-
- [ ]
|
|
57
|
+
- [ ] 没有面向用户的「本次更新」段，或它不在最前？
|
|
58
58
|
- [ ] 盘上 release notes 与 Release 正文两处不一致？
|
|
@@ -54,7 +54,7 @@ PM 在**立项 / 终签 / 发布**时读取；RD 在**起分支 / 开 PR / 合
|
|
|
54
54
|
- 门禁：AC 全过 + 验收闭环 + main 门禁全绿 + 工作区干净 + PR 已合并。
|
|
55
55
|
- **优先 `gh`**：`gh release create <tag> --title "<用户可读标题>" --notes-file docs/releases/<version>.md`。
|
|
56
56
|
- 探测：`gh auth status` 按 **exit code** 判定（`keyring` 警告但 exit 0 **仍可用**，可 `gh api user` 复核）；**不自动 `gh auth login`**（涉用户凭证）。
|
|
57
|
-
- release notes 落盘 `docs/releases/<version>.md`（**写作规范（强约束）：@.agents/common/release-notes.md** ——
|
|
57
|
+
- release notes 落盘 `docs/releases/<version>.md`（**写作规范（强约束）：@.agents/common/release-notes.md** —— 面向用户「本次更新」置顶、内部编号 / 文件名 / 属性名一律下沉「技术细节」、正文不用表格；骨架见 @.agents/templates/release-notes.md.example）。
|
|
58
58
|
- 回滚：未 push → `git tag -d`；已 push → **不删远端 tag**，改发下一个 PATCH 修正（用户明确要求才删）。
|
|
59
59
|
|
|
60
60
|
## 离线 / 无远端降级
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
- <命令纪律，如：禁 cat 全文读代码，用 CodeGraph 或 sed 行段>
|
|
25
25
|
- <依赖限制 / 禁止事项>
|
|
26
26
|
- **Git 流程（GitHub Flow）**：一个需求一条分支 `feat/<issue-id>-<slug>`；工作期 `wip()` 小步提交 + 路径级暂存（禁 `git add -A`）；**PM 验收通过后由 RD 在 PR 上 squash 合并**（main = 1 条/需求）；**禁直推 main**。
|
|
27
|
-
- **发布与仓库治理**：PM 负责 Issue / PR 验收评论 / tag / release / `.github/` 模板（优先 `gh`，不可用降级 `git`）；**发版说明写法遵循 `@.agents/common/release-notes.md
|
|
27
|
+
- **发布与仓库治理**：PM 负责 Issue / PR 验收评论 / tag / release / `.github/` 模板（优先 `gh`，不可用降级 `git`）；**发版说明写法遵循 `@.agents/common/release-notes.md`**（面向用户「本次更新」置顶、内部信息下沉、正文不用表格）。
|
|
28
28
|
|
|
29
29
|
## 与 nao 机制衔接
|
|
30
30
|
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<!--
|
|
2
2
|
release notes 骨架 —— 复制为 docs/releases/<version>.md 后逐段填空。
|
|
3
3
|
权威规范：@.agents/common/release-notes.md
|
|
4
|
-
|
|
4
|
+
用法：把面向用户的「本次更新」放在最前；内部信息一律下沉「技术细节（可略过）」。
|
|
5
5
|
⛔ 自查：正文无编号 / 哈希 / 文件名 / 函数名 / 内部属性名 / 测试例数 / 守卫名 / 内部模块名；正文不要用表格。
|
|
6
6
|
-->
|
|
7
7
|
|
|
8
|
-
#
|
|
8
|
+
# 本次更新
|
|
9
9
|
|
|
10
10
|
**<一句话概括这版最大的变化；用用户能听懂的话。>**
|
|
11
11
|
|
|
@@ -28,10 +28,6 @@
|
|
|
28
28
|
|
|
29
29
|
- <体积 / 性能 / 启动等可感知收益>。<!-- 没有就整节删除 -->
|
|
30
30
|
|
|
31
|
-
## 已知但本期未处理
|
|
32
|
-
|
|
33
|
-
- <已知问题 + 计划>。<!-- 没有就写「无」 -->
|
|
34
|
-
|
|
35
31
|
## 技术细节（可略过）
|
|
36
32
|
|
|
37
33
|
- 版本号：<包名旧版本 → 新版本>（如涉及多个包，逐条列出）
|