Skip to content

内容沉淀规则

本规范约束以后 Codex、开发、产品、运营在项目中如何沉淀功能文档。

什么时候必须更新知识库

场景是否必须更新最小更新范围
新增功能必须功能说明、运营说明、上线记录
改业务规则必须核心规则、异常处理、上线记录
改客户可见流程必须客户说明、客服口径、上线记录
改运营配置必须配置说明、影响范围、回滚方式
修复小 Bug视情况上线记录
纯样式调整视情况影响运营使用时记录

一篇功能文档的标准结构

  1. 功能摘要
  2. 业务背景
  3. 使用角色
  4. 入口位置
  5. 主流程
  6. 状态流转
  7. 核心规则
  8. 异常处理
  9. 运营配合事项
  10. 客户可读说明
  11. 验收标准
  12. 上线和回滚

三种受众版本

版本写给谁重点禁止内容
产品版产品负责人规则、边界、状态、验收空泛价值描述
运营版运营、客服、财务怎么操作、怎么判断、异常怎么办内部实现细节
客户版客户、销售、客服外发服务流程、权益、限制、下一步内部系统名、失败原因、配置细节

语言规则

  • 使用业务语言,不把内部代号直接丢给运营。
  • 每个状态都要说明触发条件和运营解释。
  • 每个配置都要说明默认值、生效时间和回滚方式。
  • 客户版只解释客户能感知的结果,不解释内部失败细节。
  • 涉及金额、分润、钱包、保险、支付时,必须写清楚数据来源和口径。

Codex 执行要求

当新增功能或较大规则调整完成时,交付前必须检查:

  • 是否需要新增或更新 docs-kb 文档。
  • 是否需要更新对应系统的变更记录。
  • 是否有客户可见变化。
  • 是否有运营配置或培训事项。
  • 是否有上线、回滚、审核或发布节奏要求。

用于金刚项目内部协作、运营培训和客户说明。