CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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

82%

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

SKILL.md
Quality
Evals
Security

Quality

Content

71%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 overview body with concrete Maven validation commands and proper progressive disclosure to a single one-level-deep reference file. The main costs are redundancy (a duplicated stop-on-failure sentence and a trigger list that mirrors the description) and an implicit rather than explicit fix-and-retry recovery loop.

Suggestions

Deduplicate the stop-on-failure rule: state it once (the SAFETY bullet already covers the Constraints intro sentence) to reclaim tokens.

Drop or condense the 'When to use this skill' section — it repeats the five trigger phrases verbatim from the frontmatter description, which is already loaded at skill selection time.

Make the error-recovery loop explicit in the Workflow: after step 1's validation failure, spell out 'fix reported errors, then re-run ./mvnw validate until it passes' instead of only 'stop immediately'.

DimensionReasoningScore

Conciseness

The body is mostly lean, but 'stop immediately — do not proceed until all validation errors are resolved' appears nearly verbatim twice (Constraints intro and the SAFETY bullet), the 'When to use this skill' section re-lists the exact triggers already in the frontmatter description, and 'modular, step-based interactive process' is filler — clearly could be tightened.

3 / 5

Actionability

Gives concrete, runnable commands ('./mvnw validate', './mvnw clean compile', './mvnw javadoc:javadoc'), names the file-handling strategies (overwrite/add/backup/skip), and points to the real reference file, though step 3 ('Generate selected documentation artifacts') stays high-level and defers specifics to the reference.

4 / 5

Workflow Clarity

The 4-step sequence is explicit with validation checkpoints before and after generation and a clear stop-on-failure rule, but the error-recovery path is a one-way stop ('do not proceed until resolved') rather than an explicit validate→fix→retry feedback loop.

4 / 5

Progressive Disclosure

The body is a concise overview and all detailed guidance lives one level deep in references/170-java-documentation.md (verified present), which is clearly signaled twice — in the constraints and a dedicated Reference section — with no nested reference chains.

5 / 5

Total

16

/

20

Passed

Description

83%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 states what the skill does and when it should trigger, with concrete artifact names and literal user request phrasings. Weaknesses are limited to filler process language, second-person voice, and a couple of overly generic trigger phrases.

DimensionReasoningScore

Specificity

Names multiple concrete artifacts and actions — 'generate or improve Java project documentation — including README.md files, package-info.java files, and Javadoc enhancements' — giving near-comprehensive domain coverage, but the vague filler 'through a modular, step-based interactive process that adapts to your specific documentation needs' and the second-person 'Use when you need to' keep it below the top anchor.

4 / 5

Completeness

Explicitly answers what ('generate or improve Java project documentation — including README.md files, package-info.java files, and Javadoc enhancements') and when ('Use when you need to generate or improve…' reinforced by 'This should trigger for requests such as…') with concrete trigger phrases, matching the top anchor.

5 / 5

Trigger Term Quality

Quotes literal user phrasings ('Improve the code with documentation', 'Generate README or developer documentation for a Java project') plus strong keywords (README, Javadoc, Java), but misses common variations like 'add Javadoc comments', 'write docs', or '.java'.

4 / 5

Distinctiveness Conflict Risk

The Java/Javadoc/package-info niche is mostly distinct, but generic trigger phrases like 'Apply documentation' and 'Refactor the code with documentation' could fire for non-Java documentation requests, leaving minor overlap risk with a sibling skill.

4 / 5

Total

17

/

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

jabrena/plinth

Path

skills/170-java-documentation/SKILL.md

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.