用途:按五个层次生成技术文档——API 文档、代码文档、文档站点、架构决策记录(ADR)与图表,并可在 CI/CD 中自动化。
主要能力与工具:
- API 文档:编写 OpenAPI 3.1 规范,用 Swagger UI(交互测试)、Redoc(只读美观)或 Scalar 渲染。
- 代码文档:TypeScript 用 TypeDoc(npm install -D typedoc;npx typedoc --entryPoints src/index.ts --out docs),Python 用 Sphinx(pip install sphinx sphinx-rtd-theme;sphinx-quickstart docs;cd docs && make html),Go 用 godoc,Rust 用 rustdoc。
- 文档站点:Docusaurus(npx create-docusaurus@latest my-website classic)或 MkDocs Material(pip install mkdocs mkdocs-material;mkdocs new my-project;mkdocs serve)。
- ADR:使用 MADR 模板记录技术选型与架构决策。
- 图表:Mermaid(GitHub/Docusaurus/MkDocs 可渲染)、PlantUML、D2。
使用方式:按决策框架选择层次——对外 API 用第 1 层,维护者代码文档用第 2 层,完整指南用第 3 层,架构决策用第 4 层,可视化设计用第 5 层。可参考 references/ 下各指南与 templates/ 模板,并在 GitHub Actions 中生成与部署。
适用场景与限制:适合新 API 采用设计优先、既有 API 采用代码优先;ADR 仅用于有取舍的决策,不用于命名或格式等琐碎事项。需注意文档漂移、过度文档化与信息碎片化。资料未提供收费、价格信息。