产品文档改版后,旧文章里需要更新的引用,不是所有提到旧版的地方,而是那些会让读者做出错误操作、或让多个角色对同一事实产生不同理解的引用。判断标准可以落到一个动作上:打开旧文章,逐条标记每个指向产品行为的句子,然后对照新版文档确认它是否仍然成立。成立就保留,不成立就更新或删除。下面用一个假设情境说明这个决策过程。
假设某团队把产品的数据导出路径从“设置—导出”改成了“数据管理—导出任务”,同时把导出的文件格式从 CSV 改为 CSV 与 JSON 二选一。旧文章里可能出现三类引用:
把这三类分开后,更新工作量会明显下降。很多旧文章的问题不是“整篇过时”,而是操作路径引用集中失效,而概念部分仍然可用。
多个角色对“哪句需要改”有不同理解时,争论往往停留在印象层面。可以把它转成一张核对清单,每个条目只回答一个是非问题:
前三个问题回答“是”,第四个问题才需要进一步确认。第四个问题回答“是”的条目,才进入更新队列。这个清单的作用不是替代判断,而是让不同角色在同一组事实上讨论,而不是各自凭记忆争论。
假设有 12 篇旧文章都提到了导出功能。改版后,团队先做了一次核对,结果大致如下:
这个分配说明:需要更新的不是“所有提到导出的文章”,而是“读者会照着做、且照着做会失败的文章”。先处理这 4 篇,再处理需要确认的 2 篇,其余暂缓。这个顺序也影响下一步:如果优先更新的 4 篇里出现同一句旧路径,可以统一替换;如果每篇写法不同,则需要逐篇核对,不能批量替换。
更新旧文章时,常见的动作是把旧路径直接换成新路径。这个动作本身没错,但要注意两个边界:
一个实际动作是:在更新每一篇时,先记录“这次改了什么”,再记录“还有什么没确认”。前者用于避免重复劳动,后者用于安排下一轮核对。这个记录不需要复杂格式,只要能区分“已确认失效”和“待确认”即可。
不是所有旧文章都值得更新。如果一篇旧文章的引用属于概念或背景,且新版没有改变相关行为,那么保留它不会让读者做错事。此时更新的收益很低,反而可能引入新的表述差异。判断条件可以简化为:读者按这篇文章操作,是否会得到与新版文档不一致的结果?如果答案是否定的,就可以先不动。
反过来,如果多个角色对同一句话是否过时存在分歧,最有效的做法不是继续讨论,而是打开新版文档,找到对应位置,核对这句话描述的行为是否仍然存在。核对结果本身就是决定下一步的依据:成立就关闭,不成立就进入更新队列。