module-analyzer-generate-doc

# Module Analyzer Generate Doc - Java 单模块深度文档生成器

> 专注于单个 Java/Maven 模块的深度业务逻辑分析 - 让 AI 全面理解模块的每个细节

## 核心特性

**单模块深度分析**:
- 专注于单个模块的完整扫描（而非整个项目）
- L3 文件级文档：每个包含业务逻辑的类生成详细业务解释
- L2 模块级文档：模块架构索引、核心业务流程、依赖关系汇总

**智能任务执行**:
- 多子代理并行分片处理（默认 5 个并行，每片 10-16 个文件）
- 上下文自动压缩（每处理 2-3 个文件压缩一次）
- 失败自动重试（最多 3 次，指数退避）
- 断点续传支持（状态文件记录进度）
- 进度定时汇报（每 20 分钟）

**文档质量保证**:
- 纯自然语言业务描述（无代码片段）
- 方法级别流程分析（触发条件、数据处理、业务规则、异常处理）
- 领域知识解释（业务概念、术语说明）
- 设计意图说明（为什么这样设计，解决什么问题）

**智能跳过机制**:
- 纯数据对象（Entity/DTO/VO，仅 getter/setter）→ 跳过
- 枚举定义（无复杂逻辑）→ 跳过
- 简单参数对象 → 跳过
- 测试类 → 跳过
- 接口定义（业务逻辑在 Impl 中）→ 跳过

---

## 激活条件

当用户提到以下关键词时激活：
- "分析这个模块"
- "生成模块文档"
- "扫描 admin-api 模块"
- "为 xxx 模块生成源码解析"
- "理解这个模块的业务逻辑"
- "模块级文档索引"
- "Java 模块分析"
- "单模块深度分析"

**与 project-analyzer-generate-doc 的区别**:
- `project-analyzer-generate-doc`：全项目多模块扫描，生成 L3→L2→L1 三层文档
- `module-analyzer-generate-doc`：单模块深度扫描，生成 L3→L2 两层文档（更详细、更快速）

---

## 完整工作流程

### Step 0: 模块扫描与规划

```powershell
# 1. 扫描模块目录结构
Get-ChildItem "<模块路径>" -Directory -Recurse | Where-Object { $_.Name -notmatch 'target|\.git|build' }

# 2. 统计 Java 文件
$javaFiles = Get-ChildItem "<模块路径>/src/main/java" -Include *.java -Recurse | Where-Object { $_.FullName -notmatch '\\test\\' }

# 3. 统计 XML 文件（MyBatis Mapper）
$xmlFiles = Get-ChildItem "<模块路径>/src/main/resources" -Include *.xml -Recurse | Where-Object { $_.Name -match 'mapper|Mapper' }

# 4. 检查已存在文档
$existingDocs = Get-ChildItem "<项目根目录>/.ai-doc/<模块名>" -Include *.md -Recurse 2>$null

# 5. 制定分...

# Module Analyzer Generate Doc

> Java/Maven 单模块深度文档生成器 - 让 AI 全面理解模块的每个细节

[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://clawhub.com/skills/module-analyzer-generate-doc)
[![OpenClaw](https://img.shields.io/badge/OpenClaw->=1.0.0-green.svg)](https://openclaw.ai)
[![License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](LICENSE)

## 📖 简介 / Introduction

**Module Analyzer Generate Doc** 是一个专注于单个 Java/Maven 模块深度业务逻辑分析的文档生成器。它通过多子代理并行处理，为模块中的每个包含业务逻辑的类生成详细的自然语言文档，帮助开发者和非技术人员快速理解模块的核心职责和业务流程。

**Module Analyzer Generate Doc** is a documentation generator focused on deep business logic analysis of single Java/Maven modules. It generates detailed natural language documentation for each class with business logic through multi-subagent parallel processing, helping developers and non-technical personnel quickly understand the module's core responsibilities and business flows.

---

## ✨ 核心特性 / Core Features

### 🎯 单模块深度分析 / Single Module Deep Analysis

- **专注单个模块** - 与 project-analyzer 不同，本技能专注于单个模块的完整扫描
- **L3 文件级文档** - 为每个包含业务逻辑的类生成详细业务解释（无代码片段）
- **L2 模块级文档** - 模块架构索引、核心业务流程、依赖关系汇总

### 🤖 智能任务执行 / Intelligent Task Execution

- **多子代理并行** - 默认 5 个并行子代理，每片 10-16 个文件
- **上下文自动压缩** - 每处理 2-3 个文件自动压缩，防止上下文溢出
- **失败自动重试** - 最多 3 次重试，指数退避（30s→60s→120s）
- **断点续传** - 状态文件记录进度，支持崩溃后恢复
- **进度定时汇报** - 每 20 分钟自动汇报进度

### 📝 文档质量保证 / Documentation Quality

- **纯自然语言描述** - 不包含任何代码片段，非程序员也能理解
- **方法级别分析** - 每个有业务逻辑的方法都描述其执行流程
- **领域知识解释** - 解释涉及的业务概念、领域术语
- **设计意图说明** - 解释为什么这样设计，解决了什么问题

### ⚡ 智能跳过机制 / Smart Skip Mechanism

自动跳过无业...