技术文档、工具与职业发展——独立技术写作杂志
TECHWRITERS.ORG

AI

标签文章: AI

把 AI 当编辑,而不是神谕
AI 与文档

把 AI 当编辑,而不是神谕

围绕“把 AI 当编辑,而不是神谕”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“把 AI 当编辑,而不是神谕”,重点是可执行、可验证和可维护的做法。

2 分钟阅读
文章《在流畅错误发布前,对 AI 辅助文档进行事实核查》的技术编辑风格插图。
AI 与文档

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

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

2 分钟阅读
文章《面向技术文档发布的 LLM 内容流水线护栏》的技术编辑风格插图。
AI 与文档

面向技术文档发布的 LLM 内容流水线护栏

当模型能够大规模创建和更新文档时,验证也必须同比扩展。限制输入、保留来源、验证结构,并把“生成”与有权限的“发布”分开。 好的架构预设模型有时会错。可以让模型提出文件、元数据和修改,但不要让同一步骤静默发布。

2 分钟阅读
合成示例:有用的草稿,危险的证据
AI 与文档

合成示例:有用的草稿,危险的证据

围绕“合成示例:有用的草稿,危险的证据”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“合成示例:有用的草稿,危险的证据”,重点是可执行、可验证和可维护的做法。

3 分钟阅读