Files
xas-skills/skills/erp-requirements-design/references/prd-style.md
T

77 lines
5.6 KiB
Markdown

# PRD 结构与表达规范
本规范适用于本技能生成的中文业务评审稿。用户提供模板或提出其他明确格式要求时优先;局部修订不自动扩大为整篇改版。
## 文档结构
从“主标题、版本记录表、业务正文”开始。版本记录位于最前,不在标题下重复副标题及版本、日期、状态说明行。版本表为“版本、修订日期、修订内容”,每个版本一行,版本及日期取真实记录。
| 章节 | 核心内容 | 适合的表达方式 |
|---|---|---|
| 背景与目标 | 背景、目标、本期边界及完成标准 | 简洁段落,必要时列范围表 |
| 现状及预期效果 | 业务环节的变化与预期改善 | 环节对照表、功能建设清单 |
| 整体流程 | 角色衔接及关键分支 | 泳道图或流程图及文字说明 |
| 详细需求 | 页面、字段、操作及异常 | 按页面展开,结合示意、字段及操作表 |
| 权限与状态规则 | 角色范围、状态及关键规则 | 权限矩阵、状态图或必要的状态表 |
| 验收与上线要求 | 完成标准、异常及切换验证 | 场景、前置条件与操作、预期结果 |
| 评审确认事项 | 未决事项、责任与影响 | 事项名称、建议方案、确认责任及影响 |
现状尚未核实时采用“已明确的管理诉求”对照,不为填表编造现行流程。新增功能标明“本期新增”,未复核的既有能力写“拟复用,适配范围待核实”。
## 标题与正文
业务章节采用 `1`、`1.1`、`1.1.1`,不与中文序号混排,不为凑三级标题机械拆分。Word 使用对应标题样式和提纲级别,不只加粗普通段落。
| 口语表述 | 正式表述示例 |
|---|---|
| 为什么要做 | 业务背景、建设目标 |
| 这个功能要解决什么问题 | 项目概述、背景与目标 |
| 谁来审批 | 审批人员与节点配置 |
| 怎么填写、从哪里申请 | 表单字段与校验、申请入口与提交规则 |
| 出问题怎么办 | 异常处理、失败恢复 |
| 需要谁拍板 | 待确认事项、确认责任 |
| 看看有没有办完 | 办理状态、完成标准、验收要求 |
正文及表格也使用正式而具体的表述,例如“审批通过后生成待办,由有权限的管理员领取;登记实际办理结果后记为已完成”。不要只替换标题而保留口语,也不要用空泛术语代替业务动作。
功能用业务名称,如“供应商准入申请”;验收用场景名称,如“审批人员失效”“取消与办理并发”。交叉定位使用名称或章节号,默认不引入技术式标识及编号追踪矩阵。
## 页面需求的写法
按“建设方式、入口与角色、页面内容、操作与结果、异常与权限”展开。例:
**4.3 资格核对**
建设方式:本期新增,审批结果拟复用审批中心。入口:采购中心下的业务模块,具体层级须根据该业务确认。使用角色:获授权的资格核对人员。
审批通过后形成核对待办。核对人员查看批准版本及允许访问的附件,登记核对结果;核对通过并执行启用后,供应商状态变为已启用。审批通过本身不构成启用完成。处理结果不明时先核实原记录,不重复创建供应商。
此例仅说明描述粒度,不是其他模块的默认菜单或确认规则。实际文档应将已确认入口写成完整路径,并补齐字段和异常要求。
## 图表与示例
- 跨角色主流程使用泳道图,判断节点标明条件和结果,动作与对应角色一致。
- 新建页面用低保真示意展示信息分区、关键字段和按钮,标注“拟建页面/非现有界面”。正文保留字段和操作条件。
- 现有截图注明环境、日期和观察范围;只参考表达风格时,不移用其中的业务规则、数据、人员或链接。
- 状态或异常图承担必要解释,不重复制作同义图。保留文字流程,便于图片无法显示时理解。
- 对比、字段、状态和验收等重复结构使用表格;长段规则使用正文,避免挤入窄列。设置合理列宽和跨页表头。
- 示例注明虚构,覆盖关键判断;时间、金额、数量与正文一致,不以示例暗定限制。
## 评审稿与工作记录
交付稿围绕业务背景、目标、规则及待决事项,不默认附带“参考了哪些资料”、工具过程或“本轮未访问哪些页面”等编制过程章节。资料路径、读取时间和观察证据留在工作记录,按需可追溯。
仍须准确表达业务事实:拟建图标为示意,未确认权限和审批层级保留待定,未验证能力不写成已支持,验收条件不写成已通过。用户要求来源说明时另行添加,不能为精简隐瞒影响业务判断的限制。
## 菜单与档案检查
成稿前应能明确回答:
1. 一级菜单、二级模块和三级页面分别是什么;哪些属于详情页或申请类型而非导航菜单。
2. 申请、审批、办理和资料维护各从哪个完整路径进入;不同入口是否对应同一单据。
3. 父级和子菜单可见性如何授予,是否会扩大其他功能或数据权限。
4. 基础档案由谁建立、从哪里维护,人工录入、导入或同步的方式是否已确认。
5. 识别信息、负责人和系统账号如何关联,变更、停用及历史记录如何处理。
内部群管理归属行政中心是该模块的已确认决策,不是其他业务的默认归属。未决菜单需给出有依据的建议及影响;确认后同步所有引用,移除相应的“归属待确认”表述。