产品文档改版后,旧文章里需要更新的引用,不是所有提到产品的句子,而是那些依赖旧文档结构、旧参数口径或旧入口名称的引用。先判断它属于“指向性引用”还是“解释性引用”:前者必须改,后者看前提是否变化再决定。
产品文档改版通常意味着结构、术语或参数口径发生了变化。但旧文章不会自动失效,它仍然存在于站内,仍然被用户通过搜索或内部链接找到。问题在于:旧文章里的引用可能还在指向一个已经不存在的页面、一个已经改名的功能,或者一个已经被重新定义的参数。
这里有两种常见解释。第一种是“链接失效”:旧文章里的超链接指向了旧文档路径,改版后路径变了,链接变成死链或跳转到不相关页面。第二种是“语义失效”:链接还能打开,但旧文章对文档内容的描述已经和新文档不一致,读者按旧文章理解会出错。
这两种解释对应不同的处理方式。链接失效只需要替换地址,语义失效则需要重写引用段落。如果只检查死链,会漏掉那些“能打开但说错了”的引用。
要判断旧文章属于哪种情况,可以按下面三个证据来区分:
如果链接可达且术语一致,只是文档排版变了,那这类引用可以暂时不动。如果链接可达但术语已经改名,读者会困惑,需要更新表述。如果链接不可达,无论术语是否一致,都必须先修复地址,再检查上下文是否还成立。
假设某产品文档改版后,把某个配置项的默认值从“关闭”改成了“开启”。旧文章里有一句:“该功能默认关闭,需要手动开启。”这句话的引用对象是文档中的默认值说明。
此时有两种处理路径。路径一:如果新文档仍然保留“默认关闭”作为可选配置的说明,只是默认值变了,那旧文章需要改成“默认开启,如需关闭请手动调整”。路径二:如果新文档已经取消了这个配置项,那旧文章不应只改默认值,而应删除或重写整段,避免让读者以为这个配置仍然存在。
判断依据是:打开新文档,确认该配置项是否还在正式目录中。如果存在,更新默认值描述;如果不存在,标记整段为待重写。这个动作的结果会直接影响下一步:更新默认值属于小改,可以批量处理;整段重写则需要单独排期,因为它可能牵涉文章结论。
不是所有旧文章都值得立即更新。优先处理那些同时满足以下条件的引用:
满足这三条的引用,如果放着不管,读者按旧文章操作会直接遇到障碍。相反,如果旧文章已经不在任何入口出现,或者引用只是泛泛提及产品名称,可以降低优先级。
实际操作时,先建立一份旧文章引用清单,逐条记录:引用所在文章、引用类型(链接或语义)、新文档对应位置、当前状态。然后按状态分类:死链优先修,语义不一致排期改,一致的不动。
这个动作的结果是:你能明确知道哪些文章需要重写、哪些只需要替换链接、哪些可以暂时保留。下一步就可以按修改成本分配人力,而不是把所有旧文章都翻一遍。对于语义失效的引用,修改后还需要检查同一篇文章中是否有其他段落依赖同一前提,避免只改一处留下矛盾。