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.
Prerequisites: Run ./mvnw validate or mvn validate before applying any documentation generation. If validation fails, stop immediately — do not proceed until all validation errors are resolved.
Core areas: README.md generation for single-module and multi-module Maven projects, package-info.java creation with basic/detailed/minimal documentation levels, Javadoc enhancement with comprehensive @param/@return/@throws tags, file handling strategies (overwrite/add/backup/skip), and final documentation validation with ./mvnw clean compile and ./mvnw javadoc:javadoc.
Используйте, когда вам нужно создать или улучшить документацию проекта Java, включая файлы README.md, файлы package-info.java и улучшения Javadoc, с помощью модульного пошагового интерактивного процесса, который адаптируется к вашим конкретным потребностям в документации. Часть проекта «Навыки для Java» Источник: jabrena/cursor-rules-java.