先给结论:产品文档改版后,旧文章里真正需要优先更新的不是所有提到产品的句子,而是那些把读者引向已失效入口、已改名功能或已改变前提的引用。判断标准只有一条:读者照着旧文章操作时,会不会在文档里找不到对应内容。会找不到的,属于必须改;只是表述旧、但操作路径仍然成立的,可以排后处理。
假设你运营一个面向企业协作工具的内容博客,产品文档最近把“团队权限”拆成了“角色权限”和“资源权限”两个页面,原来的统一入口不再作为独立页面存在。旧文章里可能出现三种引用:直接链接到旧页面、只写功能名称不链接、以及把旧页面当作操作前提来描述。这三类要分开处理,不能一起批量替换。
第一类,链接指向已不存在的页面,读者点击后落到404或首页,属于硬性失效,必须改。第二类,只写“在团队权限里设置”,没有链接,读者仍可能通过搜索找到新页面,但会多一步困惑,属于中等优先。第三类,把旧页面描述成“所有权限的总入口”,而新文档已经拆开,这种前提性描述会让读者按错误路径操作,属于隐性失效,最容易被漏掉。
动手改之前,先把旧文章里所有指向产品文档的引用列出来。清点范围包括:正文中的超链接、图片说明里的链接、代码示例里出现的文档地址、以及“参见”“详见”“参考”这类引导语后面的目标。很多遗漏不是因为没改,而是因为一开始就没把图片说明和代码注释算进去。
清点后给每条引用标一个状态:目标页面是否还存在、功能名称是否已变、引用是作为操作步骤还是作为延伸阅读。这个状态表决定了改的顺序。如果一条引用同时是操作步骤又已经失效,它应该排在延伸阅读类引用之前。
链接目标已经不存在时,先确认新文档里有没有对应内容。有对应页面就替换为新地址;没有对应页面,就把链接移除,并把句子改成不依赖该页面的表述。不要保留一个指向首页的链接来“凑合”,那会让读者以为内容还在,只是入口变了。
文档把“团队权限”改叫“角色权限”后,旧文章如果继续用旧称,读者在新文档里搜索会失败。这类改动不需要重写整段,只要把首次出现的旧称替换为新称,并在必要处补一句新旧对应关系。前提是产品确实已经完成改名,而不是文档编辑的个人偏好。
最隐蔽的一类是旧文章说“先进入团队权限页面”,而新文档要求先选角色再选资源。这时即使链接没坏、名称没变,操作顺序也已经不同。判断方法是:把旧文章的操作步骤在新文档里走一遍,看是否每一步都能对应上。对不上的步骤,要么改写,要么加注说明适用条件。
改完引用不等于结束。挑三到五篇改动最多的旧文章,假设自己是一个第一次使用的读者,从文章开头按步骤走到产品文档,记录在哪一步需要回头搜索或猜测。如果出现回头搜索,说明还有引用没有对齐。这个动作的结果直接决定下一步:如果多数文章都能顺畅走通,就可以把剩余低优先引用排进常规维护;如果仍然频繁卡住,说明需要先补齐文档端的跳转说明,而不是继续改文章。
延伸阅读类引用、指向未改版页面的引用、以及只作为背景提及产品名称的句子,可以排在后面。判断依据不是“看起来旧”,而是“读者是否依赖它完成操作”。如果一条引用删掉后文章仍然能读通、操作仍然能完成,它就不是本次改版的阻塞项。把有限的编辑精力先放在会让读者卡住的引用上,比全面替换更有效。
最后提醒一点:不要因为某篇旧文章的引用全部失效就整篇重写。引用失效只说明入口变了,正文里的方法、判断标准和例子可能仍然成立。先改引用,再判断正文是否需要调整,能避免把一次局部维护扩大成不必要的重写。