api-doc-generator
Installation
SKILL.md
API 文档自动生成器
任务目标
- 本 Skill 用于:从项目代码中自动提取API信息并生成完整的API文档
- 能力包含:代码扫描、路由识别、模块划分、文档结构化、内容填充
- 触发条件:用户要求"生成API文档"、"分析项目API"、"编写接口文档"等
前置准备
依赖说明
本 Skill 仅使用 Python 标准库(ast, re, json, pathlib等),无需额外安装依赖。
非标准文件/文件夹准备
无需前置创建,输出目录将在文档生成时自动创建。
操作步骤
Related skills
More from morning-start/wiki-skills
design-pattern-advisor
智能设计模式顾问,提供设计模式识别、推荐、代码优化和架构审查能力。Invoke when user needs to identify design patterns in code, get pattern recommendations for a scenario, optimize code structure with patterns, or review system architecture.
7project-wiki
面向开发人员的项目文档助手,提供模板化文档生成、标准化文档流程和实用知识库查询
3architecture-doc-generator
根据SRS/PRD生成SAD/TDD/平台架构文档;当用户需要生成系统架构设计、技术方案设计或平台专项架构文档时使用
2doc-orchestrator
文档编排操盘手,全生命周期管理软件开发文档。从需求分析、文档生成、质量校验到变更维护,支持全规模项目自适应、双轨格式(Agent结构化+人类可读)、智能绘图(TXT/Mermaid自适应)
1requirements-doc-gen
将粗糙业务描述转化为标准SRS/PRD文档,支持需求变更分析、多端需求管理与自主知识补全;当用户需要生成专业需求文档、优化现有文档、进行需求评估或管理复杂项目时使用
1quality-ops-doc-gen
生成和优化质量与运维类文档(测试策略、部署运维、安全合规),支持多端场景、自主知识补全与需求变更分析;当用户需要生成测试文档、运维手册、安全合规文档或优化现有质量运维文档时使用
1