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. This should trigger for requests such as Improve the code with documentation; Apply documentation; Refactor the code with documentation. Part of curso…
Install
$ agentstack add skill-jabrena-cursor-rules-java-170-java-documentation ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-jabrena-cursor-rules-java-170-java-documentation) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
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/@throwstags - File handling strategies: overwrite/add/backup/skip
- Final documentation validation with
./mvnw clean compileand./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 validateormvn validatebefore 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
- EDGE CASE: If request scope is ambiguous, stop and ask a clarifying question before applying changes
- EDGE CASE: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance
When to use this skill
- Improve the code with documentation
- Apply documentation
- Refactor the code with documentation
Workflow
- Validate project before documentation changes
Run ./mvnw validate or mvn validate and stop immediately if validation fails.
- Read documentation reference and gather scope
Read references/170-java-documentation.md and identify required outputs (README, package-info, Javadoc enhancements).
- Generate selected documentation artifacts
Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).
- Run documentation validation checks
Execute ./mvnw clean compile and ./mvnw javadoc:javadoc (or equivalent) to validate generated docs.
Reference
For detailed guidance, examples, and constraints, see [references/170-java-documentation.md](references/170-java-documentation.md).
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: jabrena
- Source: jabrena/cursor-rules-java
- License: Apache-2.0
- Homepage: https://jabrena.github.io/cursor-rules-java/
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.