170 Java Documentation

This is a structured documentation generator for Java projects that walks you through creating READMEs, package-info.java files, and Javadoc comments in a choose-your-own-adventure style. It runs Maven validation upfront and won't let you proceed if the build is broken, which is smart. The interactive flow lets you pick documentation depth (minimal, basic, comprehensive) and file handling strategy (overwrite, backup, skip), then validates everything with a compile and javadoc build at the end. It's overkill if you just need to document one class, but if you're trying to bring consistency to an underdocumented multi-module Maven project, the guardrails and systematic approach actually help. Part of the cursor-rules-java collection by Juan Antonio Breña Moral.

skills.sh installs: 129
GitHub stars: 393
last updated: Jun 3, 2026

View on GitHub

Install

$ npx -y skills add jabrena/cursor-rules-java --skill 170-java-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

Java Documentation Generator with modular step-based configuration

Generate comprehensive Java project documentation through a modular, step-based interactive process that covers README.md, package-info.java, and Javadoc. This is an interactive SKILL.

What is covered in this Skill?

README.md generation for single-module and multi-module Maven projects
package-info.java creation with basic/detailed/minimal documentation levels
Javadoc enhancement: comprehensive @param/@return/@throws tags
File handling strategies: overwrite/add/backup/skip
Final documentation validation with ./mvnw clean compile and ./mvnw javadoc:javadoc

Constraints

Before applying any documentation generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.

SKILL.md on GitHub