用问题定义改动
记录当前缺口、受影响的读者和完成标准。例如,“启用离线索引的读者无法确认构建产物”可以用一张输出文件表和一段验证步骤解决。已有页面能承接这个问题时,在该页补齐与读者任务紧邻的信息。需要单独定位或多次引用的内容适合新建页面。
先确定一个可以交付的范围。跨版本重写时,可以先整理当前稳定版的安装步骤,再补旧版本迁移。这样每次提交都能独立检查,后续修改也能找到基准。
核对来源与事实
写行为时,先对照项目代码、测试、发布记录或实际界面。记录验证所用的版本、提交或环境。代码实现和现有文档描述不一致时,留下一条可复现的差异记录,再与维护者确认哪个行为是该版本对用户的承诺。
依据上游参考改写时,把来源放在句中能说明目标的关键词上。涉及版本和翻译进度时,按上游差异核对流程记录原文和中文页的基准。
交付可复现的正文
先写标题、摘要和验证结果,再按读者操作的顺序补正文。完成初稿后,在干净环境中按自己的步骤走一遍。在预览中检查标题顺序、锚点、代码复制和窄屏表格。读者从站外直接进入小节时,也应能找到前置条件。
提交时记录检验过的场景和环境。可用模板与检查项起草,再按审阅清单核对本次改动。
发布后核对入口
发布后从站点导航和旧链接各打开一次受影响的页面。新增配置字段时,回看同版本的参考和示例。计划移除过期文档时,先找出常用的旧地址、对应的新内容以及所属版本,再安排旧地址与弃用说明。