先给你一个可执行的判断:把改版前后的产品文档当作两套“事实源”,逐条比对旧文章里出现的功能名、操作步骤、参数、截图说明和链接锚文本。凡是新文档已经改名、改路径、改流程或删除的内容,旧文章里的对应引用就必须更新;只是措辞风格变化、页面位置调整但内容未变的,可以暂缓。下面用一个假设的“导出报表”功能改版场景,说明怎么把一篇旧文章转成可执行的处理清单。
旧文章对产品文档的引用通常分三层:名称层、流程层、证据层。名称层指功能名、菜单名、按钮文案;流程层指操作步骤的先后顺序和前置条件;证据层指截图、参数表、示例输出。改版后,优先处理名称层和流程层,因为它们直接影响读者能否照做。证据层次之,但如果截图里出现了已删除的按钮,也会让读者卡住。
具体动作:打开旧文章,把所有指向产品文档的句子和链接标出来,按这三层归类。归类结果决定你下一步是改一句话、重写一段,还是替换整张图。
不要凭记忆判断“应该没变”。把新版文档的目录和旧文章里提到的功能点并排列出,逐条确认三件事:这个功能是否还存在、入口是否还叫这个名字、步骤是否还按原来的顺序。假设新版把“导出报表”从“设置”移到了“数据中心”,并且把“导出”改成了“下载”。那么旧文章里写“在设置中点击导出”的句子,就属于必须更新的引用。
比对完成后,你会得到一份“必须改”和“可暂缓”的清单。下一步只处理“必须改”的部分,避免把时间花在措辞微调上。
可以暂缓的情况:新版只是调整了页面排版、换了同义按钮文案,但读者按旧文章操作仍能走通。不能拖的情况:旧文章里的引用会导致读者找不到入口、执行错误步骤,或者引用了已下线的功能。判断标准不是“新旧是否完全一致”,而是“读者照着做会不会失败”。
假设你有一篇讲“批量导出”的旧文章,新版把批量导出拆成了“按筛选导出”和“按标签导出”两个入口。旧文章只写了一个入口,读者照着做只能完成一半任务。这种引用就必须更新,而且要在文章里说明两个入口分别适用于什么条件。这个动作的结果是:读者不再需要猜,你的下一步也可以据此决定是否补充一篇单独讲两种导出的文章。
引用更新不只是改链接地址。锚文本如果还写着旧功能名,读者会以为点进去是另一个页面。示例输出如果还基于旧参数,读者对照时会发现对不上。把锚文本改成新版文档里的实际标题,把示例里的字段名、单位、默认值同步成新版文档中的写法。如果新版文档没有给出示例,就不要自己编一个看起来像官方输出的例子,可以改成描述性说明。
完成这一步后,再检查旧文章内部有没有指向其他旧文章的链接。如果被链接的那篇也引用了旧文档,就要一起加入待更新清单,否则读者会在两篇文章之间来回碰到过期信息。
这套顺序不依赖某个特定工具,也不要求你一次改完所有旧文章。它的价值在于:每次产品文档改版后,你都能用同一套比对动作,把“哪些引用需要更新”从一个模糊问题变成一份可执行的清单,并且知道先改哪一层、改完以后怎么验证。