结论先说:产品文档改版后,旧文章里需要更新的引用不是“所有提到产品的地方”,而是那些会因为改版产生事实冲突、路径失效或语义漂移的引用。判断依据是引用对象是否仍然成立,而不是它是否出现在文章里。你可以把每篇文章中的引用拆成三类:指向改版后已变更事实的、指向已迁移或合并位置的、指向仍然有效但表述需要对齐的。前两类必须改,第三类按成本决定是否同步。
产品文档改版通常带来三种变化:事实变了、位置变了、说法变了。事实变了指功能名称、参数、限制条件、操作步骤发生实质变化;位置变了指原页面被合并、拆分或迁移;说法变了指概念没变,但官方用词、术语层级或示例方式调整。旧文章里的引用是否要更新,取决于它属于哪一种。
一个可操作的做法是:拿改版前后的文档目录做一次对照,标出每个被引用页面的状态。状态只有四种:内容与位置都未变、位置未变但内容变、内容未变但位置变、内容与位置都变。这个对照表就是后续判断的依据,而不是凭印象逐篇翻旧文。
不要以“文章”为单位判断,要以“引用”为单位。从旧文章中逐条抽出引用,通常包括:指向文档的链接、直接引用的功能描述、引用的参数或限制、引用的操作步骤、引用的术语或概念名称。每条引用记录三个信息:它指向改版前的哪个文档位置、它陈述了什么事实、这个事实在改版后是否仍然成立。
这里容易出现分歧:不同角色对“这个事实是否还成立”理解不同。把分歧转成可核对项的办法是,为每条引用写一句可验证的陈述,例如“该功能默认关闭”或“该参数上限为某一数值”,然后去改版后的文档中找对应表述。找不到对应表述、或对应表述与旧文不同,就标记为待确认,而不是直接判定为错误。
第一类,引用的事实已变更。这类必须改,且优先级最高,因为旧文会与官方文档直接冲突。动作是:先改事实描述,再检查同一篇文章里是否有其他段落依赖这个事实。结果会影响下一步——如果多处依赖,说明这篇文章需要整体复核,而不只是替换一句话。
第二类,引用位置已迁移或页面被合并。这类需要改链接和指向说明。动作是:确认新位置是否覆盖了旧文引用的全部内容。如果新位置只覆盖一部分,旧文可能需要改为引用多个位置,或删去不再被覆盖的部分。这一步的结果决定旧文是简单换链接,还是需要重写相关段落。
第三类,事实与位置都未变,只是官方说法或术语层级调整。这类不一定要改。判断条件是:旧文用词是否会让读者误解概念边界。如果只是同义表达,可以不动;如果旧词在新文档中已被赋予不同含义,就需要对齐。
假设某产品文档改版后,把“配置项”拆成了“基础配置”和“高级配置”两个页面,原“配置项”页面不再存在。旧文章中有三处引用:一处链接到原页面,一处写着“所有配置项在同一页面设置”,一处引用了某个具体参数的默认值。
处理方式可以是:链接引用改为指向拆分后的对应页面;那句“所有配置项在同一页面设置”需要改写,因为它描述的是旧结构;参数默认值则要去改版后的文档中核对是否变化。如果默认值未变,这一处可以保留,但最好顺带确认它现在归属哪个页面,以免读者按旧路径找不到依据。这个例子说明,同一篇文章里的引用要分别判断,不能因为页面没了就整篇重写。
每处理完一条引用,记录它的最终状态:已更新、确认无需更新、待确认。待确认项要写清楚缺什么依据,例如“改版后文档未说明该限制是否仍然存在”。这样下一次文档再改版时,你可以先看这份记录,而不是重新逐篇排查。记录的价值不在于完整,而在于让“为什么没改”也有据可查,避免不同角色反复对同一处产生分歧。
最后要说明的是,旧文章引用更新不是为了追求全站口径绝对统一。有些引用即使与新版文档表述不同,只要不造成事实错误或路径失效,就可以保留。把精力放在会误导读者或让读者找不到依据的引用上,比逐字对齐更实际。