AI Native 手册
坑库

对外内容先读权威文档

凭记忆写的对外材料,细节容易和最新版本对不上。防止过时的说法进入长期对外的文档

亲历产品组织阶段 · 通用更新于 2026-10-16
分享到 X
一句话规则

写长期对外的文档之前,先读相关的权威文档

发生了什么

有一次写一份对外材料,没先去读文档,凭记忆就写了。写得很顺,读起来也像那么回事。可细节和最新版本对不上,有些还是旧版本的说法。差一点,它就进了对外的正式材料。

为什么会这样

记忆是快照。人的记忆停在上次认真看文档的时候;模型的知识停在训练截止日,会话里存的记忆也可能是几周前的。产品却一直在变:版本、功能、命名、对外口径。

更麻烦的是,过时的细节和准确的细节读起来一样流畅,agent 写得越顺,越不容易让人起疑。对外文档又是长期存在、会被别人引用转述的,一处错误会被复制很多次。

怎么做

动笔前先列出权威文档:当前的 README、相关的 spec、最近的 ADR、CHANGELOG、官方文档。哪份算数,写之前就说清楚。

把要求写进提示词:

写之前先读:README.md、docs/specs/ 下对应的 spec、docs/adr/ 里最近的决策、CHANGELOG.md。
写完附一张事实表:每个数字、版本号、名称后面写出处(文件路径或 URL)。
找不到出处的标“待核实”,不要凭印象补。

第三方库和工具的用法查最新文档:用 context7 这类查文档的 MCP,或者直接读官方文档,不靠模型记忆。

写进 CLAUDE.md,让每次会话都照做:写对外文档前先读权威文档,凭记忆写的内容一律标“待核实”。

这本手册的写作规范里也有同一条:命令、版本号、日期和数字都要有出处,查不到就不写。

相关

本页目录