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.

• MANDATORY: Run ./mvnw validate or mvn validate before applying any documentation generation
• SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved
• BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each documentation generation pattern

When to use this skill

• Review Java code for documentation
• Apply best practices for documentation in Java code

Reference

For detailed guidance, examples, and constraints, see references/170-java-documentation.md.