记录用户会遇到的变化
从读者可使用的功能开始写,交代首次可用的版本、启用方式和默认行为。给出最小示例和可观察结果。已有功能发生变化时,把新行为更新到功能页、API 参考和相关示例。
变更记录负责提供版本和影响范围,操作细节放在功能页。需要用户主动修改配置、代码或部署方式时,用升级指南给出迁移步骤。
标注实验条件
在首次介绍实验功能时写出实验状态、启用开关和已知限制。说明停用后会发生什么,以及生成的数据或配置是否需要清理。功能转为稳定时,核对默认值、配置和示例,把旧的状态说明更新到当前版本。
随功能准备示例和入口
以新增“按标题查找”选项为例,功能指南先说明从哪个版本开始支持。配置参考显示实际键名、类型和默认值。示例在同一组数据上给出输入以及能搜索到的标题。使用范围有限时,在入口简介和第一步前就说明条件。