AI 与文档
在流畅错误发布前，对 AI 辅助文档进行事实核查
生成式文本可以看起来非常完整，却悄悄捏造默认值、保证或引用。验证流程应围绕权威来源、可执行示例和明确的不确定性构建。 AI 文档中最危险的错误通常不是语法错误，而是可信但没有依据的陈述：默认 timeout、未记录的参数、兼容性保证，或指向错误内容的 citation。
2 分钟阅读
质量
标签文章: 质量
工具
选择文档搜索：从失败查询开始
围绕“选择文档搜索：从失败查询开始”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“选择文档搜索：从失败查询开始”，重点是可执行、可验证和可维护的做法。
3 分钟阅读
实践
文档债务：如何找到真正伤害用户的问题
围绕“文档债务：如何找到真正伤害用户的问题”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“文档债务：如何找到真正伤害用户的问题”，重点是可执行、可验证和可维护的做法。
3 分钟阅读
职业
比页面浏览量更重要的文档指标
围绕“比页面浏览量更重要的文档指标”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“比页面浏览量更重要的文档指标”，重点是可执行、可验证和可维护的做法。
3 分钟阅读
API
如何记录 API 错误，让开发者能够恢复
围绕“如何记录 API 错误，让开发者能够恢复”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“如何记录 API 错误，让开发者能够恢复”，重点是可执行、可验证和可维护的做法。
3 分钟阅读
API
如何正确编写 REST API 文档
好的 API 文档需要把机器可读契约、人类解释、可运行示例和明确的错误行为结合起来。 REST API 文档同时面向机器和人。机器可读契约描述 path、method、parameter、schema 与 response；人类文档解释意图、约束、工作流和开发者要做的选择。
2 分钟阅读
标准
术语与定义：建立术语体系
术语表真正有价值，是因为它能约束产品、界面和文档中的选择，而不仅是收集词语。 有用的术语记录不仅解释词义，还应包含首选词、禁用或废弃变体、上下文、语法说明和 owner。
2 分钟阅读
职业
不靠陷阱测试招聘技术写作者
围绕“不靠陷阱测试招聘技术写作者”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“不靠陷阱测试招聘技术写作者”，重点是可执行、可验证和可维护的做法。
3 分钟阅读
实践
面向持续增长文档的信息架构
五十页时好用的结构，到了五百页可能彻底失效。应围绕用户任务、内容类型和长期稳定的概念设计导航，而不是照搬组织架构。 小型文档集几乎可以容忍任何导航方式。只有二十页时，读者能快速扫完菜单，作者也记得内容放在哪里，重复内容仍然容易发现。
3 分钟阅读