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

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 SKILL.md body is well-structured and token-efficient: it presents a clear scope, concrete Maven commands, a validation-gated workflow with error-recovery feedback loops, and a single clearly-signaled reference. It exemplifies progressive disclosure without padding or explaining concepts Claude already knows.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — it states covered artifacts, constraints, and commands without explaining what Java, Maven, or Javadoc are, and every section earns its tokens.

3 / 3

Actionability

Gives concrete, executable commands ('./mvnw validate', './mvnw clean compile', './mvnw javadoc:javadoc'), specific file-handling strategies (overwrite/add/backup/skip), and an explicit reference path, providing copy-paste-ready guidance.

3 / 3

Workflow Clarity

The four-step workflow has explicit validation checkpoints — a mandatory pre-change validate-and-stop gate at step 1 and a compile+javadoc validation at step 4 — forming a validate→generate→validate feedback loop for batch documentation operations.

3 / 3

Progressive Disclosure

The body is a concise overview that signals a single, real, one-level-deep reference (references/170-java-documentation.md, verified to exist) via a clearly labeled markdown link, splitting detail appropriately out of the main file.

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 across all dimensions: it states concrete actions, includes natural trigger phrases users would say, explicitly answers both what and when, and occupies a clearly distinct Java-documentation niche. It would benefit from trimming the redundant 'Part of Plinth Toolkit' tag, but this does not affect scoring.

DimensionReasoningScore

Specificity

Lists multiple concrete documentation actions explicitly — 'README.md files, package-info.java files, and Javadoc enhancements' — matching the 'lists multiple specific concrete actions' anchor rather than the partial-coverage level 2.

3 / 3

Completeness

Explicitly answers both 'what' (generate/improve Java project documentation across README/package-info/Javadoc) and 'when' via an explicit 'Use when...' clause plus 'This should trigger for requests such as...'.

3 / 3

Trigger Term Quality

Provides natural phrases a user would say verbatim — 'Improve the code with documentation', 'Apply documentation', 'Generate README or developer documentation for a Java project' — giving good coverage of common variations.

3 / 3

Distinctiveness Conflict Risk

A clear Java-specific documentation niche with distinct triggers (README/package-info.java/Javadoc), making it unlikely to trigger for unrelated skills; not generic enough to conflict at level 2.

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/plinth
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.