先给结论:旧文章里凡是引用产品文档的段落,都要按“引用是否还指向同一个事实”来判断,而不是按链接是否还能打开来判断。文档改版通常只改一处,但受影响的旧文章可能分布在多个主题上。判断标准只有一条——旧文章里的那句话,在改版后的文档里是否还能找到对应依据;找不到,就必须更新或删除。
产品文档改版后,旧文章的引用问题分成两类,处理方式完全不同。
第一种:只是位置和层级变了。文档从“功能说明”挪到“操作指南”,标题改了,锚点变了,但描述的行为、参数、限制条件都没动。这种情况下,旧文章里的引用文字仍然成立,需要动的只是链接地址和锚点。判断依据是:把旧文章引用的那句话,拿去改版后的文档里找,能不能找到意思相同的表述。能找到,就只改链接。
第二种:事实本身变了。默认值改了、某个限制取消了、操作步骤从三步变成两步、某个字段不再需要填写。这种情况下,链接即使还能打开,旧文章里的表述也已经错了。判断依据是:旧文章里有没有出现具体的数字、步骤、条件、字段名或行为描述。只要出现,就要逐条比对改版后的文档。
两种情况的处理顺序不一样。事实变了要先改文字,再改链接;只是位置变了可以只改链接。如果反过来先改链接,容易把错误的表述带到新地址上,读者点进去看到的内容和文章说的不一致,反而更糟。
不要通读所有旧文章,那样效率低且容易漏。按引用类型排查,覆盖面更稳。
排查完这四类,剩下的引用基本可以只做链接检查。这一步的动作很具体:把旧文章的引用句抄到一个单独列表里,逐句到改版后的文档里找对应位置。找到且意思一致,标记为只改链接;找到但意思不同,标记为改文字;找不到,标记为删除或改写。
假设某产品文档把“导出数据默认包含全部字段”改成了“导出数据默认只包含当前可见字段”。这是事实变化,不是位置变化。
受影响的旧文章可能包括:讲导出操作的教程、讲数据字段说明的文章、讲批量处理流程的文章、甚至一篇讲权限设置的文章——因为权限影响哪些字段可见,进而影响导出结果。这四篇文章的引用都要改,而它们可能分散在不同栏目里。
如果只改教程那一篇,另外三篇会继续告诉读者“默认导出全部字段”。读者按旧文章操作,拿到的数据不完整,问题不会立刻暴露,但会在后续环节出现。这个例子的意义在于:文档改版的影响面,取决于旧文章引用的是“行为”还是“名称”。引用行为的影响面大,引用名称的影响面小。
只改链接成立的条件有三个,必须同时满足:
只要有一条不满足,就不能只改链接。特别是第三条,很多旧文章会在引用文档后补一句“所以建议你……”。文档一变,这个建议的前提就没了,链接改得再对,正文也是错的。
反过来,如果旧文章只是把文档当作延伸阅读,正文结论来自其他依据,那么改版后可以只检查链接有效性,正文暂不动。这个判断要写进更新记录里,说明为什么不动,避免下次改版时重复排查。
不是所有失效引用都值得改。如果旧文章的引用只是为了证明“这个功能存在”,而该功能在改版后已经被合并或取消,那么正确动作是删掉整段,而不是找新文档替换。硬替换会把一个已经不存在的前提继续留在文章里。
另一种例外是引用已经过期但文章本身仍有独立价值。这时可以把引用改成不带具体细节的表述,把细节交给文档本身去承担。这样做的前提是,文章的核心结论不依赖那些细节。如果依赖,就不能模糊化,必须重写。
最后一步动作:更新完成后,把这次改版涉及的引用类型记下来。下次文档再改版时,优先排查同一类型的引用。如果某类引用反复出问题,说明旧文章的写法本身过于依赖文档细节,需要在下次写作时减少这类引用。