170-java-documentation
This Claude Code skill generates comprehensive Java project documentation including README.md files, package-info.java files, and Javadoc enhancements through an interactive step-based process. Use it when you need to improve code with documentation, apply documentation to existing projects, or refactor code while adding documentation to single-module or multi-module Maven projects.
git clone --depth 1 https://github.com/jabrena/cursor-rules-java /tmp/170-java-documentation && cp -r /tmp/170-java-documentation/skills/170-java-documentation ~/.claude/skills/170-java-documentationSKILL.md
# 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 ## Workflow 1. **Validate project before documentation changes** Run `./mvnw validate` or `mvn validate` and stop immediately if validation fails. 2. **Read documentation reference and gather scope** Read `references/170-java-documentation.md` and identify required outputs (README, package-info, Javadoc enhancements). 3. **Generate selected documentation artifacts** Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip). 4. **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](references/170-java-documentation.md).
Use when you need to generate a checklist document with Java system prompts, following the embedded template exactly and producing INVENTORY-SKILLS-JAVA.md in the project root. This should trigger for requests such as Create Java system prompts checklist; Generate INVENTORY-SKILLS-JAVA.md; Use @001-skills-inventory. Part of cursor-rules-java project
Use when you need to generate a checklist document with embedded agents inventory, following the embedded template exactly and producing INVENTORY-AGENTS-JAVA.md in the project root. This should trigger for requests such as Create embedded agents inventory checklist; Generate INVENTORY-AGENTS-JAVA.md; Use @002-agents-inventory. Part of cursor-rules-java project
Use when you need to install the embedded robot agents into either .cursor/agents or .claude/agents, selecting the destination interactively and copying the embedded agent definitions from project assets. This should trigger for requests such as Install embedded agents; Bootstrap .cursor/agents; Bootstrap .claude/agents; Copy robot agents. Part of cursor-rules-java project
Guides the creation of agile epics with comprehensive definition including business value, success criteria, and breakdown into user stories. Use when the user wants to create an agile epic, define large bodies of work, break down features into user stories, or document strategic initiatives. This should trigger for requests such as Create an agile epic; Write an epic; I need to create an epic; Define an epic; Epic definition. Part of cursor-rules-java project
Guides the creation of detailed agile feature documentation from an existing epic. Use when the user wants to split an epic into feature files, derive features with scope and acceptance criteria, or plan feature documentation for stakeholders or engineering. This should trigger for requests such as Create features from an epic; Split epic into features; Feature files from epic; Derive features from epic. Part of cursor-rules-java project
Guides the creation of agile user stories and Gherkin feature files. Use when the user wants to create a user story, write acceptance criteria, define Gherkin scenarios, or author BDD feature files. This should trigger for requests such as Create a user story; Write a user story; I need to write a user story. Part of cursor-rules-java project
Use when you need to generate Architecture Decision Records (ADRs) for a Java project through an interactive, conversational process that systematically gathers context, stakeholders, options, and outcomes to produce well-structured ADR documents. This should trigger for requests such as Generate ADR; Create Architecture Decision Record; Document architecture decision; Architecture Decision Record for Java. Part of cursor-rules-java project
Facilitates conversational discovery to create Architectural Decision Records (ADRs) for functional requirements covering CLI, REST/HTTP APIs, or both. Use when the user wants to document command-line or HTTP service architecture, capture functional requirements, create ADRs for CLI or API projects, or design interfaces with documented decisions. This should trigger for requests such as Create ADR for functional requirements; Document functional requirements; Capture functional requirements; Generate functional requirements in an ADR. Part of cursor-rules-java project