ai-project-manage-cli 7.0.9 → 7.1.2

package/template/skills/apm-write-prd/template.md

@@ -0,0 +1,134 @@
+## 需求模板
+
+### 图示原则
+
+信息量保持完整，**文字与图示互补**：bullet 写清可验收细节，图示帮助读者快速建立整体印象。优先用 **Mermaid**（Markdown 内嵌，无需额外图片文件）。
+
+| 场景                                        | 推荐图示                         | 作用                       |
+| ------------------------------------------- | -------------------------------- | -------------------------- |
+| 多步骤操作流程（审批、暂存/提交、办理路径） | `flowchart`                      | 一眼看清先后与分支         |
+| 字段展示/必填随状态变化                     | `flowchart` 或 `stateDiagram-v2` | 替代「当 A 且 B 时…」长句  |
+| 弹窗/页面内区块与按钮布局                   | `block-beta` 或 ASCII 框图       | 标出按钮位置与对照关系     |
+| 多需求点关系、范围边界                      | `mindmap` 或简表                 | 开篇总览，再展开 bullet    |
+| 角色与系统交互时序                          | `sequenceDiagram`                | 仅步骤多、文字难扫读时使用 |
+
+**图示写法**：
+
+- 每个需求点 **0 ～ 1 张** 图即可；一张图只表达一个核心概念，节点用业务语言（如「一级审批」「暂存」）。
+- 图 **不替代** bullet：图后仍保留 2 ～ 5 条可验收 bullet，图中未写清的细节（文案、边界、校验时机）必须在文字中写明。
+- 图为辅助：若单条 bullet 已足够清楚，**不必强行配图**。
+
+### 正文骨架
+
+```markdown
+## 背景
+
+（1 ～ 3 句：业务背景、要解决的问题、预期效果，如果没有可空着，不要强行编）
+
+## 范围
+
+- **包含**：…
+- **不包含**：…
+
+（可选：范围较大时，用 mindmap 或简表做一页总览）
+
+## 需求说明
+
+### 需求点 1：[简短名称]
+
+（可选：流程/状态/布局类需求，在此放一张 Mermaid 图）
+
+- …
+- …
+
+### 需求点 2：…
+```
+
+### 需求点编写规范
+
+每条 bullet 写清一个可验收点，优先覆盖：
+
+| 类型      | 写法要点                                               |
+| --------- | ------------------------------------------------------ |
+| 展示/选项 | 展示或隐藏；保留/去掉哪些选项；新建默认值              |
+| 文案      | 原名称 → 新名称；界面、提示、校验文案一并统一          |
+| 按钮      | 场景 + 按钮名 + 行为（对照哪个既有按钮、是否仅改文案） |
+| 校验      | 场景 + 字段展示条件 + 必填时机（暂存 / 提交分别怎样）  |
+| 边界      | **不考虑** …（历史数据、迁移、导出等明确排除项）       |
+
+材料中的技术名可译为业务表述，例如：`audit1` → 一级审批；保存不推进流程 → **暂存**；办理并推进流程 → **提交**。
+
+编写示例如下：
+
+```markdown
+### 需求点 2：新增/编辑弹窗底部操作
+
+- 在**新增、编辑**场景下，弹窗底部新增 **「暂存」** 按钮。
+- **「暂存」**：沿用原 **「确定」** 按钮的业务逻辑（含校验与保存/流程行为），**仅将按钮展示文案改为「暂存」**。
+
+### 需求点 3：「科室医德考评小组人员名单」字段
+
+（本需求点适合在 bullet 前加「字段展示与校验」流程图，见下方「图示示例」）
+
+- 原字段展示名 **「科室医德考评人员名单」** 统一改为 **「科室医德考评小组人员名单」**；凡界面、提示、校验文案等涉及该名称处**一并修改**。
+- 当流程处于 **一级审批** 且该字段**展示**时，须校验为**必填**（在展示场景下触发，而非所有保存入口一律校验）。
+```
+
+### 图示示例（按需选用）
+
+**字段展示与校验**（对应上文需求点 3）：
+
+```mermaid
+flowchart LR
+  A[进入表单] --> B{流程处于一级审批?}
+  B -->|是| C[展示该字段]
+  B -->|否| D[按原规则展示/隐藏]
+  C --> E{用户操作}
+  E -->|暂存或提交| F[校验必填]
+  E -->|仅浏览未保存| G[不触发必填校验]
+```
+
+**流程分支**（暂存 vs 提交、审批节点）：
+
+```mermaid
+flowchart TD
+  A[用户打开新增/编辑弹窗] --> B[填写表单]
+  B --> C{点击底部按钮}
+  C -->|暂存| D[沿用原「确定」逻辑：校验 + 保存，不推进流程]
+  C -->|提交| E[沿用原「办理」逻辑：校验 + 保存并推进流程]
+```
+
+**弹窗底部按钮布局**（对照既有按钮）：
+
+```text
+┌─────────────────────────────────────┐
+│           新增 / 编辑弹窗            │
+│  …表单字段…                          │
+├─────────────────────────────────────┤
+│              [ 取消 ]  [ 暂存 ]       │  ← 暂存：原「确定」逻辑，仅改文案
+└─────────────────────────────────────┘
+```
+
+**范围总览**（需求点较多时，放在「范围」之后）：
+
+```mermaid
+mindmap
+  root((本需求))
+    包含
+      弹窗底部操作
+      字段更名与校验
+    不包含
+      历史数据迁移
+      导出能力
+```
+
+### 自检列表
+
+- [ ] 含 **背景与目标、范围、需求说明** 三章，叙述完整
+- [ ] 2 分钟内可通读；每个需求点 2 ～ 5 条 bullet，一层列表
+- [ ] 流程/状态/多分支类需求点有 **图示或简表** 辅助，且 bullet 仍覆盖图中未写清的细节
+- [ ] 图示节点使用业务语言，与正文术语一致；无仅看图无法验收的遗漏
+- [ ] 场景、按钮行为、校验时机表述清楚，前后一致
+- [ ] 「范围」与需求点中的 **「不考虑」** 口径一致
+- [ ] 全文使用业务语言，术语统一
+- [ ] 仅材料明确涉及时才有「非功能」「待确认」