产品文档改版后,旧文章里的引用是否要更新,取决于该引用是否承担“把读者送到正确下一步”的功能。承担导航、参数解释、操作前置条件的引用必须改;仅作为背景出处、且原文仍可独立理解的引用可以暂缓。判断依据不是链接数量,而是引用失效后读者会不会走错路。
导航型引用指向具体操作步骤、参数定义、版本说明、限制条件或配置入口。产品文档改版后,这类目标常被合并、改名或迁移,读者点过去若落到新页面却找不到原段落,就会中断任务。背景型引用只是说明某个概念来自哪里,或指向一段仍能自洽的说明,读者不点也能继续读。
取舍条件可以这样定:如果旧文章的核心结论依赖被引用内容才能成立,就归为导航型,必须更新;如果删掉引用后旧文章仍然完整,且没有操作风险,就归为背景型,可以排到低优先级。代价是导航型更新更费时,需要逐条核对目标页面的新结构;背景型暂缓的代价是可能留下少量过时出处,但不会直接误导操作。
把旧文章里的引用逐条问一句:读者点进去之后,下一步要做什么?如果答案是“照着做配置”“确认参数含义”“找到新版限制”,那它影响任务完成,优先改。如果答案是“了解背景”“看延伸阅读”,可以后置。
假设一篇旧文章写的是“先按某文档完成初始化,再回到本文继续”,而产品文档改版后初始化步骤被拆成两个页面。此时只把链接指向新首页不够,读者会在新首页再次迷路。实际动作是:把引用改成指向拆分后的第一步,并在旧文章里补一句“完成第一步后回到本节”。这个动作的结果是读者路径重新闭合,下一步才不需要额外搜索。
有时链接能打开,页面标题也没变,但段落位置、参数默认值或前置条件已经变了。这种情况下,仅检查链接是否返回成功会漏掉问题。反例是:旧文章引用“默认开启某选项”,改版后该选项默认关闭,页面仍存在,链接也正常,但读者按旧文章操作会得到不同结果。
因此,链接可达不能单独证明引用正确。还要看被引用内容是否仍是旧文章结论的前提。若前提变了,即使链接没坏,也要更新文字说明或调整引用位置。
完成上述动作后,再抽查几篇旧文章,看读者能否在不搜索的情况下从旧文走到新版文档并继续任务。若仍需要额外搜索,说明引用更新还没到位。
如果产品文档改版只调整了视觉样式、导航位置或页面标题,而段落语义、参数默认值和操作顺序都没变,那么旧文章引用可以暂缓批量更新。适用条件是:旧文章不依赖具体页面路径,只依赖概念说明;且读者通过站内搜索仍能找到新位置。此时先处理导航型引用,比全量替换链接更划算。
下一步动作是:先改承担操作前置条件的引用,再观察读者是否仍在旧文章与新文档之间反复跳转;若跳转减少,再处理背景型引用。