New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

170 Java Documentation

by jabrena in jabrena/plinth

A skill your agent uses 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…

Apache-2.0Auto-check passedDevelopment

Install 170 Java Documentation

skills CLI
$ npx skills add jabrena/plinth --skill 170-java-documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jabrena/plinth 170-java-documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jabrena/plinth.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/170-java-documentation .claude/skills/170-java-documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
170-java-documentation
GitHub stars
446
Token cost
~784 tokens
SKILL.md length
285 words
Files
2 (incl. references)
Skills in repo
124
Repo updated
First seen
Licence
Apache-2.0

At a glance

A skill your agent uses 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…

  • You need to generate
  • SKILL.md covers Constraints, When to use this skill, Workflow and Reference
  • Calls mvn
  • Improve Java project documentation — including README.md files

What it does

170 Java Documentation is an agent skill from jabrena/plinth. 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…

Its SKILL.md is about 780 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/170-java-documentation.md`).

It sits in Development, covering Technical documentation and Refactoring. It works with Java. The repository describes itself as: Plinth is an AI-native engineering toolkit for modern Java enterprise SDLC, built around reusable Commands, Agents, Skills, and MCP Servers. The licence is Apache-2.0.

When your agent uses it

  • You need to generate
  • Improve Java project documentation — including README.md files
  • Package-info.java files
  • Javadoc enhancements — through a modular

Example prompts

  • “/170-java-documentation”

What it can do on your machine

Read from SKILL.md and the folder at commit dca88dc. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • mvn

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

170 Java Documentation loads about 784 tokens when it runs, and up to ~8.2k if it reads all its reference files. Until then it costs about 137 tokens; SKILL.md has 285 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~137
When it runs · the whole SKILL.md, loaded when a task matches
~784
With references · SKILL.md plus every file in references/, read only if the agent opens them
~8.2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jabrena/plinth at commit dca88dc, republished under its Apache-2.0 licence (© jabrena). 285 words, ~784 tokens.

Download SKILL.mdSave it as .claude/skills/170-java-documentation/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
170-java-documentation
description
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
license
Apache-2.0
metadata.author
Juan Antonio Breña Moral
metadata.version
0.19.0

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
  • 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

  1. Validate project before documentation changes

Run ./mvnw validate or mvn validate and stop immediately if validation fails.

  1. Read documentation reference and gather scope

Read references/170-java-documentation.md and identify required outputs (README, package-info, Javadoc enhancements).

  1. Generate selected documentation artifacts

Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).

  1. Run documentation validation checks

Execute ./mvnw clean compile and ./mvnw javadoc:javadoc (or equivalent) to validate generated docs.

Reference

For detailed guidance, examples, and constraints, see references/170-java-documentation.md.

© jabrena, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in skills/170-java-documentation of jabrena/plinth.

  • SKILL.md
  • references/170-java-documentation.md

Open the folder on GitHubat commit dca88dc

Compare with similar skills

170 Java Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

170 Java Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
170 Java Documentation this skilljabrena/plinth446—~784Automated safety check: PassApache-2.0
Mkdocsjeka-dev/jeka176—~2kAutomated safety check: PassApache-2.0
Java Design Patterns Referencedecebals/claude-code-java7511 repos~4.4kAutomated safety check: PassMIT
Enforce Rules For Typescriptmoeru-ai/airi50k—~3.4kAutomated safety check: PassMIT
Bootui Java Developmentjdubois/boot-ui307—~1.3kAutomated safety check: PassApache-2.0
Releasesol4k/sol4k135—~949Automated safety check: PassApache-2.0

Similar skills

  • Mkdocs

    jeka-dev/jeka

    MkDocs documentation project reference covering CLI commands, mkdocs.yml configuration, Material theme setup, and plugin integration.

    176 GitHub stars~2k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed

  • Java Design Patterns Reference

    decebals/claude-code-java

    A practical Java reference for Builder, Factory, Singleton, Strategy, Observer and other patterns, with a table matching problems to patterns.

    751 GitHub starsUsed in 1 repo~4.4k tokens
    DevelopmentAuto-check passed

  • Enforce Rules For Typescript

    moeru-ai/airi

    Enforce AIRI's TypeScript and Vue source rules for imports, naming, comments, JSDoc, fallbacks, stateful and protocol code, and module design.

    50k GitHub stars~3.4k tokensUpdated today
    DevelopmentAuto-check passed

  • Bootui Java Development

    jdubois/boot-ui

    A skill your agent uses when implementing, debugging, refactoring, or testing existing BootUI Java code, including framework-neutral engine logic, Spring MVC and WebFlux adapters, Quarkus runtime…

    307 GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed

  • Release

    sol4k/sol4k

    Bump the sol4k library version everywhere, open a release PR, and draft GitHub release notes.

    135 GitHub stars~949 tokensUpdated 10 days ago
    DevelopmentAuto-check passed

  • Go

    inference-gateway/inference-gateway

    Idiomatic Go - package and interface design, error wrapping, table-driven tests, generics, the modern standard library (slices/maps/cmp/errors.Join), current syntax, and logging discipline.

    214 GitHub stars~2.4k tokensUpdated yesterday
    DevelopmentAuto-check passed

More from jabrena/plinth

All 124 skills in this repo

  • 703 Technologies Fuzzing Testing

    jabrena/plinth

    A skill your agent uses when you need to add or review fuzz testing for Java APIs with CATS — including contract-driven negative testing, malformed payload validation, boundary input exploration, CI…

    446 GitHub stars~874 tokensUpdated today
    Auto-check passed

  • 033 Architecture Diagrams

    jabrena/plinth

    A skill your agent uses when you need to generate Java project diagrams — including UML sequence diagrams, UML class diagrams, C4 model diagrams, UML state machine diagrams, UML Deployment Diagrams…

    446 GitHub stars~3.1k tokensUpdated today
    Auto-check passed

  • 112 Java Maven Plugins

    jabrena/plinth

    A skill your agent uses when you need to add or configure Maven plugins in your pom.xml — including quality tools (enforcer, surefire, failsafe, jacoco, pitest, spotbugs, pmd), security scanning…

    446 GitHub stars~3.2k tokensUpdated today
    Auto-check passed

  • 151 Java Performance Jmeter

    jabrena/plinth

    A skill your agent uses when you need to set up JMeter performance testing for a Java project — including creating the run-jmeter.sh script from the exact template, configuring load tests with…

    446 GitHub stars~842 tokensUpdated today
    Auto-check passed

  • 161 Java Profiling Detect

    jabrena/plinth

    A skill your agent uses when you need to set up Java application profiling to detect and measure performance issues — including trusted preinstalled async-profiler v4.x setup, problem-driven…

    446 GitHub stars~903 tokensUpdated today
    Auto-check passed

  • 001 Commands Inventory

    jabrena/plinth

    A skill your agent uses when you need to generate a checklist document with embedded commands inventory, following the embedded template exactly and producing INVENTORY-COMMANDS-JAVA.md in the…

    446 GitHub stars~697 tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about 170 Java Documentation

What does 170 Java Documentation do?

A skill your agent uses 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…. 170 Java Documentation is an agent skill from jabrena/plinth.java files, and Javadoc enhancements — through a modular, step-based interactive process that adapts to your specific documentation needs.

When should I use 170 Java Documentation?

170 Java Documentation fits situations like: you need to generate; improve Java project documentation — including README.md files; package-info.java files; javadoc enhancements — through a modular.

How do I install 170 Java Documentation in Claude Code?

Run `npx skills add jabrena/plinth --skill 170-java-documentation -a claude-code`. Or copy the skill folder (skills/170-java-documentation in jabrena/plinth) into .claude/skills/170-java-documentation in your project. Claude Code loads it when a task matches its description.

How do I install 170 Java Documentation in Codex?

Run `npx skills add jabrena/plinth --skill 170-java-documentation -a codex`. Or copy the skill folder (skills/170-java-documentation in jabrena/plinth) into .agents/skills/170-java-documentation in your project. Codex loads it when a task matches its description.

Can I use 170 Java Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jabrena/plinth --skill 170-java-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/170-java-documentation, .gemini/skills/170-java-documentation, .github/skills/170-java-documentation and .opencode/skills/170-java-documentation in your project.

What does 170 Java Documentation need to run?

Going by SKILL.md and its folder, 170 Java Documentation needs the command-line tools its instructions call (mvn).

Does 170 Java Documentation access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is 170 Java Documentation safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does 170 Java Documentation use?

170 Java Documentation is published under the Apache-2.0 licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does 170 Java Documentation use?

About 784 tokens (SKILL.md is roughly 3.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 7.4k tokens, read only when the agent opens those files.

What are the alternatives to 170 Java Documentation?

Skills that share tags, products or a category with 170 Java Documentation: Mkdocs (jeka-dev/jeka, 176 stars), Java Design Patterns Reference (decebals/claude-code-java, 751 stars), Enforce Rules For Typescript (moeru-ai/airi, 50k stars) and Bootui Java Development (jdubois/boot-ui, 307 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains 170 Java Documentation?

jabrena (a GitHub user) maintains it in jabrena/plinth, which has 446 GitHub stars. The repository holds 124 skills in this directory. The repository was last updated on October 7, 2026.

Source: jabrena/plinth on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.