170-java-documentation
Interactive guide for generating and improving Java documentation, including Javadoc and README files.
Install
mkdir -p .claude/skills/170-java-documentation && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/19416" && unzip -o skill.zip -d .claude/skills/170-java-documentation && rm skill.zipInstalls to .claude/skills/170-java-documentation
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
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 ToolkitKey capabilities
- →Generate README.md for Maven projects
- →Create package-info.java files
- →Enhance Javadoc with param, return, and throws tags
- →Validate project documentation with Maven goals
- →Apply file handling strategies like overwrite or backup
How it works
The agent follows a modular, interactive process that validates the project using Maven before applying documentation updates to ensure consistency and correctness.
Inputs & outputs
When to use 170-java-documentation
- →Generating project README files
- →Enhancing Javadoc tags
- →Creating package-info files
- →Documenting Java APIs
About this skill
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/@throwstags - File handling strategies: overwrite/add/backup/skip
- Final documentation validation with
./mvnw clean compileand./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 validateormvn validatebefore 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).
- Generate selected documentation artifacts
Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).
- 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.
When not to use it
- →Proceeding when project validation fails
- →Applying changes without verifying project state
- →Proceeding with ambiguous request scopes
Prerequisites
Limitations
- →Must stop if project validation fails
- →Requires manual clarification for ambiguous scopes
- →Requires Maven for validation
How it compares
It integrates documentation generation directly into the project validation lifecycle rather than treating it as a separate, disconnected task.
Compared to similar skills
170-java-documentation side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| 170-java-documentation (this skill) | 0 | 17d | No flags | Beginner |
| ml-paper-writing | 48 | 5mo | Review | Advanced |
| docs-review | 10 | 7mo | No flags | Beginner |
| claude-md-improver | 21 | 6mo | Review | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by jabrena
View all by jabrena →You might also like
ml-paper-writing
davila7
Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.
docs-review
metabase
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
claude-md-improver
anthropics
Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".
write-docs
tldraw
Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.
update-docs
vercel
This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.
wiki-architect
microsoft
Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.