产品文档改版后,旧文章里的引用不是按“出现关键词就改”处理,而应先分成必须保留、需要改写、应当退出三类。判断依据是引用是否仍指向同一事实、同一入口和同一适用范围;三者中任意一项变了,旧引用就不能原样保留。
产品文档改版通常同时动三样东西:术语、路径、适用范围。旧文章里的引用如果只涉及表述,风险最低;如果涉及入口位置或前置条件,风险最高。把改版说明逐条拆成“术语变化”“位置变化”“条件变化”三列,再拿旧文章里的引用去比对,比直接搜索关键词更可靠。
假设某产品把“导出报表”改名为“下载数据”,并把入口从设置页移到数据页。旧文章若只写“可以导出报表”,属于术语层引用,改写即可;若写“在设置页点击导出报表”,同时涉及术语和位置,必须改写;若写“所有套餐都能导出报表”,而新版文档注明该功能仅部分套餐可用,则这条引用已经失真,应退出或加限定条件。
保留的前提是:旧文章引用的事实与新版文档一致,只是措辞不同,且读者按旧文章操作仍能到达同一结果。此时不改比乱改更安全,因为频繁改动会破坏已有链接和读者记忆。
改写的前提是:事实主体没变,但名称、路径、前置条件或示例步骤变了。改写时要同步检查上下文,不能只替换一个词。例如把旧功能名换成新功能名后,前后文的按钮名称、截图说明、成功提示都要跟着核对。
退出的前提是:旧引用指向的能力已被移除、合并,或只对旧版本有效,而新版文档没有等价说明。退出不是简单删除一句话,而是给该段一个明确去向:指向新文档、标注适用版本,或整段下线并处理内链。
多个角色对同一事实理解不同时,争论“该不该改”往往没有结果。更有效的做法是把每条旧引用拆成四个可核对字段:引用原文、所在文章、新版文档对应位置、核对结论。结论只允许填保留、改写、退出三种,并附一句理由。
这个流程的作用是:把“我觉得该更新”变成“这条引用对应新版文档第几节,结论是改写”。下一步的排期和验收才有共同对象。
实际执行时,可以先只处理带操作步骤的旧文章,因为这类引用最容易因路径变化而失效。动作是:打开旧文章,逐段标记出所有让读者“去某处做某事”的句子,再对照新版文档确认三件事——入口是否还在原处、名称是否还叫原词、条件是否还成立。
如果三项都成立,标记为保留;名称或入口变了,标记为改写;条件不再成立,标记为退出。处理完一批后,检查这些旧文章的内链是否还指向有效页面。内链指向已下线页面时,即使正文引用已改写,读者仍会在跳转后迷失,这一步会直接决定下一批要处理哪些文章。
没有适用于所有网站的关键词密度、字数或标题字符阈值,也没有“旧文章超过多久就必须重写”的统一规则。改版后的引用核对,依据只能是新版文档这一事实来源。把同义词机械换写一遍,既不能解决入口变化,也不能解决条件变化,反而会掩盖真正失效的引用。
当引用数量很多时,优先处理带步骤、带条件、带版本号的三类句子;纯描述性句子可以最后处理。这样安排的原因是:前者的错误会让读者操作失败,后者的错误通常只影响表述,不会阻断下一步动作。