doc-generatorlisted

# Doc Generator — 文档生成技能 从代码和项目结构自动生成专业级技术文档。 ## Goal 从代码自动生成各类技术文档：API 文档、README、架构文档、变更日志、代码注释 ## Trigger - 用户要求"生成文档"、"写README"、"生成API文档" - 项目缺少文档需要补充 - 代码变更需要更新文档 ## 工作流程 ``` 代码分析 → 结构识别 → 内容生成 → 格式化 → 输出文档 ``` ## 支持的文档类型 | 类型 | 输入 | 输出 | |------|------|------| | README | 项目目录 | README.md | | API 文档 | 路由/控制器代码 | OpenAPI/Swagger | | 架构文档 | 项目结构 | ARCHITECTURE.md | | 变更日志 | Git 历史 | CHANGELOG.md | | 贡献指南 | 项目配置 | `CONTRIBUTING.md` | | 代码注释 | 函数/类代码 | 行内注释/Docstring | ## README 生成 ### 模板结构 ```markdown # {项目名称} {一句话描述} [](LICENSE) []() ## 功能特性 - ✅ {特性1} - ✅ {特性2} - ✅ {特性3} ## 快速开始 ### 前置要求 - {运行环境要求} - {依赖工具} ### 安装 ```bash # 克隆项目 git clone {repo_url} cd {project} # 安装依赖 {install_command} # 配置环境 cp .env.example .env # 编辑 .env 文件 # 启动服务 {start_command} ``` ### 验证 ```bash # 运行测试 {test_command} # 健康检查 curl http://localhost:{port}/health ``` ## 使用说明 ### {功能1} ```{language} {代码示例} ``` ### {功能2} ```{language} {代码示例} ``` ## 项目结构 ``` {project}/ ├── src/ # 源代码 │ ├── {module1}/ # {说明} │ └── {module2}/ # {说明} ├── tests/ # 测试代码 ├── docs/ # 文档 ├── scripts/ # 脚本工具 ├── {config_files} # 配置文件 └── README.md # 本文件 ``` ## API 文档 | 方法 | 路径 | 说明 | |---