Agent skill

170-java-documentation

Use when you need to generate or improve Java project documentation — including README.md files, package-info.java files, and Javadoc enhancements — through a modular, step-based interactive process that adapts to your specific documentation needs. Part of the skills-for-java project

View SKILL.md on GitHub Repository
Stars 350
Forks 63

Install this agent skill to your Project

npx add-skill https://github.com/jabrena/cursor-rules-java/tree/main/skills/170-java-documentation

Metadata

Additional technical details for this skill

author
Juan Antonio Breña Moral
version
0.14.0

SKILL.md

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

  • Improve the code with documentation
  • Apply documentation
  • Refactor the code with documentation

Reference

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

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

jabrena/cursor-rules-java

513-frameworks-micronaut-db-migrations-flyway

Use when you need to add or review Flyway database migrations in a Micronaut application — micronaut-flyway, db/migration scripts, flyway.datasources.* configuration, and alignment with JDBC or Micronaut Data. Part of the skills-for-java project

350 63
Explore
jabrena/cursor-rules-java

014-agile-user-story

Guides the creation of agile user stories and Gherkin feature files. Use when the user wants to create a user story, write acceptance criteria, define Gherkin scenarios, or author BDD feature files. Part of the skills-for-java project

350 63
Explore
jabrena/cursor-rules-java

502-frameworks-micronaut-rest

Use when you need to design, review, or improve REST APIs with Micronaut — including @Controller routes, HTTP status codes, DTOs, Bean Validation, exception handlers, pagination, idempotency, ETag/If-Match, caching headers, versioning, contract-first OpenAPI (OpenAPI Generator), optional runtime OpenAPI via micronaut-openapi, and security annotations. Part of the skills-for-java project

350 63
Explore
jabrena/cursor-rules-java

114-java-maven-search

Covers Maven Central search (Search API, maven-metadata.xml, artifact URLs) and project-local update reports via versions-maven-plugin (display-property-updates, display-dependency-updates, display-plugin-updates). Use when finding or verifying coordinates, browsing Central, or checking what newer versions apply to the user’s pom.xml. Part of the skills-for-java project

350 63
Explore
jabrena/cursor-rules-java

323-frameworks-spring-boot-testing-acceptance-tests

Use when you need to implement acceptance tests from a Gherkin .feature file for Spring Boot applications — including finding scenarios tagged @acceptance, implementing happy path tests with TestRestTemplate, @SpringBootTest, Testcontainers with @ServiceConnection for DB/Kafka, and WireMock for external REST stubs. Requires .feature file in context. Part of the skills-for-java project

350 63
Explore
jabrena/cursor-rules-java

200-agents-md

Use when you need to generate an AGENTS.md file for a Java repository — covering project conventions, tech stack, file structure, commands, Git workflow, and contributor boundaries — through a modular, step-based interactive process that adapts to your specific project needs. Part of the skills-for-java project

350 63
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results