How do I install the 170 Java Documentation skill?

Run npx skillmds@latest add jabrena/170-java-documentation-2 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is 170 Java Documentation safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with 170 Java Documentation?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is 170 Java Documentation free to use?

Yes. Installing skills from SkillMD is free. This skill is licensed under Apache-2.

Who published 170 Java Documentation?

jabrena (@jabrena) published this skill. Their other Agent Skills are listed on their SkillMD profile.

170 Java Documentation by jabrena — Agent Skill

Name: 170 Java Documentation
Author: jabrena

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. Part of the skills-for-java project

jabrena Updated Sep 22, 2026

File contents

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

When to use this skill

Review Java code for documentation
Apply best practices for documentation in Java code

Reference

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

Frequently asked questions