Files

64 lines
5.1 KiB
Markdown
Raw Permalink Normal View History

2026-10-27 19:29:36 +08:00
# PRD 结构与表达规范
默认交付简洁的业务评审稿。用户指定的结构、字段和详细程度优先;局部修改不触发全文扩写。
2026-10-27 19:29:36 +08:00
## 简版结构
2026-10-27 19:29:36 +08:00
文首为“主标题 → 版本记录表”,表头为“版本、修订日期、修订内容”,每个版本一行。正文按下列结构裁剪,无内容的章节直接省略。
2026-10-27 19:29:36 +08:00
| 章节 | 保留内容 | 建议表达 |
2026-10-27 19:29:36 +08:00
|---|---|---|
| 背景与目标 | 解决什么问题、本期做什么 | 一至两段,不重复拆背景、目标、范围 |
| 整体流程 | 角色、顺序、完成标志 | 一条文字流程或一张紧凑主流程图 |
| 功能需求 | 入口、必要字段、主要操作和结果 | 按实际页面分节,配必要的短表 |
| 权限与办理规则 | 查看及办理范围、变更、异常与进度 | 短段落或合并规则,不穷举组合 |
| 验收与上线 | 核心场景、预期结果、准备工作 | 两列表格及简短上线说明 |
| 评审确认事项 | 影响定稿的真实未决问题及责任人 | 短表或列表,已确认事项移出 |
2026-10-27 19:29:36 +08:00
现状对比、功能建设清单、统计口径、详细状态表、用例图、页面示意均按需要加入,不是必填章节。不为填表编造现状。篇幅随业务复杂度确定,不把某次四页文档或六项验收当作固定指标。
2026-10-27 19:29:36 +08:00
## 内容粒度
2026-10-27 19:29:36 +08:00
每个功能回答“在哪里、谁使用、做什么、结果是什么”。影响操作的条件在对应句子或字段旁说明;不要为每个功能再建一套前置条件、权限、异常、日志及验收子章节。
2026-10-27 19:29:36 +08:00
| 内容 | 简版写法 | 需要展开的条件 |
|---|---|---|
| 菜单 | 共同父级路径写一次,列页面与用途;跨模块入口补完整路径 | 菜单归属或不同角色入口存在实际分歧 |
| 基础资料 | 维护人、建档方式及必要字段;少量字段直接一句列出 | 导入、同步、资源变更等属于本期明确需求 |
| 表单 | “信息|填写要求”,相关字段合并为一组 | 字段单位、金额门槛、条件附件会改变业务结果 |
| 权限 | 按角色说明可见及可办理范围 | 涉及跨组织数据、金额或敏感对象的差异权限 |
| 异常 | 合并说明取消、核实、补登记等业务处理原则 | 部分履约、冲销、退款等存在不同后果 |
| 验收 | “验收场景|预期结果”,同类操作合并 | 用户要求测试方案,或前置条件会改变预期结果 |
2026-10-27 19:29:36 +08:00
详细规格按用户指定的章节展开;数量、金额、库存、审批和权限等关键约束按实际业务补齐。不要由一个复杂环节带动所有章节扩写。
2026-10-27 19:29:36 +08:00
## 字段与语言示例
2026-10-27 19:29:36 +08:00
采用业务人员熟悉的词,能说“人员范围”就不写“受众”。字段来源、只读状态、字符数、系统标识及账号绑定只在影响业务办理时写,不为普通资料维护自动补齐这些说明。
2026-10-27 19:29:36 +08:00
例如用户已确认渠道档案字段时,可直接写:
2026-10-27 19:29:36 +08:00
> 业务管理员在“通知渠道”人工建档。群聊记录群名称、人员范围和群主;公共邮箱记录邮箱名称、发件地址和发送负责人。
2026-10-27 19:29:36 +08:00
这段说明用于示范字段取舍,不代表所有通知业务都用同一字段集。用户指定“只保留”的清单按其原意执行,不自动补回平台、群 ID、用途、账号关联或凭据管理等细节,也不移到验收或待确认事项中。
2026-10-27 19:29:36 +08:00
正文采用正式、直接的业务表达,如“审批通过后生成待办,由负责人办理并登记结果”。标题使用“背景与目标、申请、审批、发送与回执”等具体名称,通常保留两级标题;不机械拆成三级。
2026-10-27 19:29:36 +08:00
功能、规则和验收用业务名称定位,默认不引入技术式编号。重要规则集中说明,验收只写结果,不再复述完整规则。
2026-10-27 19:29:36 +08:00
## 图示与示例
2026-10-27 19:29:36 +08:00
- 图用于解释角色衔接或不易理解的页面;一张主流程图已能说明时,不重复增加同义图或逐步骤示例表。
- 用例图用于集中展示主要角色与核心功能,流程图用于说明办理顺序。需要概览角色职责时增加用例图;已有流程图或角色表能清楚表达时省略,不设为必备图示。
- 页面示意标注“拟建页面/非现有界面”;实站截图注明环境和观察日期,不能把图上的字段、数量或状态当作行为验证。
- 虚构例子明确标注,不通过样例设定未知限额;金额和时间计算用确定性方法核对。
- 表格适合菜单、字段、角色和验收的并列信息;长说明用正文。删节靠减少重复和合并内容,不靠缩小字号或挤压行距。
2026-10-27 19:29:36 +08:00
## 修改和交付前核对
2026-10-27 19:29:36 +08:00
先读当前维护稿及用户最新修改,保留已确认的范围和删节决定。将同类细节从模板提示中移除后再生成,避免 Word、Markdown 或图示把它们恢复。
2026-10-27 19:29:36 +08:00
业务事实和证据边界保留在相关句子旁:建议不写成定论、拟建不写成已实现、待验收不写成已通过。正文不额外添加工具过程、资料清单或泛化安全说明。
2026-10-27 19:29:36 +08:00
最后通读:主流程能否贯通,字段是否必要,同一规则是否写了多次,常见异常是否可合并,关键约束和真正未决问题是否仍然清楚。