工作流

标签文章: 工作流

AI 与文档

在流畅错误发布前，对 AI 辅助文档进行事实核查

生成式文本可以看起来非常完整，却悄悄捏造默认值、保证或引用。验证流程应围绕权威来源、可执行示例和明确的不确定性构建。 AI 文档中最危险的错误通常不是语法错误，而是可信但没有依据的陈述：默认 timeout、未记录的参数、兼容性保证，或指向错误内容的 citation。

2 分钟阅读

AI 与文档

三年间，生成式 AI 把昂贵的初稿变成了廉价操作。现在真正重要的问题不再是模型会不会写，而是谁对事实、结构、审核、更新与质量负责。

2 分钟阅读

API

技术上有效的 request 不一定是好示例。选择能够解释 API 心智模型、使用真实值，并帮助开发者预测下一步的示例。

2 分钟阅读

工具

Sphinx、MkDocs、Astro 等工具针对不同内容模型和团队优化。应比较作者流程、扩展能力、本地化和维护成本，而不是只看演示页面和功能清单。

2 分钟阅读

实践

Docs-as-Code 并不意味着把所有技术写作者都塞进 IDE。更合理的做法是把版本化文本、浏览器编辑、预览、有效的自动检查、人工评审和可预测发布组合起来。

3 分钟阅读

职业

文档负责人应该减少不确定性，而不是成为额外审批层。明确所有权、标准和升级路径，同时让常规发布保持快速，并尽量靠近真正了解产品的人。

2 分钟阅读

实践

围绕“不官僚化的文档责任地图”给出可执行、可验证并且便于长期维护的技术写作方法。从技术写作角度解释“不官僚化的文档责任地图”，重点是可执行、可验证和可维护的做法。

3 分钟阅读

实践

好的评审流程应明确责任、减少等待，并区分事实、编辑与产品审批。

2 分钟阅读

实践

围绕“让用户知道该做什么的发布说明”给出可执行、可验证并且便于长期维护的技术写作方法。从技术写作角度解释“让用户知道该做什么的发布说明”，重点是可执行、可验证和可维护的做法。

3 分钟阅读

职业

围绕“如何与领域专家高效评审而不是不停开会”给出可执行、可验证并且便于长期维护的技术写作方法。从技术写作角度解释“如何与领域专家高效评审而不是不停开会”，重点是可执行、可验证和可维护的做法。

3 分钟阅读