产品文档改版后,旧文章里的引用不能按“全改”或“全不改”一刀切。判断标准是:这条引用是否还承担解释或操作功能。承担功能的引用要保留并改写指向;只起装饰作用的引用可以退出;指向已删除内容的引用必须改写或删除,不能留着死链。
功能性引用是读者顺着它才能完成当前步骤的链接或截图说明,比如“在设置页开启同步”后面跟着的文档入口。装饰性引用只是顺手提到某个功能名或旧版界面,删掉不影响理解。失效性引用指向的段落、参数或截图在新版文档里已经不存在。
改版后先给每篇文章里的引用打这三类标签,比逐篇重读省力。分类依据不是链接数量,而是读者离开这句话后还能不能继续操作。
如果新版文档保留了同一功能,只是路径、菜单名或章节位置变了,引用应当保留,但要更新指向。保留的前提是概念本身没变,读者需要的那段解释仍存在。
实际操作上,先在新文档里定位对应章节,再回旧文章替换链接和周围那句指路话。这个动作的结果会直接影响下一步:如果新章节把原来一个步骤拆成了两个,旧文章里一句话带过的说明也要跟着拆开,否则读者点进去会对不上。
改写适用于三种情况:旧文章引用的参数名改了;旧文章描述的操作范围被缩小或扩大;旧文章把两个功能混在一句话里,而新版已经拆开。
改写不是把旧句子换成新词就结束。要检查引用前后那句话是否还在承诺旧行为。假设旧文章写“开启后自动同步全部项目”,而新版文档改成按项目单独开启,那么链接即使指向正确章节,句子本身也在误导。此时应改写句子,再决定链接指向总览页还是具体项目页。
一个可操作的判断顺序:先读引用前后各一句,再读新文档对应段落,最后问自己“读者按旧句子操作会不会失败”。会失败就改写,不会失败就只更新链接。
退出不是简单删链接。指向已删除章节的引用,如果周围句子还在描述那个功能,删链接会留下悬空表述。正确做法是连同那句话一起删,或者改写成不依赖该功能的新说明。
装饰性引用更适合退出。比如旧文章开头顺带提到“详见某旧版说明”,而该说明已不在导航中,这类引用删掉不影响正文,保留反而增加维护负担。
退出前确认一件事:这条引用是否被其他文章引用。如果多篇文章都指向同一段旧说明,删之前先决定替代落点,否则会连续产生一批失效引用。
假设你选出十篇旧文章,其中四篇的引用指向同一新版章节。先只改这四篇,更新链接并调整指路句,然后按读者路径走一遍:从旧文章点进新文档,能否在两步内找到对应操作。如果走不通,说明问题不在链接,而在旧文章的步骤描述,需要扩大改写范围。
这个试改的结果决定后续动作:走通就按同一标准处理剩余文章;走不通就先修步骤描述,再批量替换链接,避免把错误指向复制到更多页面。
记录里写“更新链接”没有复用价值。应写清这条引用属于保留、改写还是退出,以及依据是新文档哪一处变化。这样下次改版时,后来的人能直接按同一标准判断,而不必重新分类。
如果某篇文章的引用全部退出,也要记录退出原因。引用数量归零本身不能证明处理正确,它可能说明该文章已无存在必要,也可能说明你删掉了仍有用的指路信息。两种解释对应完全不同的后续动作,需要靠记录区分。