先给结论:产品文档改版后,旧文章里需要优先更新的不是所有带链接的句子,而是那些“引用内容已经改变原意、改变可用条件或改变操作入口”的位置。判断依据是引用所依赖的前提是否被改版破坏,而不是链接是否还能打开。下面用一个假设情境说明怎么逐项判断。
假设某产品的帮助中心把原来的“功能说明页”拆成了“功能说明页 + 权限配置页”,并把部分参数名从英文改为中文。此时一批旧文章里出现三类引用:
这三类引用的处理方式不同。第一类可以保留;第二类和第三类需要更新,因为读者照着旧文章操作会失败。
不要按“链接是否 404”来筛。更有效的筛选条件是:
一个实际动作是:把旧文章里所有指向产品文档的引用逐条抄出来,在每条后面标注“概念引用 / 操作引用 / 判断引用”。标注完成后,优先处理操作引用和判断引用。这个动作会直接影响下一步:如果操作引用数量很少,可以逐条改;如果判断引用大量集中在同一篇旧文章,就要考虑整篇重写而不是只换链接。
改版前后并不是所有旧文章都要动。可以用两个条件区分:
假设一个短例子:旧文章写“开启同步需要把开关设为 ON”。改版后文档写“开启同步需要先具备管理员权限,再把同步模式设为‘自动’”。这时只把链接从旧页换到新页是不够的,因为读者仍然缺少权限前提。正确动作是改写成“先确认具备管理员权限,再把同步模式设为‘自动’”,并指向新的权限配置页。这个动作的结果是:读者不会在缺少权限时反复尝试,下一步排查也会从权限入手,而不是从开关状态入手。
第一类漏掉的是正文之外的引用,例如图片说明、代码示例注释、下载文件里的说明。这些位置如果引用了旧参数名或旧路径,同样需要更新,因为它们和正文一样会被读者当作操作依据。
第二类漏掉的是旧文章之间的相互引用。如果 A 文章引用了 B 文章,而 B 文章因为文档改版被重写,A 文章里的摘要句可能仍然描述旧行为。此时应检查 A 文章里对 B 文章的概括是否仍成立。若不成立,即使链接有效,也要改摘要句。
一个可执行的做法是:在完成正文引用更新后,搜索旧文章里是否还出现旧参数名、旧按钮名或旧限制值。每发现一处,判断它是“历史说明”还是“现行指引”。如果是历史说明,可以保留并注明时间背景;如果是现行指引,就按新文档改写。这个动作会决定下一步是继续逐篇清理,还是先集中处理同一批旧参数名。
产品文档改版后,旧文章里需要更新的引用,集中在操作指引和判断依据这两类。概念引用通常可以保留,但链接目标要指向最相关的页面。改版只拆分页面时,优先调整链接;改版改变参数、权限、流程或限制时,必须改写句子并重新核对原文。按这个顺序处理,可以避免把“链接还能打开”误当成“引用仍然正确”。