先给判断标准:产品文档改版后,旧文章里只有三类引用必须优先更新——指向已改名或已下线功能的链接、把旧界面截图当作操作依据的配图说明、以及依赖旧参数或旧流程才能成立的结论。其余引用可以延后,甚至保留,前提是它们不承担引导读者完成操作的任务。
假设某团队把产品文档从“按功能模块”改成“按使用场景”组织,旧地址/docs/module-a被替换为/docs/scene-1,同时把“批量导入”改名为“数据同步”。这时旧文章里出现的引用会分成几种命运:有的链接直接跳向不存在的页面,有的链接虽然还能打开,但页面标题和正文对不上,有的引用只是提到功能名,读者仍能理解。
要决定更新范围,先做一次引用盘点:把旧文章里所有指向文档的链接、所有引用文档标题的句子、所有以文档步骤为前提的结论分别列出来。这个动作的结果会直接决定下一步——如果盘点发现某篇文章的引用集中在已改名功能上,它就进入第一批更新;如果引用只是背景说明,就可以放进第二批。
面对改版,常见两种做法。第一种是全量替换:把所有旧文章里的旧链接、旧名称、旧步骤一次性改成新版本。第二种是按引用类型分批:先处理会导致读者操作失败的引用,再处理只影响阅读连贯性的引用。
两种做法成立的条件不同。全量替换适合旧文章数量少、引用集中、且团队能在一轮内完成核对的情况;它的代价是容易把本来不需要改的引用也改掉,比如某篇文章只是举例说明“旧版有批量导入”,改版后这个例子仍然成立,强行替换反而让例子失去时间背景。分批处理适合旧文章多、引用分散、且不同文章承担不同任务的情况;它的代价是需要先定义优先级,否则容易一直停在第一批。
一个可操作的区分方法是:问这条引用是否影响读者完成一个动作。如果读者需要点击链接才能继续操作,链接必须更新;如果读者只是读到功能名,且上下文已经说明这是旧版,名称可以保留但加一句说明;如果读者需要按步骤操作,步骤涉及的页面标题、按钮名称、参数值都要核对。
第一类是指向文档的链接。改版后旧地址可能返回错误页,也可能被重定向到新页面。即使有重定向,如果旧文章写的是“详见某文档”,而新页面已经不再讲这个主题,链接仍然需要换成更合适的页面。判断依据不是链接能否打开,而是打开后的页面是否回答旧文章让读者去看的问题。
第二类是把文档标题或章节名当作论据的句子。例如旧文章写“根据《批量导入操作指南》,导入前需要准备模板”。改版后指南改名、模板要求也可能变化,这句话里的引用就不再成立。更新时要回到新文档确认模板要求是否仍然存在,而不是只把标题换掉。
第三类是操作步骤和截图说明。产品文档改版往往伴随界面文案调整,旧文章里的“点击右上角批量导入”可能已经变成“点击数据同步”。这类引用如果不更新,读者会卡在找不到按钮的环节。更新动作是逐条核对步骤,核对结果决定这篇文章是局部修订还是重写。
不是所有引用都需要跟着改版走。以下情况可以暂缓:引用只出现在文章末尾的延伸阅读,且新文档仍有对应主题;引用只是提到功能名,没有要求读者点击或按步骤操作;引用出现在明确标注日期的旧文里,读者能判断它描述的是历史版本。
暂缓不等于永远不处理。可以给这些引用加一个统一说明,例如在文首或相关段落注明“本文基于旧版文档撰写,功能名称可能已变化”。这个动作的成本低,但会影响下一步:如果后续发现某篇暂缓文章仍然带来操作类咨询,就把它升回第一批。
假设你更新了一篇文章里的三个链接和一个按钮名称,更新后重新读一遍。如果读下来发现文章的主结论仍然依赖旧流程,比如“先批量导入再手动校对”,而新流程已经改成“数据同步后自动校验”,那么这篇文章就不是引用问题,而是结论过期。这时继续改引用没有意义,应该把文章标记为待重写。
验证时可以用一个简单规则:随机抽一条已更新引用,顺着它走一遍读者路径。如果路径能走通,且走通后得到的结论与文章写的一致,这篇就可以结束;如果路径走通但结论对不上,说明还有未发现的旧引用或旧前提。这个动作的结果决定你是回到盘点阶段,还是进入下一篇文章。