结论先给:旧文章里的引用是否要改,不取决于文章发布时间,而取决于它引用的产品事实是否已经失效。产品文档改版通常改变三类事实——功能名称与入口路径、参数与限制条件、操作步骤与前置要求。只要旧文章涉及其中任何一类,并且读者会据此执行操作,就必须更新;如果旧文章只引用品牌定位、行业判断这类不随文档版本变化的内容,则可以不动。
把旧文章里的引用拆成三种,处理方式完全不同。
实际操作上,先给每篇旧文章标记它引用了哪几类。只有事实型引用占比高的文章,才值得优先投入修改成本;解释型为主的文章,改一个失效名称即可,不必重写。
假设某产品的帮助中心把“数据导出”改名为“数据下载”,入口从设置页移到工具栏。如果一篇旧文章只是用“数据导出”作为举例,说明企业为什么需要定期备份数据,读者并不会照着文章去点击某个按钮,那么这篇文章的核心价值没有受损。此时强行把全文的“导出”替换成“下载”,反而可能让句子读起来别扭,也没有解决读者真正关心的问题。
这说明:判断标准不是“文档变了没有”,而是“读者会不会按文章描述去操作”。会操作的,必须改;只是借词说明观点的,可以保留,或只在首次出现处加一句说明。
每改完一篇,记录改的是哪类引用、依据是文档的哪个版本。这样下一次文档再改版时,你能快速定位哪些文章需要复查,而不是从头翻一遍。
假设你有一篇讲“如何配置通知规则”的旧文章,引用了三个事实:入口在“设置—通知”、支持按标签筛选、单条规则最多选五个标签。文档改版后,入口变成“自动化—通知”,标签筛选保留,上限调整为十个。
处理方式:入口必须改,否则读者找不到;上限必须改,否则读者会以为只能选五个;筛选方式没变,可以不动。改完后,这篇文章的下一步动作是标记为“已按新版文档核对”,并在台账里注明核对日期和文档版本。如果之后文档再次调整上限,你只需要查台账里标记过“上限”的文章,而不是全部重读。
完成一轮引用更新后,不要立刻进入下一轮写作。先做一件事:把这次改版涉及的旧文章按“引用类型”归类,看看事实型引用集中在哪些主题上。如果某类主题反复因为文档改版而需要修改,说明这些文章的写法过度依赖具体界面和参数。下一步可以考虑把这类文章改成以业务逻辑为主线,把界面细节放到单独的操作说明里,降低未来改版的连带成本。
这个动作的结果会直接影响你的内容维护节奏:依赖界面细节的文章越多,每次改版要动的就越多;把解释型内容和事实型内容分开存放,下一次改版时你只需要改后者。