文档即代码 (Docs as Code) 最佳实践

传统的文档维护方式（Word、Wiki）往往滞后于代码变更。Docs as Code 理念主张像管理代码一样管理文档。

核心原则

1. 使用轻量级标记语言: Markdown 或 AsciiDoc。易于编写，易于版本控制。
2. 版本控制: 将文档存储在 Git 仓库中，与代码同源。
3. 自动化构建与部署: 使用静态站点生成器（SSG）如 Hugo, MkDocs, Docusaurus 将文档构建为网站。

Mermaid：代码画图

在 Markdown 中直接通过代码绘制流程图、时序图，避免了二进制图片难以修改的问题。

graph TD
    A[用户] -->|请求| B(负载均衡)
    B --> C{服务可用?}
    C -->|是| D[后端服务]
    C -->|否| E[错误页面]

Docs as Code 让开发者更愿意编写文档，并且保证了文档的鲜活度。