文档生成器 — 自动化文档

花更少时间写文档，更多时间写代码。

命令映射

┌─ api ──────── REST/GraphQL API 文档
├─ readme ───── 项目 README.md
├─ changelog ── 版本变更日志
├─ contributing 贡献指南
├─ architecture 系统架构文档
├─ tutorial ─── 教程/快速入门指南
├─ faq ──────── 常见问题解答
└─ reference ── 完整参考手册

用法

bash
bash scripts/docs-generator.sh api rest users
bash scripts/docs-generator.sh readme myproject 一个很酷的工具
bash scripts/docs-generator.sh changelog 2.0.0 新功能

参数

• - api <类型> <资源> — 类型：rest/graphql，资源名称
• readme <名称> <描述> — 项目名称和描述
• changelog <版本> <摘要> — 版本和摘要
• contributing <项目> — 项目名称
• architecture <项目> <风格> — 风格：单体/微服务/无服务器
• tutorial <主题> <级别> — 级别：初级/中级/高级
• faq <主题> <数量> — 生成 N 条常见问题条目
• reference <库名> <语言> — 库名称和语言

理念

文档即产品。好的文档 = 更多用户 = 更少问题。