ai-project-manage-cli 4.0.23 → 5.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.
@@ -1,123 +0,0 @@
1
- ---
2
- name: apm-propose
3
- description: 由 PRD 在 .apm/workitems/<requirementId>/ 按依赖顺序生成 proposal、design、specs、tasks,当用于主动声明使用该技能时触发。
4
- ---
5
-
6
- # APM 工作项:规划工件
7
-
8
- 在 **`.apm/workitems/<requirementId>/prd.md`** 上生成实现前规划工件。每个文件**生成前须读哪些依赖、与谁对齐**,以对应 **`propose-instruction.md` / `design-instruction.md` / `specs-instruction.md` / `tasks-instruction.md`** 里的 **「依赖」** 小节为**唯一清单**(本 SKILL 不重复展开)。本 SKILL 只约定**撰写顺序**与 **「单会话读取策略」**;落笔前须已掌握该工件 instruction 所列依赖(是否重复全文 Read 见策略)。
9
-
10
- ---
11
-
12
- ## 输入
13
-
14
- | 字段 | 规则 |
15
- | --- | --- |
16
- | **`requirementId`** | **必填**。与 `.apm/workitems/<requirementId>/` 目录名一致。 |
17
- | **需求正文** | **唯一权威**:`.apm/workitems/<requirementId>/prd.md`。进入流程时须至少 **Read** 一次全文(是否在同一会话中重复读见「单会话读取策略」)。 |
18
-
19
- 若 `prd.md` 不存在或不可读:先在仓库根目录执行 **`apm get requirement <requirementId>`**,该命令会下载最新的需求文档,再 **`Read`** 一次;仍不存在则**停止**并说明。**不要**用开放式提问代替 PRD;**不要**在缺 PRD 时继续生成工件。
20
-
21
- 用户在本轮对话中的补充:仅在与 PRD 兼容时写入;若写入,在相关段落标注 **「会话补充(PRD 未载明)」**。
22
-
23
- ---
24
-
25
- ## Steps
26
-
27
- ### 1. 锚定工作项与 PRD
28
-
29
- - 根路径:`.apm/workitems/<requirementId>/`。
30
- - 若尚无 `prd.md`:在仓库根目录执行 **`apm get requirement <requirementId>`**,再 **`Read` `prd.md` 全文**。若仍缺失则停止。
31
- - 已有则直接 `Read`:`prd.md` 全文。提取:目标用户/场景、范围、非目标、约束、验收口径。
32
- - PRD 未写明的:**不反问用户**;在后续工件的「假设 / 风险 / 待确认」中写明。
33
- - 必要时 **SemanticSearch** / **Read** 仓库代码,便于 `tasks.md` 中 **预期改动路径** 可落地;**不要**臆造 PRD 未给出的业务范围。
34
-
35
- ### 2. 编排顺序与依赖出处
36
-
37
- - **依赖明细**(每个产出写入前须掌握哪些文件、不读哪些):**只以**各 **`*-instruction.md`** 的 **「依赖」** 为准;不要在未读 instruction 的情况下凭记忆补依赖。
38
- - **撰写顺序(编排)**:
39
- 1. 先 **`proposal`**;再 **`design`** 与 **`specs`**(二者均只在 **`proposal` 落盘之后**撰写,**无**先后顺序要求,**互不**等待;**`specs` 是否读 `design`** 以 **`specs-instruction.md`** 为准)。
40
- 2. 最后 **`tasks`**:解锁条件以 **`tasks-instruction.md`**「依赖」为准(通常为 **`design` 与 `specs` 均已就绪**)。
41
- - **何时调用 Read**、如何避免重复读:下节 **「单会话读取策略」**。
42
-
43
- ### 单会话读取策略(推荐)
44
-
45
- 同一 Agent **连续一次跑完** proposal → design/specs → tasks 时,在**不违背各 instruction「依赖」、不少引用**的前提下减少重复 Read:
46
-
47
- | 类型 | 建议 |
48
- | --- | --- |
49
- | **`prd.md`** | 进入流程时 **Read 至少一次全文**。若本会话内已完整读过且无疑虑,写后续工件时**不必**为仪式感再次全文 Read;若 PRD **很长**、会话已很长、或需核对某条款,可对相关段落 **Read(偏移)** 或再读全文。 |
50
- | **`proposal.md`** | 落盘后,后续步骤以**磁盘文件**为准;若会话内已含刚写入的 proposal 全文,写 **design / specs** 时**可不重复 Read**,除非发现与磁盘不一致或需对账 Capabilities。 |
51
- | **`design.md` / `specs/`** | 写完并落盘后,写 **tasks** 时若会话内已无可靠记忆,应对 **`design.md`** 与 **`specs/` 下有关文件**执行 **Read**(至少覆盖 tasks 要引用的需求编号与路径);若会话内仍完整持有二者内容,可直接撰写 tasks,**以落盘文件为最终依据**。 |
52
- | **`*-instruction.md`** | 每类工件在**首次**进入该工件撰写前 **Read** 对应 instruction **全文**一次即可;**不要**在同一轮流程里重复 Read 同一 instruction 文件,除非文件曾被改动或你从其他会话恢复。 |
53
- | **新会话 / 断点续写** | **不以**上表省略 Read:按各 **`*-instruction.md`「依赖」** 对**缺失或未确认的**文件重新 **Read**(通常以磁盘为准)。 |
54
-
55
- **不变原则**:**省略的是重复 Read**,不是省略各 instruction 写明的依赖关系;若本 SKILL 的编排顺序与某 **`*-instruction.md`「依赖」**冲突,**以该 instruction 为准**。
56
-
57
- 使用 **TodoWrite** 跟踪四工件状态(`ready` / `blocked` / `done`);**每完成一工件即落盘并标 `done`**,再解锁下一可写工件。**tasks** 条目中如何对照 specs、对齐 design 路径,以 **`tasks-instruction.md`** 为准。
58
-
59
- ### 3. 生成各工件(按依赖解锁顺序)
60
-
61
- 对当前工件:
62
-
63
- a. **掌握依赖内容**(见当前工件对应的 **`*-instruction.md`「依赖」** 与「单会话读取策略」):按需 **Read**;**不要**把内部思考用标签(如 `<context>`)写进产出文件。
64
-
65
- b. **按各类工件的说明与模板**组织正文,内容严格以 **PRD** 为范围;说明文字**不**复制进产出文件。
66
-
67
- #### `proposal` → `proposal.md`
68
-
69
- - **Instruction**:按「单会话读取策略」读取 **`.apm/skills/apm-propose/propose-instruction.md`**(每个流程一次)。
70
- - **依赖**:以该文件 **「依赖」** 为准(**Read** 时机见「单会话读取策略」)。
71
- - **再写**:`.apm/workitems/<requirementId>/proposal.md`,严格遵循其中的 **Instruction** 与 **Template**(Why / What Changes / Capabilities / Impact)。
72
- - **Capabilities** 与后续 **`specs/*.md`** 一一可追溯;填写前可 **Read** `.apm/product-capability-inventory/` 等本仓库能力文档,避免与既有 CAP/命名冲突(路径以仓库实际为准)。
73
- - PRD 中有但 instruction 未列出的要点:在 **What Changes** 或 **Impact** 中体现;缺口/假设写在 **Why** 或 **Capabilities** 注释性短句中,**不反问用户**。
74
-
75
- #### `design` → `design.md`
76
-
77
- - **Instruction**:**`.apm/skills/apm-propose/design-instruction.md`**(每个流程一次)。
78
- - **依赖**:以该文件 **「依赖」** 为准(**Read** 时机见「单会话读取策略」)。
79
- - **再写**:`.apm/workitems/<requirementId>/design.md`,严格遵循其中的 **Instruction** 与 **Template**(Context、Goals/Non-Goals、Decisions、Risks/Trade-offs、Migration Plan、Open Questions)。
80
- - 说明「何时写满 / 可写精简版」的条件以 **design-instruction** 为准;与本仓库 **`tasks.md`** 的分工是:design 定方案与取舍,tasks 拆可执行步与 **预期改动路径**。
81
-
82
- #### `specs` → `specs/*.md`
83
-
84
- - **Instruction**:**`.apm/skills/apm-propose/specs-instruction.md`**(每个流程一次)。
85
- - **依赖**:以该文件 **「依赖」** 为准(**Read** 时机见「单会话读取策略」)。
86
- - **再写**:`.apm/workitems/<requirementId>/specs/` 下文件,严格遵循 **specs-instruction** 中的写作说明与模板(新增/变更/移除/重命名分块、`### 需求` / `#### 场景`、须/必须、**当**/**则** 等)。
87
- - **与 proposal 对齐**:**proposal** 能力列表中每一项须在 `specs/` 有对应;命名与 **`propose-instruction.md`** 短横线文件名约定一致;细则以 **specs-instruction** 为准。
88
-
89
- #### `tasks` → `tasks.md`
90
-
91
- - **Instruction**:**`.apm/skills/apm-propose/tasks-instruction.md`**(每个流程一次)。
92
- - **依赖**:以该文件 **「依赖」** 为准;写 **tasks** 时对**需求编号、路径、spec 条目**须有可靠依据,若会话内记忆不足则按「单会话读取策略」对相关落盘文件 **Read**。
93
- - **再写**:`.apm/workitems/<requirementId>/tasks.md`,严格遵循 **tasks-instruction**(**`- [ ]`**、分组 **`## 1.`**、编号 **1.1 / 2.1**、四条元数据子列表等)。
94
- - **口径**:做什么以 **specs** 为准,落在哪里以 **design** 为准;**预期改动路径** 与 design 一致。
95
-
96
- c. 每完成一个工件并落盘后,简短提示,如:`已创建 proposal` / `design` / `specs` / `tasks`。
97
-
98
- d. **不要**在依赖未满足时写下一工件(例如:`tasks` 不能在 `design` 或 `specs` 任一缺失时开写)。
99
-
100
- ### 4. 全部就绪
101
-
102
- 当 TodoWrite 中四个工件均为完成态,且无缺文件:
103
-
104
- - 汇总:工作项路径、已创建文件、PRD 与各工件的对应关系(一两句)。
105
- ---
106
-
107
- ## Output(对话中)
108
-
109
- 完成全部工件后,回复须包含:
110
- - **工件列表**及各自一句话用途
111
- - **PRD 如何**映射到 proposal / design / specs / tasks
112
-
113
- ---
114
-
115
- ## Guardrails(对应原 Guardrails)
116
-
117
- - **跨工件一致**:后写须与 **PRD** 及已落盘的前序规划文件一致;各文件写什么、依赖谁、如何对齐 **proposal/specs/design**,**只以**各 **`*-instruction.md`** 为准(与 §3 相同来源,此处不重复展开)。
118
- - **产出纯净**:工作项下的 Markdown **不**夹带本 SKILL/对话中的内部推理、标签式草稿(参见 §3 步骤 a)。
119
- - **四个工件缺一不可**(specs 至少一个 `.md`);遗漏则补全后再宣布完成。
120
- - **每写一个文件**:确认路径存在、内容非空后再进入下一工件。
121
- - **默认不覆盖**已存在的规划文件;若用户明确要求「整目录覆盖重生成」,可重写并声明覆盖范围。
122
- - **同名工作项目录**:以 `requirementId` 为唯一锚点。
123
- - **不向用户追问**需求细节以推进度;歧义写入假设或「待确认」。
@@ -1,94 +0,0 @@
1
- # design 工件:写作说明
2
-
3
- 生成 **`design.md`** 时说明 **如何实现**(HOW):架构与决策为主,不写逐行代码。动机与范围以 **`proposal.md`** 为准,需求细节以 **`prd.md`** 与后续 **`specs/`** 为准。
4
-
5
- **工件 DAG、单会话减少重复 Read**:见 **`.apm/skills/apm-propose/SKILL.md`**(「工件依赖」「单会话读取策略」)。
6
-
7
- ---
8
-
9
- ## 依赖(写入前须 Read 完)
10
-
11
- | 文件 | 说明 |
12
- | --- | --- |
13
- | `.apm/workitems/<requirementId>/prd.md` | 约束、验收、业务事实 |
14
- | `.apm/workitems/<requirementId>/proposal.md` | Why / What / Capabilities / Impact |
15
-
16
- 若 **`proposal.md` 不存在**,**不得**单独写 `design.md`(与 DAG 一致)。
17
-
18
- ---
19
-
20
- ## 输出路径
21
-
22
- - **`.apm/workitems/<requirementId>/design.md`**
23
-
24
- ---
25
-
26
- ## 何时需要写满设计文档
27
-
28
- 若以下任一条成立,应写完整 **`design.md`**;若均不成立且变更极小,可写精简版,但仍建议保留 **Context** 与 **Decisions** 要点。
29
-
30
- - 跨模块/多服务,或引入新的架构模式
31
- - 新外部依赖,或数据模型/API 有显著变更
32
- - 安全、性能、迁移复杂度值得关注
33
- - 需要先拍板技术方案再编码的模糊点
34
-
35
- ---
36
-
37
- ## Instruction
38
-
39
- 撰写技术设计:**偏架构与取舍**,不要替代 **`tasks.md`** 里的实现步骤枚举。
40
-
41
- **须覆盖的小节**:
42
-
43
- - **Context**:背景、当前状态、约束、干系人(可简写)
44
- - **Goals / Non-Goals**:本设计要达到什么、**明确不做什么**
45
- - **Decisions**:关键技术与选型,**每项**说明取舍与备选方案(为何 X 而非 Y)
46
- - **Risks / Trade-offs**:风险与妥协,格式建议:`[风险] → 缓解措施`
47
- - **Migration Plan**:上线/灰度/回滚步骤(不适用则写「无」或「不适用」)
48
- - **Open Questions**:尚未决定或待验证项
49
-
50
- 写作时:**引用 proposal 的动机**;规格层行为以 **prd / specs** 为准,不在 design 里重复抄 specs 全文。重点是决策的 **why**。
51
-
52
- ---
53
-
54
- ## Template(产出 `design.md` 时按此结构填空)
55
-
56
- 小节标题可使用英文如下,或改为中文等价(如 **Context** → **上下文**,**Decisions** → **技术决策** 等)。
57
-
58
- ```markdown
59
- ## Context
60
-
61
- <!-- 背景、现状、约束、干系人 -->
62
-
63
- ## Goals / Non-Goals
64
-
65
- **Goals:**
66
-
67
- <!-- 本设计要达成什么 -->
68
-
69
- **Non-Goals:**
70
-
71
- <!-- 明确不做的范围 -->
72
-
73
- ## Decisions
74
-
75
- <!-- 关键选型:备选方案 + 取舍理由 -->
76
-
77
- ## Risks / Trade-offs
78
-
79
- <!-- [风险] → 缓解 -->
80
-
81
- ## Migration Plan
82
-
83
- <!-- 部署/迁移/回滚;无则说明 -->
84
-
85
- ## Open Questions
86
-
87
- <!-- 待决问题;无则写 无 -->
88
- ```
89
-
90
- ---
91
-
92
- ## Unlocks
93
-
94
- 完成并落盘 **`design.md`** 后,与已完成的 **`specs/`** 一起解锁 **`tasks.md`**(`tasks` 须同时依赖二者)。
@@ -1,81 +0,0 @@
1
- # proposal 工件:写作说明
2
-
3
- 生成 **`proposal.md`** 时须建立 **「为何要做」**,并与后续 **`specs/`** 对齐:**Capabilities** 段落是 proposal 与 specs 之间的契约。
4
-
5
- **工件 DAG、单会话减少重复 Read**:见 **`.apm/skills/apm-propose/SKILL.md`**(「工件依赖」「单会话读取策略」)。
6
-
7
- ---
8
-
9
- ## 输出路径
10
-
11
- - 工作项目录:`.apm/workitems/<requirementId>/`
12
- - 写入:**`.apm/workitems/<requirementId>/proposal.md`**
13
-
14
- ---
15
-
16
- ## 依赖(写入前须 Read 完)
17
-
18
- | 文件 | 说明 |
19
- | --- | --- |
20
- | **`.apm/workitems/<requirementId>/prd.md`** | **唯一权威需求来源**;须全文阅读后再写 `proposal.md`。 |
21
-
22
- 若工作项下尚无 **`prd.md`**:先在仓库根目录执行 **`apm get requirement <requirementId>`**,再 **Read**;仍缺失则**不得**生成 proposal(以 apm-propose **SKILL** 为准)。
23
-
24
- ---
25
-
26
- ## Instruction
27
-
28
- 以 **`prd.md`** 为事实来源撰写变更提案(**Why**,不写实现细节;实现放在 `design.md`)。
29
-
30
- **篇幅**:精短,约 1~2 页等效内容均可。
31
-
32
- ### 必含小节
33
-
34
- - **Why**:1~2 句话说明问题或机会——解决什么、为何是现在。
35
- - **What Changes**:要点列表,写清新增/修改/删除的能力;**破坏性变更**标注 **BREAKING**。
36
- - **Capabilities**:标明后续 **`specs/`** 要如何落文件——这是 proposal 与 specs 阶段的**契约**,填写前可检索仓库内既有能力文档(如 `.apm/product-capability-inventory/`)或相关 PRD/CAP 引用,避免与已有命名脱节。
37
- - **New Capabilities**:新增能力,每一条对应本工作项下后续将新增的 **`specs/<kebab-name>.md`** 文件(例如 `user-auth`、`api-rate-limit`)。用 kebab-case 作文件名主干。
38
- - **Modified Capabilities**:已有「规格层行为」将变更的能力(不仅是实现细节)。每条对应后续 **delta 规格**写法(可与 New 一样落在 `specs/<name>.md`,在文中标明相对既有行为的增量变更)。若无行为规格变化则留空或写「无」。
39
- - **Impact**:受影响的代码区域、API、依赖、系统或运维面。
40
-
41
- **注意**:Capabilities 里列出的每一项,都应在后续 **`specs/`** 中有可追溯对应(可一文件多条能力,但须在 specs 中写清)。
42
-
43
- ---
44
-
45
- ## Template(产出 `proposal.md` 时按此结构填空)
46
-
47
- 小节标题可使用英文如下,或改为中文等价(如 **Why** → **背景与动机**,**What Changes** → **变更内容**,**Capabilities** → **能力范围**,**Impact** → **影响面**)。
48
-
49
- ```markdown
50
- ## Why
51
-
52
- <!-- 动机:解决什么问题?为何是现在? -->
53
-
54
- ## What Changes
55
-
56
- <!-- 具体变更要点;BREAKING 标注破坏性变更 -->
57
-
58
- ## Capabilities
59
-
60
- ### New Capabilities
61
-
62
- <!-- 每条对应后续 `specs/<kebab-name>.md` -->
63
-
64
- - `<name>`: <brief description>
65
-
66
- ### Modified Capabilities
67
-
68
- <!-- 既有能力在规格层的行为变化;无则写 无 -->
69
-
70
- - `<existing-name>`: <what requirement behavior changes>
71
-
72
- ## Impact
73
-
74
- <!-- 受影响代码、API、依赖、系统 -->
75
- ```
76
-
77
- ---
78
-
79
- ## Unlocks
80
-
81
- 完成并落盘 **`proposal.md`** 后,方可编写 **`design.md`** 与 **`specs/`**(二者仅依赖 proposal,可并行)。
@@ -1,114 +0,0 @@
1
- # specs 工件:写作说明(供 apm-propose 读取)
2
-
3
- 在工作项目录下生成 **`specs/`** 内的规格文件,定义系统 **应做什么**,与 **`design.md`**(如何实现)区分。内容须可验证:**每条「需求」下须有至少一个「场景」**。
4
-
5
- **工件 DAG、单会话减少重复 Read**:见 **`.apm/skills/apm-propose/SKILL.md`**(「工件依赖」「单会话读取策略」)。
6
-
7
- ---
8
-
9
- ## 依赖(写入前须全文阅读)
10
-
11
- | 文件 | 说明 |
12
- | --- | --- |
13
- | **`.apm/workitems/<requirementId>/prd.md`** | 业务事实、约束、验收;**唯一权威需求来源**。 |
14
- | **`.apm/workitems/<requirementId>/proposal.md`** | **能力范围**(新增能力 / 变更能力);每项能力须在 `specs/` 中有对应文档;文件名用**短横线小写**(如 `user-auth`、`data-export`)。 |
15
-
16
- 若无 **`proposal.md`**,不得编写 specs。若无 **`prd.md`**,按 apm-propose **SKILL** 先执行 **`apm get requirement <requirementId>`** 再读。
17
-
18
- **不依赖** **`design.md`**:specs 可与设计文档并行撰写,但须与 **proposal 中的能力约定**、**prd** 一致。
19
-
20
- ---
21
-
22
- ## 输出位置
23
-
24
- - 根目录:**`.apm/workitems/<requirementId>/specs/`**
25
- - 文件组织(须与 **`propose-instruction.md`** 及 proposal 中的能力列表一致):
26
- - **常用**:一能力一文件 **`specs/<短横线名称>.md`**
27
- - **也可**:**`specs/<短横线名称>/规格.md`**(同一工作项内择一风格,勿混用)
28
-
29
- ---
30
-
31
- ## 写作说明
32
-
33
- ### 与 proposal 对齐
34
-
35
- 按 **`proposal.md`「能力范围」**逐条落地:
36
-
37
- - **新增能力**:每个名称对应一个上述路径下的文件,以 **「新增需求」** 类内容为主。
38
- - **变更能力**:在对应文件中用 **变更需求 / 移除需求 / 重命名需求** 等章节描述相对旧行为的变化。若仓库有既有能力说明,可先阅读 **`.apm/product-capability-inventory/`** 或相关能力文档以核对名称,**不得**虚构 prd、proposal 未出现的能力。
39
-
40
- ### 变更分块(均使用二级标题 `##`)
41
-
42
- 可按需组合多个分块:
43
-
44
- | 二级标题 | 用途 |
45
- | --- | --- |
46
- | **新增需求** | 全新能力或新需求条款。 |
47
- | **变更需求** | 行为有变:须写入**修改后的完整段落**(从「### 需求:」到其下全部场景),禁止只贴片段,以免后续对账丢失上下文。 |
48
- | **移除需求** | 下线或废弃:每条须写 **原因**、必要时写 **迁移说明**。 |
49
- | **重命名需求** | 仅名称变化:写清 **原名称**、**新名称**。 |
50
-
51
- 若整份文件均为新能力,可只保留 **新增需求** 分块。纯新增内容放在 **新增需求**,不要用 **变更需求** 代替。
52
-
53
- ### 单条需求结构
54
-
55
- - 需求标题:`**### 需求:<名称>**`,其下为正文。
56
- - **措辞**:对行为约束用 **须、必须** 等明确用语,避免「尽量、可以」之类除非 prd 明确要求弱化。
57
- - 场景标题:`**#### 场景:<名称>**`(场景标题固定用 **四个井号**,勿用三个,以免与需求层级混淆)。
58
- - 场景正文建议采用:
59
- - `- **当** …`
60
- - `- **则** …`
61
- - **每条需求至少包含一个场景。**
62
-
63
- ### 变更类特别注意
64
-
65
- 若产品清单或仓库中已有该能力的旧规格,应先找到旧全文,再整体放入 **变更需求** 下改写,**保持标题与结构便于对照**。
66
-
67
- 若只是补充新条款、不改变已有行为,在 **新增需求** 中增加条目,勿用 **变更需求**。
68
-
69
- ### 可验证性
70
-
71
- 每个 **场景** 都能对应测试或验收步骤;后续 **`tasks.md`** 中的 **需求编号** 可与 **需求 / 场景** 标题互相对照。
72
-
73
- ---
74
-
75
- ## 单文件模板示例
76
-
77
- ```markdown
78
- ## 新增需求
79
-
80
- ### 需求:<需求名称>
81
- 系统须 <规范性行为,一条或多句表述清楚>。
82
-
83
- #### 场景:<场景名称>
84
- - **当** <前置或触发条件>
85
- - **则** <预期结果>
86
-
87
- ## 变更需求
88
-
89
- ### 需求:<与既有需求同一标题>
90
- <!-- 此处放完整替换后的需求正文及全部场景 -->
91
-
92
- #### 场景:<场景名称>
93
- - **当** …
94
- - **则** …
95
-
96
- ## 移除需求
97
-
98
- ### 需求:<需求名称>
99
- **原因**:……
100
- **迁移说明**:……
101
-
102
- ## 重命名需求
103
-
104
- - **原名称:** …
105
- - **新名称:** …
106
- ```
107
-
108
- 按实际只保留需要的 `##` 分块;不需要的整块省略。
109
-
110
- ---
111
-
112
- ## 与后续工件的关系
113
-
114
- 本目录与 **`design.md`** 均完成后,方可编写 **`.apm/workitems/<requirementId>/tasks.md`**。
@@ -1,90 +0,0 @@
1
- # tasks 工件:写作说明(供 apm-propose 读取)
2
-
3
- 生成 **`tasks.md`**:把实现工作拆成**可勾选、可追踪**的条款。后续 **apm-apply-change** 依赖 **`- [ ]` / `- [x]`** 勾选推进,格式须严格遵守。
4
-
5
- **工件 DAG、单会话减少重复 Read**:见 **`.apm/skills/apm-propose/SKILL.md`**(「工件依赖」「单会话读取策略」)。
6
-
7
- ---
8
-
9
- ## 依赖(写入前须 Read 完)
10
-
11
- | 文件 | 说明 |
12
- | --- | --- |
13
- | **`.apm/workitems/<requirementId>/prd.md`** | 范围与验收 |
14
- | **`.apm/workitems/<requirementId>/proposal.md`** | 动机与能力边界 |
15
- | **`.apm/workitems/<requirementId>/design.md`** | 如何做、模块与路径 |
16
- | **`.apm/workitems/<requirementId>/specs/`** | 须做什么、需求与场景 |
17
-
18
- 若 **`design.md` 或 `specs/`**(至少一个规格文件)尚未就绪,**不得**编写 **tasks.md**。
19
-
20
- ---
21
-
22
- ## 输出路径
23
-
24
- **`.apm/workitems/<requirementId>/tasks.md`**
25
-
26
- ---
27
-
28
- ## 写作说明
29
-
30
- ### 格式(须严格遵守)
31
-
32
- - **每一条待办必须是复选框**:行首 **`- [ ]`**(半角方括号、半角空格)。**不用** `- [ ]` 的行在实现阶段**无法被可靠追踪**。
33
- - **按主题分组**:使用带序号的二级标题,例如 **`## 1. 环境准备`**、**`## 2. 核心实现`**。
34
- - **任务编号**:组内序号 **`组号.序号`**,与描述同一行,例如 **`- [ ] 1.1 初始化数据模型`**、**`- [ ] 2.1 实现导出接口`**。
35
- - **粒度**:每项宜在一次会话内能做完;过粗则拆,过细可按模块合并。
36
- - **顺序**:按**技术依赖**排列(例如契约/数据先于接口/UI)。
37
-
38
- ### 每条任务须带的元数据(缩进子列表)
39
-
40
- 紧接在 **`- [ ]` 行下方**,用无序列表写出(便于人工与 Agent 对照):
41
-
42
- | 字段 | 说明 |
43
- | --- | --- |
44
- | **需求编号** | 对应 **specs** 中 **### 需求:** 或 **#### 场景:** 的可识别标题/编号 |
45
- | **预期改动路径** | 计划修改或新增的文件/目录(可多条) |
46
- | **验证用例编号** | 可选;与测试或验收条目对应 |
47
- | **完成标准** | 可观察的完成判据(与 specs 场景可对照) |
48
-
49
- 示例:
50
-
51
- ```markdown
52
- ## 1. 数据层
53
-
54
- - [ ] 1.1 新增合同状态字段
55
- - **需求编号**:需求:合同状态同步(见 specs/contract.md)
56
- - **预期改动路径**:`servers/be/prisma/schema.prisma` …
57
- - **完成标准**:迁移可执行;已有合同默认状态正确
58
- ```
59
-
60
- ### 内容来源
61
-
62
- - **做什么、验收什么**:以 **specs** 为主,**prd** 补业务约束。
63
- - **改哪里、怎么迁**:以 **design** 为主,**预期改动路径**须与 design 中的模块划分**一致**;必要时 **SemanticSearch** 仓库以填路径。
64
-
65
- ### 可验证性
66
-
67
- 每条任务应有明确「做完」的样子;**完成标准** 应能让评审者或自己判断无需再猜。
68
-
69
- ---
70
-
71
- ## 模板示例
72
-
73
- ```markdown
74
- ## 1. <!-- 分组名称,如:准备 -->
75
-
76
- - [ ] 1.1 <!-- 简短任务说明 -->
77
- - **需求编号**:…
78
- - **预期改动路径**:…
79
- - **验证用例编号**:(可选)…
80
- - **完成标准**:…
81
-
82
- ## 2. <!-- 分组名称,如:核心实现 -->
83
-
84
- - [ ] 2.1 …
85
- - **需求编号**:…
86
- - **预期改动路径**:…
87
- - **完成标准**:…
88
- ```
89
-
90
- ---
@@ -1,99 +0,0 @@
1
- ---
2
- name: apm-refine
3
- description: 根据需求 ID 读取 prd.md 与 reviews.xml,润色为简短、可验收的业务需求文档并回写,再执行 apm refine 同步平台;当用户 @ 本技能或提出需求润色时使用。
4
- ---
5
-
6
- # APM 需求润色
7
-
8
- 用户仅提供 **需求 ID**(workitem id)。**缺 ID 时索要,不猜测。**
9
-
10
- ## 产出品质
11
-
12
- 润色后的 `prd.md` 应做到:
13
-
14
- - **可验收**:产品、测试、开发不读代码也能写用例;每条规则能对应一个测试点
15
- - **简短**:合并后删繁就简,两三分钟可通读
16
- - **业务化**:写界面、按钮、选项、场景与系统表现;材料中的技术名译为用户能懂的说法(原文要求保留的名称除外)
17
- - **分场景**:新增 / 编辑 / 审核等分开写;**暂存**与**提交**的行为、校验时机分别写清
18
- - **边界清楚**:范围写明包含与不包含;需求点内用 **「不考虑」** 标明明确排除项
19
- - **术语统一**:同一字段、按钮全文同一叫法;改名时写明界面、提示、校验文案一并调整
20
- - **结构平**:每个需求点一层 bullet(2 ~ 5 条),关键用语 **加粗**
21
-
22
- 正文骨架、需求点写法、示例与落盘自检见 **[apm-refine-template.md](./apm-refine-template.md)**。
23
-
24
- ## `reviews.xml` 格式(v2)
25
-
26
- `apm pull` 生成的 `reviews.xml` 为**行级条目**,仅含 **OPEN** 状态、且 **有 `reply` 的条目**才需要合并进正文(无 `reply` 或空 `reply` 的条目本次不处理)。
27
-
28
- ```xml
29
- <reviews>
30
- <review id="..." model="Auto" stance="frontend" memberRole="FE">
31
- <item id="..." start="44" end="55" kind="clarify" status="open">
32
- <body><![CDATA[评审正文…]]></body>
33
- <reply><![CDATA[产品已拍板口径…]]></reply>
34
- </item>
35
- </review>
36
- </reviews>
37
- ```
38
-
39
- | 属性 / 节点 | 含义 |
40
- | --------------- | --------------------------------------------------------------------------------------- |
41
- | `start` / `end` | 锚定 `prd.md` 行号(1-based,闭区间),合并时优先据此定位段落 |
42
- | `kind` | `clarify` / `difficulty` / `business`;**仅处理含非空 `reply` 的条目**(历史 `coordination` 无 reply,忽略) |
43
- | `body` | 评审意见(辅助理解,不作为正文来源) |
44
- | `reply` | 产品回复,**并入正文**的权威补充 |
45
-
46
- ## 合并原则
47
-
48
- 1. **正文 = 需求原文 + 已拍板补充**:将各 `<item>` 中非空 `reply` 并入 `prd.md` 对应行区间(或该行所在需求点);未回复的评审本次不处理。
49
- 2. **定位**:优先按 `start`–`end` 行号找到段落;行号区间与章节标题不一致时,以**业务语义**归入最近的需求点,**不要**机械插入到错误章节。
50
- 3. **冲突**:`reply` 与原文冲突时以 `reply` 为准;无 `reply` 的条目(含历史联调类)润色时忽略。
51
- 4. **同一议题只写一处**;合并后篇幅短于或接近原文。
52
- 5. **图片**:原文图片语法原样保留;理解图片后把规则写入对应需求点的文字描述。
53
-
54
- ## 执行步骤
55
-
56
- ### 步骤 1:读取材料
57
-
58
- 1. **Read** `.apm/workitems/<需求ID>/prd.md`
59
- 2. **Read** `.apm/workitems/<需求ID>/reviews.xml`(不存在则视为无评审)
60
- 3. **理解 PRD 中的图片**(有则执行):
61
- - 图片为标准 Markdown:`![描述](展示URL "相对路径")`
62
- - **优先读本地附件**:`.apm/workitems/<需求ID>/<相对路径>`
63
- - **本地不存在时**:再用展示 URL 下载后理解
64
- - 回写时保留原 `![…](… "…")` 语法不变
65
-
66
- `prd.md` 不可读 → 终止,步骤 5 注明原因。
67
-
68
- ### 步骤 2:润色
69
-
70
- **不向用户追问。** 非空 `reply` 视为已拍板补充。
71
-
72
- 1. 遍历 `reviews.xml` 中每个 `<item>`:若 `<reply>` 非空,将口径并入 `prd.md` 对应段落(参考 `start`/`end`)。
73
- 2. **Read** **[apm-refine-template.md](./apm-refine-template.md)**,按骨架组织全文。
74
- 3. 写完后按模板 **「落盘前自检」** 核对。
75
- 4. **待确认**:仅当补充信息原文含「待定」「再议」等时追加该章。
76
- 5. **局部替换**:只改涉及段落时,保留其余章节。
77
-
78
- ### 步骤 3:回写
79
-
80
- **Write** 覆盖 `.apm/workitems/<需求ID>/prd.md`。
81
-
82
- ### 步骤 4:同步
83
-
84
- 仓库根目录执行:`apm refine <需求ID>`
85
-
86
- (平台会将旧正文追加到 `contentHistory`,并将全部 OPEN 评审标为已解决;侧栏不再展示这些条目。)
87
-
88
- ### 步骤 5:回复用户
89
-
90
- **仅**输出一张状态表,表格外无其他文字:
91
-
92
- | 步骤 | 状态 |
93
- | --------------------------------- | ---- |
94
- | 1. 读取 `prd.md` 与 `reviews.xml` | |
95
- | 2. 润色为「标准需求文档」 | |
96
- | 3. 回写 `prd.md` | |
97
- | 4. 执行 `apm refine <需求ID>` | |
98
-
99
- 状态:**成功** / **失败** / **跳过**(失败可加简短原因)。