← Back to Skills Marketplace
493
Downloads
0
Stars
0
Active Installs
4
Versions
Install in OpenClaw
/install project-analyzer-generate-doc
Description
Java Maven multi-module project documentation generator. Supports MyBatis SQL mapping, Maven dependency analysis, generates L3(file-level) to L2(module-level...
Usage Guidance
This skill appears to do what it says: analyze a Java/Maven project and generate L3→L2→L1 docs. Before enabling or running it: 1) Back up the repository or test on a copy (the skill writes .ai-doc and can move/merge files inside .ai-doc). 2) Expect interactive prompts for any migration/merge/delete actions and review the proposed migration plan before confirming. 3) If you are sensitive to autonomous actions, consider restricting the agent's ability to run skills autonomously or run the skill in a controlled session. 4) Review generated .generate-state.json and .task-log.md after runs; if you use CI or automated environments, ensure PowerShell and sessions_spawn behavior aligns with your policies.
Capability Analysis
Type: OpenClaw Skill
Name: project-analyzer-generate-doc
Version: 2.1.4
The skill bundle for 'project-analyzer-generate-doc' is classified as suspicious due to its high-risk capabilities and broad access to sensitive project data. Key indicators include the execution of PowerShell scripts with 'ExecutionPolicy Bypass' (package.json), the orchestration of multiple sub-agents to read and analyze the entire source code of a project, and a documented history (CHANGELOG.md and SECURITY_FIXES.md) of previously attempting to bypass security restrictions using 'bash' and 'elevated' permissions. While version 2.1.4 includes explicit safety constraints and user confirmation prompts in SKILL.md, the inherent risk of automated script execution and the potential for data exposure during the documentation process warrant caution.
Capability Assessment
Purpose & Capability
Name/description ask for Java/Maven/MyBatis analysis and the SKILL.md, README and templates all contain PowerShell/gitrepo scanning, dependency parsing, MyBatis mapping, and document generation steps that match that purpose. No unrelated credentials, binaries, or config paths are required.
Instruction Scope
Instructions read project source and .ai-doc, parse pom.xml, spawn subagents (sessions_spawn), write .ai-doc/.generate-state.json/.task-log.md, and may move/merge files in .ai-doc but require explicit user confirmation for destructive operations. This is appropriate for the stated task, but it does grant write access to the project tree and spawns subagents — users should expect those side effects.
Install Mechanism
No install spec or external downloads are present (instruction-only). package.json and scripts reference PowerShell scripts for local execution but nothing will be automatically fetched or executed at install time.
Credentials
The skill declares no required environment variables, no secret tokens, and no config paths outside the project workspace. All file and permission operations described are local and scoped to the project and .ai-doc output directory.
Persistence & Privilege
always:false (no forced global presence). The skill writes checkpoint and log files to the project's .ai-doc directory and can spawn subagents for parallel processing; both are expected for this capability. Because it can modify the repo (moves/merges) with user confirmation, users should back up repositories before first use.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install project-analyzer-generate-doc - After installation, invoke the skill by name or use
/project-analyzer-generate-doc - Provide required inputs per the skill's parameter spec and get structured output
Version History
v2.1.4
V2.1.4
🔒 Security Fix Release
This release addresses all security concerns raised by the OpenClaw security scan. No functional changes to
documentation generation capabilities.
Security Improvements:
• Removed all references to "bash" and alternative file-reading tools
• Removed all references to "elevated permissions" or privilege escalation
• Made file deletion operations explicitly require user confirmation
• Made document migration/merge operations explicitly require user confirmation
• Added explicit prohibitions against bypassing file access restrictions
────────────────────────────────────────────────────────────────────────────────
中文:
```
🔒 安全修复版本
本版本修复了 OpenClaw 安全扫描中发现的所有安全问题。文档生成功能无任何变化。
安全改进:
• 移除所有 "bash" 及替代文件读取工具的引用 • 移除所有 "elevated 权限" 或提权相关的引用
• 文件删除操作现在明确要求用户确认
• 文档迁移/合并操作现在明确要求用户确认
• 添加明确禁止绕过文件访问限制的说明
v2.1.2
## v2.1.2 (2026-03-09)
### 🔧 Improved / 改进
**Documentation Clarity** - Refined SKILL.md descriptions for better clarity and professionalism
- Improved file reading failure handling descriptions
- Enhanced error handling documentation
- Clarified enterprise security policy compatibility
**文档描述优化** - 优化 SKILL.md 中的描述,提升清晰度和专业性
- 改进文件读取失败处理的描述
- 增强错误处理文档
- 明确企业安全策略兼容性说明
### 📝 Fixed / 修复
**SKILL.md Wording** - Updated terminology for consistency across all documentation
- Changed "security restriction handling" to "file read failure handling"
- Updated configuration descriptions in TOOLS.md section
- Aligned Chinese and English documentation terminology
**SKILL.md 措辞修复** - 更新术语以保持所有文档的一致性
- 将"安全限制处理"改为"文件读取失败处理"
- 更新了 TOOLS.md 配置章节的描述
- 统一了中英文文档术语
### 📦 Version Update / 版本更新
- Updated package.json version to 2.1.1
- Updated _meta.json version to 2.1.1
- Added comprehensive bilingual changelog
- 更新 package.json 版本至 2.1.1
- 更新 _meta.json 版本至 2.1.1
- 添加完整的双语更新日志
---
## v2.1.1 (2026-03-08)
### 🔧 Fixed / 修复
**SKILL.md Encoding** - Fixed YAML front matter description field encoding
**Documentation Format** - Unified bilingual changelog format (Chinese then English)
**SKILL.md 编码修复** - 修复 YAML front matter 中 description 字段的编码
**文档格式优化** - 统一双语 Changelog 格式(先中文后英文)
---
## v2.1.0 (2026-03-05)
### 🎉 Added / 新增功能
- Task monitoring & health checks
- Automatic retry mechanism with exponential backoff
- Progress reporting every 5 minutes
- Checkpoint & resume support
- Sub-agent health monitoring
- 任务监控与健康检查
- 自动重试机制(指数退避)
- 每 5 分钟进度报告
- 断点续传支持
- 子代理健康监控
---
## v2.0.0 (2026-03-05)
### 🎉 Added / 新增功能
- MyBatis Mapper analysis
- Maven dependency parsing
- Document migration & merging
- Security-compatible file reading
- MyBatis Mapper 分析
- Maven 依赖解析
- 文档迁移与合并
- 安全兼容的文件读取
v2.1.0
v2.1.0
## v2.1.0 (2026-03-05) - 任务监控与重试机制增强
### 新增功能
- 实时进度跟踪 - 带百分比完成度的总体进度跟踪
- 子代理健康监控 - 每 60 秒检查子代理状态
- 自动重试机制 - 最多 3 次重试,指数退避延迟
- 进度报告 - 每 5 分钟或每 10% 进度自动生成
- 断点续传 - 自动保存任务状态,支持崩溃恢复
- 上下文使用监控 - 40% 预警,50% 强制压缩
### 改进
- 增加最大并行子代理数:5 → 8
- 减小分片大小:12 → 10 文件/子代理
- 更频繁的压缩:每 2 个文件压缩一次
- 修复进度跟踪准确性问题 - 🐛 修复状态文件损坏问题
### 技术更新
- 新增 references/task-monitoring.md 任务监控指南
- 新增 references/retry-mechanism.md 重试机制指南
- 增强 SKILL.md 和 README.md 文档
--English
## v2.1.0 (2026-03-05) - Task Monitoring & Retry Enhancement
### Added
- Real-time progress tracking with percentage completion
- Sub-agent health monitoring every 60 seconds
- Automatic retry mechanism with exponential backoff (max 3 retries)
- Progress reports every 5 minutes or 10% progress
- Checkpoint & resume with automatic state saving
- Context usage monitoring (40% warn, 50% force compress)
### Improved
- Max parallel sub-agents: 5 → 8
- Reduced chunk size: 12 → 10 files/sub-agent
- More frequent compression: every 2 files
- Fixed progress tracking accuracy
- Fixed state file corruption issues
### Technical
- Added references/task-monitoring.md
- Added references/retry-mechanism.md
- Enhanced SKILL.md and README.md
v1.1.0
Initial release. Features:
- Hierarchical Context documentation generation (L3→L2→L1)
- Sub-agent chunking with context compression
- Checkpoint/resume support for large projects
- Incremental updates via git diff
- Complete examples for all three levels
- Auto .gitignore management
- Output to project's .ai-doc/ directory
——
- 代理自适应多任务生成工程详细文档,分层上下文文档生成(L3→L2→L1)
- 子代理分块与上下文压缩
- 大型项目的检查点/恢复支持
- 通过git diff进行增量更新
- 所有三个级别的完整示例
- 自动.gitignore管理
- 输出到项目的.ai-doc/目录
Metadata
Frequently Asked Questions
What is Project Analyzer Generate Doc?
Java Maven multi-module project documentation generator. Supports MyBatis SQL mapping, Maven dependency analysis, generates L3(file-level) to L2(module-level... It is an AI Agent Skill for Claude Code / OpenClaw, with 493 downloads so far.
How do I install Project Analyzer Generate Doc?
Run "/install project-analyzer-generate-doc" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Project Analyzer Generate Doc free?
Yes, Project Analyzer Generate Doc is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Project Analyzer Generate Doc support?
Project Analyzer Generate Doc is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Project Analyzer Generate Doc?
It is built and maintained by endcy (@endcy); the current version is v2.1.4.
More Skills