agentleFS
Sign inStart free
jabrenajabrena/cursor-rules-java/skills/170-java-documentation/SKILL.md

170-java-documentation

Skill452 starsChanged 3 months agoApache-2.0View on GitHub

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; Generate README or developer documentation for a Java project; Document Java APIs architecture or project workflows. Part of Plinth Toolkit

We split this skill into the rules it gives an agent

10 rules. About 0 are common, 6 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before applying any documentation generation, ensure the project validates.

    line 23
  2. Very specific:

    MANDATORY: Run ./mvnw validate or mvn validate before applying any documentation generation

    line 25
  3. Distinctive:

    SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved

    line 26
  4. Distinctive:

    BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each documentation generation pattern

    line 27
  5. Distinctive:

    EDGE CASE: If request scope is ambiguous, stop and ask a clarifying question before applying changes

    line 28
  6. Distinctive:

    EDGE CASE: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance

    line 29
  7. Distinctive:

    Document Java APIs architecture or project workflows

    line 37
  8. Very specific:

    Run ./mvnw validate or mvn validate and stop immediately if validation fails.

    line 43
  9. Very specific:

    Read references/170-java-documentation.md and identify required outputs (README, package-info, Javadoc enhancements).

    line 47
  10. Very specific:

    Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).

    line 51

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
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
  • 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
  • Generate README or developer documentation for a Java project
  • Document Java APIs architecture or project workflows

Workflow

  1. Validate project before documentation changes

Run ./mvnw validate or mvn validate and stop immediately if validation fails.

  1. Read documentation reference and gather scope

Read references/170-java-documentation.md and identify required outputs (README, package-info, Javadoc enhancements).

  1. Generate selected documentation artifacts

Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).

  1. 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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free