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 workflow
SkillScore68Maintained
Automatic
◆Doc Ops pack
Last verified 8/20/2026
What it changes
Passed 12 of 18 test cases with the skill, and 7 of 18 without it.
Without skill41%
With skill68%
Checks it passed that the model alone missed
Report the missing inputs or tooling needed for the project.
Decline to generate README.md until project validation passes.
Ask whether to proceed with setup guidance for the missing build tool.
and 8 more in the full report
9 fixed6 passed either way4 still failing3 broke
Pass-rate lift
+27 pp
Tokens
-24%
Agent turns
0%
Response time
-47%
Model gemini-3.6-flashMeasured 8/20/2026v115 of 22 cases passed with skill · 18 comparable
Tokens, turns and time describe resource use, not a dollar price.
See it in action
One of 9 test cases the skill fixed. Same model, same prompt, with and without the skill.
1 of 9
Prompt
Is the Java documentation process meant to run as an autonomous unattended background script, or is it an interactive process that asks for scope and guidance when needed?
What was checked, without and with the skill
Checked
Without skill
With skill
Operate as an interactive process requiring scope gathering and user guidance.
Missed
Passed
case-20 · gemini-3.6-flash · 8/20/2026 · answers are capped and redacted
What's inside
The instructions your model reads when the skill loads.
SKILL.md51 lines2 files
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
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
Validate project before documentation changes
Run ./mvnw validate or mvn validate and stop immediately if validation fails.
Read documentation reference and gather scope
Read references/170-java-documentation.md and identify required outputs (README, package-info, Javadoc enhancements).
Use when you need to implement or improve distributed tracing with OpenTelemetry in Java — including trace/span modeling, context propagation, semantic conventions, span attributes/events/status, sampling strategy, baggage usage, privacy safeguards, and backend integration with OTLP collectors. This should trigger for requests such as Improve tracing; Apply OpenTelemetry tracing; Add distributed tracing; Refactor tracing instrumentation; Instrument Java services with OpenTelemetry spans. Part of