核心用法
Technical Documentation Generator 是一款面向开发团队的自动化文档生成技能，通过智能扫描代码库结构，一键输出多种类型的专业技术文档。支持六种文档模式：
| 模式 | 输出内容 |
|------|---------|
| `readme` | 项目 README，含功能特性、快速开始、项目结构 |
| `api-docs` | API 端点文档 + OpenAPI/Swagger 规范 |
| `architecture` | 架构概览含 Mermaid 组件图、技术栈、数据流 |
| `changelog` | 基于 Git 历史的标准化变更日志 |
| `onboarding` | 新开发者上手指南，含环境配置与开发工作流 |
| `full` | 完整文档包，输出至 `docs/` 目录 |
执行示例：
/technical-doc-generator ./src api-docs /technical-doc-generator . full
扫描策略
工具采用分层扫描：优先读取包管理文件（package.json、go.mod 等）→ 配置文件 → 入口文件 → 路由/模型文件 → 测试文件，避免全量读取，确保效率。
显著优点
1. 多框架智能识别：自动检测 Express、FastAPI、Django、Spring、Gin 等主流框架
2. 标准化输出：API 文档自动生成表格化参数说明与错误码映射，架构图采用 Mermaid 标准语法
3. Git 历史解析：支持 Conventional Commits 规范，自动分类 Added/Changed/Fixed/Security 等变更类型
4. 开箱即用：无需配置，直接通过自然语言参数调用
5. 企业级交付：输出格式可直接用于客户交付或 CI/CD 流水线集成
潜在局限
- 语义理解边界：复杂业务逻辑（如分布式事务、领域事件）依赖代码注释质量，自动生成内容可能缺乏业务语境
- 框架覆盖盲区：小众框架或高度定制化路由可能需要人工调整
- 安全敏感信息：工具会扫描 .env.example 等配置文件，需确保代码库已脱敏，避免泄露密钥
- Mermaid 渲染依赖：架构图在部分 Markdown 预览工具中需额外插件支持
适合人群
- 技术负责人：需要快速产出架构文档与团队规范
- 外包/咨询公司：提升交付物专业度，减少文档工时
- 开源维护者：自动生成标准化 README 与 CHANGELOG
- 新成员 onboarding：降低熟悉代码库的认知门槛
常规风险
| 风险类型 | 说明 | 缓解建议 |
|---------|------|---------|
| 信息泄露 | 扫描可能暴露内网地址、测试账号 | 执行前审查代码库，移除敏感配置 |
| 文档过时 | 生成后代码变更导致文档失效 | 将文档生成纳入 CI 流水线，保持同步 |
| 过度依赖 | 团队放弃手写文档，丢失业务细节 | 将 AI 生成内容作为初稿，人工补充业务上下文 |