Module Analyzer Generate Doc
Java/Maven单模块深度文档生成器
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:Module Analyzer Generate Doc。 它的用途是:Java/Maven单模块深度文档生成器 完整的 Skill 内容见:https://321skill.com/skills/module-analyzer-generate-doc-x-6/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'分析我的Java Maven模块,生成从文件级到模块级的业务逻辑文档,支持并行处理和断点续传。' 它会自动扫描模块源码,调用多子代理分析业务流向,输出包含文件职责说明和模块级流程图的Markdown文档,并自动保存检查点以防中断。
介绍
本工具专为Java/Maven单模块项目设计,自动从代码中提取业务逻辑,生成从文件级(L3)到模块级(L2)的深度文档。它解决的是开发者在维护遗留项目或接手新模块时,缺乏清晰、可追溯的业务逻辑文档的问题。传统文档工具往往只输出API签名或类图,而本工具能够理解代码中的业务流向,输出人类可读的流程说明。
使用方式:将工具集成到Maven项目中,通过命令行或配置文件指定目标模块。工具会自动扫描源码,调用多子代理并行分析文件间调用关系、上下文压缩减少Token消耗,并在意外中断时通过检查点恢复进度。最终输出Markdown格式的文档,包含文件级职责说明和模块级业务流程图。
适合人群:后端开发工程师、文档工程师、技术负责人,尤其是需要为Java单体项目快速补全文档的团队。也适合智能体开发者,将其作为子代理嵌入自动化工作流。
建议:在首次运行前确保项目已通过编译,且Maven依赖完整。对于大型模块(>200个文件),建议开启自动重试和上下文压缩功能以优化性能。注意该工具仅支持单模块,多模块项目需分别执行。
核心特点
支持多子代理并行分析、上下文压缩、断点续传和自动重试,能够同时生成文件级和模块级业务逻辑文档,而非仅输出API签名或类图。
注意事项
仅适用于Java/Maven单模块项目,不支持多模块或非Maven项目。
常见问题
如何安装这个工具?
克隆仓库后,在项目根目录执行 mvn clean install 即可构建。具体使用方式请参考README中的配置文件说明。
生成文档时如何断点续传?
工具会自动保存检查点,若中途中断(如网络波动),重新运行相同的命令会从断点继续,无需重复分析已完成的文件。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/module-analyzer-generate-doc-x-6/raw/index.md 读取 Module Analyzer Generate Doc 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/module-analyzer-generate-doc-x-6/raw/index.md(查看排版版本)