产品文档改版后,旧文章里的引用不是全部都要改,也不是只改链接就行。判断标准是:这条引用是否还指向读者能继续使用的对象,以及它在新文档结构里是否已经换了位置、名称或前提。下面用一个假设情境说明取舍。
假设某团队把一份“账户配置”总文档拆成三篇:权限说明、通知设置、数据导出。旧文章里原本都指向总文档同一节,现在这个锚点已经不存在。此时旧文章中的引用大致分成三类,处理方式不同。
把这三类分开,能避免两种常见错误:一是把所有引用统一替换成新首页,读者仍然不知道下一步;二是看到旧链接就整段删除,连带把仍然成立的操作说明也删掉。
入口型引用告诉读者“去哪里操作”,依据型引用告诉读者“为什么这样做”或“这个结论从哪来”。产品文档改版后,入口型引用通常必须更新,因为旧位置已经无法完成动作;依据型引用则要看新文档是否仍然支持同一说法。
如果旧文章写“按照官方文档,导出前需要先确认权限”,而新文档把权限确认改成了导出流程中的一步,那么这句话的依据仍然成立,但表述顺序需要调整。若新文档不再要求这一步,旧文章继续保留该引用就会误导读者。这里的关键动作是:打开新文档对应段落,逐句核对旧文章引用所依赖的前提,而不是只看链接能否打开。
完成这一步后,下一步的取舍会清楚很多:入口型引用直接换到最接近读者动作的新位置;依据型引用若前提已变,要么改写旧文章,要么删除该依据并重新组织段落。
旧文章退出时,最容易被忽略的是引用周围那几句解释。它们可能仍然有价值,只是不再适合挂在旧文档名下。判断方法是问:读者读完这句后,下一步要做什么?
这个筛选动作的结果会直接影响旧文章是“局部更新”还是“整体退出”。局部更新的文章通常还能保留标题和大部分正文;整体退出的文章即使链接全部替换,读者也无法完成原本的目标。
假设同一篇旧文章里有五处引用,其中三处换链接、一处改称谓、一处删除。若只留下修改后的结果,下一次文档再调整时,维护者仍然要重新判断一遍。更省力的做法是,在修改记录里写清每处引用的处理理由:位置迁移、名称变更、对象退出。这样后续维护时,能快速识别哪些引用属于稳定入口,哪些只是临时对应。
记录不必复杂,一行说明即可。它的作用是让下一次改版时,不必从零判断旧文章里每条引用的性质。对于仍然保留价值的旧文章,这一步能减少反复返工;对于准备退出的旧文章,也能留下判断依据,避免误删仍被读者需要的解释。
下面这组对照可以帮助决定是否更新,而不是凭“旧”直接处理。适用条件是:旧文章仍然有访问入口,且产品文档改版已经生效。
若旧文章访问量下降或某条引用点击归零,不能单独证明该引用已经失效;也可能是入口被折叠、读者改用搜索、或页面本身不再被推荐。需要结合新文档是否存在对应内容、读者是否还有下一步动作来判断。更新完成后,再检查旧文章中保留下来的引用是否都指向读者当前能用的位置,这比统一替换域名或批量改锚点更接近实际维护目标。