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

质量

标签文章: 质量

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

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

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

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

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

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

3 分钟阅读
文章《把 Vale 用作质量门,而不是标点警察》的技术编辑风格插图。
工具

把 Vale 用作质量门,而不是标点警察

样式 linting 最有价值的地方,是发现术语漂移、风险措辞和可重复的编辑缺陷。规则应少而明确,并保持足够安静,让一次失败真正值得作者注意。 样式 linter 可以在几秒内检查成千上万句子,因此很容易产生“把所有偏好都编码进去”的冲动。