documentation - 从代码库生成技术文档
生成 API 文档、架构文档、README 文件、代码注释和技术内容的综合工作流
标签
更新于: 2026-03-19能力
典型输入
典型输出
该技能可以做什么
- 识别文档需求
- 选择文档工具
- 规划文档结构
- 定义样式指南
- 设置文档站点
- 提取 API 端点
- 生成 OpenAPI 规范
- 创建 API 参考
- 添加使用示例
- 设置自动生成
- 创建 C4 图表
- 记录架构
- 生成序列图
- 记录数据流
- 创建部署文档
- 提取代码注释
- 生成 JSDoc/TSDoc
- 创建类型文档
- 记录函数
- 创建 README
输入
- 代码库
- API 端点
- 源代码文件
- 代码注释
- 提交历史
- OpenAPI 规范
- 技术内容
输出
- API 文档
- 架构图
- README 文件
- 代码文档
- 用户指南
- wiki 页面
- 教程
- 变更日志
- 发布说明
要求
- 文档生成支持