CtrlK
BlogDocsLog inGet started
Tessl Logo

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 cursor-rules-java project

80

Quality

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

Quality

Content

100%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is a well-structured, lean overview: it lists capabilities concisely, gives a concrete validated workflow with executable Maven commands, and correctly defers detail to a single real reference file. It respects Claude's intelligence while remaining fully actionable.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence: short bulleted capability list, tight Constraints and Workflow sections, and no padding explaining what Java, Maven, or Javadoc are. Every line earns its place.

3 / 3

Actionability

Provides concrete, copy-paste-ready commands throughout: './mvnw validate', './mvnw clean compile', './mvnw javadoc:javadoc', and a numbered workflow with explicit file-handling strategies (overwrite/add/backup/skip).

3 / 3

Workflow Clarity

The four-step workflow is clearly sequenced with an explicit validation checkpoint (validate first, stop immediately if it fails) and a final verification step (compile + javadoc:javadoc), matching the anchor for clear sequence with explicit validation steps.

3 / 3

Progressive Disclosure

SKILL.md is a concise overview that signals a single one-level-deep reference (references/170-java-documentation.md), which exists as a real file, with the detail correctly pushed into that reference rather than inlined here.

3 / 3

Total

12

/

12

Passed

Description

100%

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is strong: it states concrete capabilities, includes natural trigger phrases that users would actually say, and clearly addresses both what the skill does and when to use it. It is slightly padded by the closing 'Part of cursor-rules-java project' line, but this does not meaningfully weaken it.

DimensionReasoningScore

Specificity

Lists multiple concrete actions: 'generate or improve Java project documentation', 'README.md files', 'package-info.java files', and 'Javadoc enhancements', matching the anchor for listing several specific concrete actions.

3 / 3

Completeness

Explicitly answers both what (generate/improve Java documentation across README, package-info, Javadoc) and when ('Use when you need to...' plus 'This should trigger for requests such as...'), meeting the explicit-trigger requirement.

3 / 3

Trigger Term Quality

Includes natural phrasings users would say ('Improve the code with documentation', 'Apply documentation', 'Refactor the code with documentation') plus the concrete artifacts README.md and Javadoc, giving good coverage of natural trigger terms.

3 / 3

Distinctiveness Conflict Risk

The niche is clearly Java/Maven documentation generation with specific artifacts, and the trigger phrases are scoped to documentation tasks, making it unlikely to fire for unrelated skills.

3 / 3

Total

12

/

12

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
jabrena/cursor-rules-java
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.