Appearance
内容沉淀规则
本规范约束以后 Codex、开发、产品、运营在项目中如何沉淀功能文档。
什么时候必须更新知识库
| 场景 | 是否必须更新 | 最小更新范围 |
|---|---|---|
| 新增功能 | 必须 | 功能说明、运营说明、上线记录 |
| 改业务规则 | 必须 | 核心规则、异常处理、上线记录 |
| 改客户可见流程 | 必须 | 客户说明、客服口径、上线记录 |
| 改运营配置 | 必须 | 配置说明、影响范围、回滚方式 |
| 修复小 Bug | 视情况 | 上线记录 |
| 纯样式调整 | 视情况 | 影响运营使用时记录 |
一篇功能文档的标准结构
- 功能摘要
- 业务背景
- 使用角色
- 入口位置
- 主流程
- 状态流转
- 核心规则
- 异常处理
- 运营配合事项
- 客户可读说明
- 验收标准
- 上线和回滚
三种受众版本
| 版本 | 写给谁 | 重点 | 禁止内容 |
|---|---|---|---|
| 产品版 | 产品负责人 | 规则、边界、状态、验收 | 空泛价值描述 |
| 运营版 | 运营、客服、财务 | 怎么操作、怎么判断、异常怎么办 | 内部实现细节 |
| 客户版 | 客户、销售、客服外发 | 服务流程、权益、限制、下一步 | 内部系统名、失败原因、配置细节 |
语言规则
- 使用业务语言,不把内部代号直接丢给运营。
- 每个状态都要说明触发条件和运营解释。
- 每个配置都要说明默认值、生效时间和回滚方式。
- 客户版只解释客户能感知的结果,不解释内部失败细节。
- 涉及金额、分润、钱包、保险、支付时,必须写清楚数据来源和口径。
Codex 执行要求
当新增功能或较大规则调整完成时,交付前必须检查:
- 是否需要新增或更新
docs-kb文档。 - 是否需要更新对应系统的变更记录。
- 是否有客户可见变化。
- 是否有运营配置或培训事项。
- 是否有上线、回滚、审核或发布节奏要求。