产品文档改版后,旧文章里凡是“指向被移动、被合并或已被替代文档”的引用,都要优先更新;判断依据不是链接是否还能打开,而是读者顺着这个引用能否到达与当前产品行为一致的事实页面。能打开但内容已过时的引用,同样要改。
旧文章里的引用通常混在一起,改版后要先分类,否则容易把力气花在无关处。
判断顺序建议是:先看引用是否影响读者做操作,再看它指向的事实有没有变。影响操作的引用,改版后一律先核对。
假设某团队把产品文档从“按功能模块组织”改成“按任务流程组织”,原来的“数据导出”章节被拆进“导出到本地”和“导出到第三方”两篇。此时旧文章里写“参见数据导出文档”的引用,就可能出现三种理解:作者认为该指向本地导出,编辑认为该指向第三方导出,产品经理认为旧章节仍然存在。三种理解都不是事实,只是各自记忆不同。
把分歧转成可核对项,可以按下面动作做:
这个动作的结果会直接影响下一步:如果替换后句子仍通顺,说明只是路径问题;如果句子本身描述的步骤也变了,说明需要连同正文一起改,而不只是换链接。
不必等读者反馈才动手。以下信号出现任意一个,就应把对应引用列入更新范围:
反过来,如果目标页面只是调整了排版、换了配图,事实和步骤都没变,这类引用可以暂缓,不必为了“看起来新”而全部重写。
多角色协作时,最怕的是改完没人知道为什么改。建议在替换引用时,顺手记录三件事:旧地址、新地址、替换理由。理由写“原页面已拆分为两篇,本文步骤对应本地导出”即可,不需要长篇说明。
这样做的实际影响是:下一次文档再改版,你可以先查这份记录,判断哪些旧文章曾经依赖过被拆分的页面,而不是重新把所有文章翻一遍。记录本身不保证排名变化,但能让引用核对从“凭记忆争论”变成“按记录检查”。
假设旧文章里有一句“导出前请先完成权限配置,参见权限文档”。改版后权限文档被并入“账号与安全”页面,且新增了“仅管理员可配置”的说明。此时只把链接换成新地址还不够,因为旧文章没有提到管理员前提。正确动作是:更新引用地址,并在正文补一句“该配置仅管理员可操作”。
这个例子的假设前提是:改版确实合并了页面并新增了限制条件。若实际情况只是页面改名,那么只换引用文字和地址即可。两种处理的分界,在于事实有没有变,而不在于链接能不能点开。
所以,产品文档改版后,旧文章的引用更新顺序应当是:先处理影响操作的事实引用,再处理路径引用,最后才考虑背景引用;每改一处,都确认读者顺着引用能到达与当前产品一致的事实。