先给判断标准:旧文章里凡是引用了改版中已经更名、合并、下线或语义变化的文档,都要更新;只涉及版本号、截图或补充说明的引用,可以保留但需要标注适用版本。区分这两类,是决定改多少、改哪些的前提。
如果产品文档改版不是换排版,而是把原来的功能拆成两个模块、把两个概念合并成一个,或者把某个术语的定义收窄,那么旧文章里的引用就不再指向同一个对象。此时读者点进去看到的文档,和文章正文描述的内容已经对不上。
判断依据是:旧文章引用该文档时,是否依赖文档里的具体定义、字段含义或操作顺序。若依赖,引用必须更新;若只是“详见某文档”这类泛指向,可以只改链接文字。
实施动作:先列出旧文章中所有指向改版文档的链接和提及,逐条对照改版说明,标记为“定义变化”“路径变化”“仅版本变化”三类。结果会影响下一步:定义变化类需要改写正文句子,路径变化类只需换链接,仅版本变化类可暂不动。
如果改版只是更新了截图、调整了按钮位置、增加了版本号,而概念和操作逻辑没变,旧文章的引用通常不需要重写。此时强行改引用,反而可能把原本正确的描述改错。
但有一个例外:旧文章明确写了“当前版本”“最新界面”这类时间敏感表述。这类表述在改版后会自动失真,需要改成不带时间指向的说法,或补充适用版本。
不要一上来就全站替换链接。先做一份引用清单,字段包括:旧文章地址、引用位置、引用文字、目标文档、改版后状态。假设某篇旧文章写“在设置页开启自动同步”,而改版后该选项移到了“账户偏好”,那么引用文字和链接都要改。假设另一篇只写“参见同步说明”,而文档只是换了排版,那么链接可保留,文字不动。
这个动作的结果是:你能清楚看到哪些旧文章需要改正文,哪些只需改链接,哪些可以不动。下一步再按影响面排优先级,优先改那些引用被当作操作依据的文章。
如果旧文章引用的是外部资料,而产品文档改版并未影响该外部资料,则不需要因为改版而更新。如果引用的文档已经下线,无论改版与否,都要替换为可用的替代文档,或删除该引用并补上等效说明。
另外,如果旧文章本身已经不再被任何页面链接、也没有实际访问入口,可以先不处理,但要在清单中标记为“低优先级”,避免误以为已经全部更新。
改完后,随机抽几条旧文章,从文章里的引用点进去,确认目标文档能打开、内容能对应、术语一致。若发现某条引用指向的文档虽然存在,但定义已经变了,就回到清单补记。验证的目的不是追求零遗漏,而是确认改动没有引入新的错配。
最后提醒一点:改版后旧文章里的引用更新,不等于整篇文章都要重写。只改引用和相关句子,保留仍然成立的部分,通常比整篇推翻更省力,也更少引入新错误。