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

CI/CD

标签文章: CI/CD

CI/CD 中的文档
工具

CI/CD 中的文档

把文档当作构建产物:在读者看到改动之前验证结构、链接、示例和发布规则。 CI 不能判断解释是否真正有用,但可以在人工投入之前拦截大量可预测问题。

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

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

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

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

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

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