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

65

Quality

78%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./skills/170-java-documentation/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

78%Weight 40%Scale 1-5

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

A well-structured, lean orchestrator skill: concise overview, concrete validation commands, a sequenced workflow with safety checkpoints, and clean one-level-deep progressive disclosure into the reference. The only notable gaps are mild redundancy and an implicit retry loop in the final validation step.

DimensionReasoningScore

Conciseness

The ~50-line body is lean, avoids explaining concepts Claude already knows, and uses tight bulleted sections; minor redundancy comes from restating validation rules in both 'Constraints' and 'Workflow' step 1 and duplicating the trigger list already in the frontmatter.

4 / 5

Actionability

Provides concrete executable commands ('./mvnw validate', './mvnw clean compile', './mvnw javadoc:javadoc') and a clear file-handling strategy set (overwrite/add/backup/skip); the detailed generation templates live in the reference, which is appropriate but leaves the inline generation guidance somewhat high-level.

4 / 5

Workflow Clarity

A clear four-step sequence with explicit validation checkpoints (validate-and-stop in step 1, validation checks in step 4) and a stop-until-resolved feedback rule; step 4's fix-and-retry loop is implicit rather than spelled out, keeping it just below a 5.

4 / 5

Progressive Disclosure

SKILL.md is a concise overview that points to a single one-level-deep reference (references/170-java-documentation.md, which contains no nested skill references), with the link clearly signaled in both the Workflow and a dedicated Reference section.

5 / 5

Total

17

/

20

Passed

Description

78%Weight 40%Scale 1-5

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

A strong description that clearly answers both 'what' and 'when' with concrete artifact types and natural trigger phrases. Its main weaknesses are second-person voice and a few generic, language-agnostic trigger terms that raise overlap risk.

Suggestions

Rewrite in third person to avoid the second-person 'you' (e.g., 'Generates and improves Java project documentation... Use when the user asks to...') so specificity is not penalized.

Tighten trigger phrases to be Java-specific (e.g., 'Generate Javadoc', 'Add package-info.java files', 'Document a Maven Java project') to reduce overlap with generic documentation skills.

Consider including the .java file extension or 'Maven' as a trigger synonym to broaden natural-term coverage.

DimensionReasoningScore

Specificity

Names the Java documentation domain and three concrete artifacts (README.md, package-info.java, Javadoc) plus a step-based process, but the verbs 'generate or improve' are generic; base 4 reduced to 3 because the description uses second person ('Use when you need to generate').

3 / 5

Completeness

Explicitly states both what it does (generate/improve README.md, package-info.java, Javadoc via a modular step-based process) and when to trigger (concrete 'This should trigger for requests such as' clause with multiple example phrases).

5 / 5

Trigger Term Quality

Lists several natural user phrasings ('Improve the code with documentation', 'Generate README or developer documentation', 'Document Java APIs architecture or project workflows'); good coverage but lacks file-extension synonyms like .java.

4 / 5

Distinctiveness Conflict Risk

The Java + Javadoc + package-info niche is mostly distinct, but several trigger phrases ('Apply documentation', 'Refactor the code with documentation') are language-agnostic and could overlap with non-Java documentation skills.

4 / 5

Total

16

/

20

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.