| 工具链 | Git + Markdown + 静态站点生成器 + CI |
|---|---|
| 优势 | 版本可追溯、评审留痕、与代码同变更 |
| 适配 | 工程与运维文档；流程公文类仍需审批归档机制 |
工作流示例
工作流示例
改代码的 PR 同步更新 docs/ 下文档
CI 检查：链接有效、示例可编译
合并后自动构建并发布文档站文档即代码 Docs as Code
文档即代码把文档与代码放在同一仓库流程：版本控制、分支评审、CI 检查与自动发布；适合工程文档，让文档更新随代码变更一起完成，减少漂移。
易错点
- 上线后文档停在旧版本：发布流程没有覆盖文档
- 把公文也塞进代码仓库：审批归档要求无法满足
数据来源与参考
- Docs as Code 公开实践（Write the Docs 社区）
- 《Docs for Developers》