docs: refine PRD draft layering rules

This commit is contained in:
2026-05-15 16:42:38 +08:00
parent 5cb99eb8e6
commit 629dbc05a4
3 changed files with 264 additions and 18 deletions

View File

@@ -18,11 +18,49 @@
- 文档路径和文件名优先沿用项目既有约定;没有约定时,由用户确认目标路径。
- 一个需求文档应描述一个清晰业务主题;主题过宽时先建议拆分。
- 标题、元信息、章节结构优先沿用项目模板;没有模板时,使用 `prd-draft-format-template.md` 的通用骨架。
- 标题、元信息、章节结构优先沿用项目模板;没有模板时,按文档类型使用 `prd-draft-format-template.md`整篇文档模板或通用骨架。
- 不为了套模板创建空章节、空表格、伪造对象或重复内容。
- 不把同一批数据项、规则或流程在多个章节中重复抄写。
- 未确认事项必须保留在相关需求语境中,标记为 `需补``待确认`
## 草案包结构
- 当项目使用 `.ai-transition/prd-draft` 作为需求草案过渡区,且用户未指定具体文件时,复杂需求默认按业务能力域和需求主题组织为草案包:
```text
.ai-transition/prd-draft/<capability-domain>/<slug>/
<topic-slug>-prd.md
decisions.md
acceptance.md
references/
```
- `<capability-domain>` 表示业务能力域或协议域,例如 `order``workflow``integration``notification`;不得用来源项目名、语言、框架、技术层或具体技术组件命名。
- `<slug>` 表示需求主题,使用小写英文、数字和短横线;不得使用 `new-feature``misc``test` 等泛名。
- `<topic-slug>-prd.md` 是唯一主需求草案;文件名必须包含业务主题,目录名过宽时使用更具体的业务短横线名,例如 `erp-integration-prd.md`。如果用户明确提供单个文件路径,则该文件继续作为锚点,不强制迁移为草案包。
- `references/` 用于存放外部协议、客户材料、历史说明、性能建议、接口草稿、来源摘录等强依赖参考材料;材料必须脱敏、裁剪或摘要化,不得只保留本机绝对路径。性能或优化建议可摘要为 `./references/performance-notes.md`
- `decisions.md` 用于记录确认结论、冲突、取舍、待确认事项和覆盖记录;不得扩写成技术设计、实现计划或任务拆解。
- `acceptance.md` 用于记录验收补充和边界补充;简单需求可以保持为“以主草案为准”,不得重复扩写主需求。
- 默认不创建 `flows/``rules/` 等额外目录;只有主草案明显过长、辅助文档能减少重复或用户明确要求拆分时,才在同一草案包内新增辅助文档。
- 主草案内的关联材料必须使用相对主草案的路径,例如 `./references/external-protocol.md`;不得在正文中写用户机器绝对路径。
## 文档类型
- 需求以触发、步骤、链路、状态流转、分支异常为核心时,优先写成流程文档。
- 需求以适用对象、执行约束、交付约束、验收约束、禁止事项为核心时,优先写成要求文档。
- 流程文档必须能看出从触发到结果的完整链路;要求文档必须能看出每条规则是否可执行、可判断、可验收。
- 选择模板时只使用抽象占位和用户已确认信息,不带入具体业务、具体页面、具体模块或未经确认的示例。
- 项目已有同类文档风格时,优先沿用项目风格,不强行改成通用骨架。
## 文档引用
- 用户提供的本机路径或项目内路径只用于定位文件;写入 PRD 正文时必须转成可迁移引用。
- `关联协议``关联主流程``关联文档``参考文档` 等引用优先使用相对当前文档的路径;同目录写成 `./xxx.md`,上级或兄弟目录写成 `../xxx/yyy.md`
- Markdown 正文路径使用 `/` 分隔,不使用 Windows `\` 分隔。
- 不把 `C:\...``D:\...``/Users/...``/home/...` 等用户机器绝对路径写入 PRD 正文。
- 除非项目规范明确要求,不从项目根目录写路径;需要脱离项目目录共享时,优先写“同目录《文档标题》”或相对当前文档的短路径。
- 检查或更新既有文档时,发现不可迁移引用路径,应作为 `建议修正` 给出相对当前文档的替代写法。
## 需求表达
- 用业务语言描述需求:目标、参与方、触发条件、输入、处理规则、输出、状态、边界、异常、权限和生命周期。
@@ -30,8 +68,13 @@
- 表、字段、列、属性、model、struct 转为业务数据对象和数据项。
- API、Service、任务、队列、缓存、页面组件 转为业务能力、流程、交互、集成或展示需求。
- 索引、唯一约束、字段类型、请求响应结构 转为业务唯一性、校验规则、数据含义或交互约束。
- 外部非业务方案应转译为业务约束或参考材料:例如“用 Redis 解决性能问题”只可在 `references/``decisions.md` 中作为来源背景,在主草案中应表达为响应时限、高峰期可用性、一致性、重复提交处理等可验收业务要求。
- 业务逻辑方案不等同于技术方案。凡是在定义业务判定口径、触发和结束边界、状态有效性、分支结果、异常归类或验收标准的内容,必须写入主草案,不能下放给下游技术方案自由定义。
- 技术实现方案必须从业务规则中剥离。具体中间件、缓存、队列、索引、部署形态、服务内存状态、任务调度、代码结构等,只能作为参考来源、决策背景或待下游设计处理。
- 如果同一段方案同时包含业务逻辑和实现建议,应拆分记录:主草案保留业务判定和结果约束,`decisions.md` 记录已确认取舍,`references/` 保存实现建议或性能建议摘要。
- 如果某个技术名词本身就是项目通用业务术语,可以保留术语,但不要扩展成实现设计。
- 备选方案只能写成备选或待确认,不写成已确认结论。
- 同一轮编辑、同一次未提交 diff 或同一轮对话推演中,临时方案被提出后又被否定时,不写入正文作为“不要”“不支持”“取消”等否定事实;正文只保留最终确认需求。只有该方案已经出现在已提交、已确认、已评审或已对外同步的基线版本中,或确实需要声明范围边界以防需求外溢时,才写入变更说明、范围外或决策记录。
## 数据表达
@@ -56,8 +99,12 @@
- 完整性:目标、范围、参与方、触发、输入、处理、输出、权限、边界、异常、状态和生命周期是否齐全。
- 闭环:用户或系统从触发到结果是否能走通;成功、失败、取消、重复、历史数据和异常中断是否有合理结果。
- 数据:业务数据对象、数据项、来源、生成规则、使用场景、值域和状态是否完整。
- 文档类型:流程文档是否突出完整链路,要求文档是否突出可执行约束,是否错误套用了不适合的通用骨架。
- 草案包:复杂需求是否把主需求、参考材料、决策和验收补充分清;`<topic-slug>-prd.md` 是否仍是唯一主草案。
- 分层:业务逻辑方案是否进入主草案,技术实现方案是否已转译为业务约束或放入参考材料和决策背景。
- 合理性:是否符合主流产品习惯、正规业务流程、行业常识、权限常识和最小必要复杂度。
- 复用:是否已检查既有资产,是否误写成新增表、新增接口、新增页面或新增模块。
- 引用:关联协议、关联主流程、关联文档或参考文档是否使用可迁移引用,是否避免用户机器绝对路径和项目根目录绑定路径。
- 边界:是否遗漏空数据、重复提交、并发、撤销、回退、历史兼容、不可见、无权限和生命周期结束场景。
- 未确认项:是否还存在阻塞进入下一阶段的 `需补``待确认`、事实冲突或未闭环事项。
- 越界项:是否混入 API 路径、请求响应结构、SQL、字段类型、类名、文件结构、任务拆解或代码实现。
@@ -91,6 +138,8 @@
- 禁止为了套模板编造业务对象、数据项、字段清单、状态值、字典值或空章节。
- 禁止把未确认事项写成确定结论。
- 禁止把用户的功能需求在未检查既有资产前直接推导为新建表、新增接口、新建页面或新模块。
- 禁止把用户机器绝对路径或不必要的项目根目录绑定路径写成 PRD 正文中的关联文档引用。
- 禁止把 Redis、MQ、缓存、索引、分库分表、异步任务、服务部署等实现或性能方案写成 PRD 的确定实现要求;需求草案只能保留其业务目标、约束、验收口径或参考来源。
## 模板