170-java-documentation SKILL.md skillA
170-java-documentation from jabrena/plinth is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jabrena/plinth/170-java-documentation@v0.19.0Pins v0.19.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jabrena/plinth
- Path
skills/170-java-documentation/SKILL.md- Versions recorded
- 6
- Latest version
- v0.19.0, committed Sep 26, 2026
- First version recorded
- Apr 26, 2026
- Size
- 3,142 bytes
- Repository stars
- 461
- License
- Apache-2.0
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…
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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 - Javadoc enhancement: comprehensive `@param`/`@return`/`@throws` tags - File handling strategies: overwrite/add/backup/skip - 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 …
Read the whole file at its exact version.
How to install
mdr add jabrena/plinth/170-java-documentation@sha256:363c454a544f3f1dThe line at the top of this page pins the label v0.19.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_mhxr5gsiypto5spf)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 6 versions of this file, between Apr 26, 2026 and Sep 26, 2026, about one every 31 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v0.19.0 latest | 2026-09-26 | 9569c35 | 3,142 B | A | view · diff |
| v0.18.0 | 2026-08-01 | 26b0e71 | 3,142 B | A | view · diff |
| v0.17.0 | 2026-07-10 | aaee915 | 3,142 B | A | view · diff |
| v0.16.0 | 2026-06-15 | b73c9d3 | 2,917 B | A | view · diff |
| v0.15.0 | 2026-05-29 | a800339 | 2,917 B | A | view · diff |
| v0.15.0-SNAPSHOT | 2026-04-26 | 819f349 | 2,926 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3142 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
jabrena/plinth · 461 stars · license Apache-2.0 · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_mhxr5gsiypto5spf GET https://markdownregistry.com/api/v1/resolve?ref=jabrena/plinth/170-java-documentation GET https://markdownregistry.com/api/v1/blob/363c454a544f3f1d4e0c51503e5a6a3999ea0eae2ba1b260a349cc58b2cb8f58
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.