Skip to content

Latest commit

 

History

History
148 lines (104 loc) · 3.82 KB

README.md

File metadata and controls

148 lines (104 loc) · 3.82 KB

Java Project Documentation Generator

一个用于 Java Maven 项目的文档自动生成 Skill，通过多次与智能体对话，逐个分析类文件，最终生成完整的技术文档。

功能特性

📊 自动生成技术文档

生成以下四类完整的技术文档：

  1. 数据关系模型 - 表结构、ER图、枚举类型、SQL示例
  2. 功能模块划分 - 模块列表、依赖关系、核心类、API接口
  3. 业务系统架构 - 系统架构图、核心组件、数据流转、配置说明
  4. 重点功能流程 - 业务流程、时序图、业务案例、最佳实践

🔍 智能项目分析

  • ✅ 自动扫描 Java 项目结构
  • ✅ 识别关键模块和包结构
  • ✅ 理解类之间的依赖关系
  • ✅ 按优先级逐个分析类（Entity → Mapper → Service → Controller → Config）

🎨 丰富的可视化

  • ✅ Mermaid ER 图展示表关系
  • ✅ 架构图展示系统分层
  • ✅ 时序图展示业务交互
  • ✅ 流程图展示业务流程

🚀 多轮对话策略

将大型项目分析拆分为 7 个阶段：

  1. 项目结构分析
  2. 数据模型分析
  3. 数据访问层分析
  4. 业务逻辑分析
  5. 接口层分析
  6. 配置和架构分析
  7. 文档完善

快速开始

触发方式

直接使用以下任一短语触发此 skill：

  • "生成 Java 项目文档"
  • "分析 Java 类生成技术文档"
  • "创建 Maven 项目的技术文档"

使用扫描脚本

在项目根目录运行：

bash .codeflicker/skills/java-doc-generator/scripts/scan-java-project.sh

脚本会自动：

  • 扫描所有 Java 源文件
  • 识别实体类、Mapper、Service、Controller、Config
  • 分析包结构和 Maven 依赖
  • 生成项目分析报告

支持文件

📖 参考文档

  • mermaid-diagram-templates.md - 提供 8 种常用 Mermaid 图表模板

    • ER图、架构图、时序图、流程图、类图、状态图、甘特图、饼图

  • java-annotation-guide.md - Java 注解识别完整指南

    • Entity 注解（JPA、MyBatis Plus）
    • Mapper/DAO 注解
    • Service、Controller、Config 注解
    • 验证、缓存、异步、定时任务注解
    • Swagger/OpenAPI 文档注解

🛠️ 自动化工具

  • scan-java-project.sh - 项目扫描脚本
    • 扫描 759 个 Java 文件
    • 识别 105 个包
    • 分类所有类型的类
    • 生成详细分析报告

文档结构

生成的文档结构：

docs/
├── 01-数据关系模型.md          # 表结构、ER图、枚举类型
├── 02-功能模块划分.md          # 模块列表、API接口
├── 03-业务系统架构.md          # 系统架构、数据流转
└── 04-重点功能流程.md          # 业务流程、时序图

适用场景

✅ 需要快速了解 Java 项目结构
✅ 编写技术文档和设计文档
✅ 项目交接和知识传递
✅ 代码审查和架构评审
✅ 新人入职培训

技术栈支持

  • ✅ Spring Boot
  • ✅ MyBatis / MyBatis Plus
  • ✅ Spring Data JPA
  • ✅ Spring Cloud
  • ✅ Maven 项目

最佳实践

  1. 分析顺序：Entity → Mapper → Service → Controller → Config
  2. 文档组织：使用 Markdown 表格和 Mermaid 图表
  3. 信息提取：从注解、注释、方法名中提取信息
  4. 逐步推进：每次分析 5-10 个相关类
  5. 增量更新：允许后续补充和修改文档

版本信息

  • Version: 1.0.0
  • Author: heyongxian
  • Created: 2026-03-03
  • License: MIT

贡献指南

欢迎提交 Issue 和 Pull Request！

示例项目

本 skill 已成功应用于：

  • 海外任务系统（759 个 Java 文件，105 个包）
  • 生成了完整的四类技术文档
  • 包含 ER 图、架构图、时序图等可视化内容

联系方式

  • GitHub: (待补充)
  • Email: (待补充)

⭐ 如果这个 skill 对你有帮助，欢迎 Star 和分享！