| 检查项 | 链接、拼写、术语、示例语法、格式与目录 |
|---|---|
| 工具 | 链接检查器、拼写检查、lint 与构建预览 |
| 门禁 | 错误级问题阻塞合并，警告提示不阻塞 |
流水线示例
流水线示例
1. markdown lint（格式规范）
2. 链接检查（内部+外部，外链容错重试）
3. 代码块语法检查
4. 预览构建：生成站点预览链接文档流水线 Docs CI
文档流水线自动检查常见问题：链接失效、拼写与术语规范、示例代码语法、目录结构；失败即阻止合并，减少人工评审负担，保持文档质量稳定。
易错点
- 外链检查不设容错：网络波动频繁误报，团队关闭检查
- 只报不修：警告堆积，最终全员忽略检查结果
数据来源与参考
- Docs as Code 公开实践（文档 CI 检查）