{"id":"28b07e1d-18c1-41dc-8745-3601d5a6254a","shortId":"gTjGMu","kind":"skill","title":"170-java-documentation","tagline":"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 request","description":"# Java Documentation Generator with modular step-based configuration\n\nGenerate 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**.\n\n**What is covered in this Skill?**\n\n- README.md generation for single-module and multi-module Maven projects\n- package-info.java creation with basic/detailed/minimal documentation levels\n- Javadoc enhancement: comprehensive `@param`/`@return`/`@throws` tags\n- File handling strategies: overwrite/add/backup/skip\n- Final documentation validation with `./mvnw clean compile` and `./mvnw javadoc:javadoc`\n\n## Constraints\n\nBefore applying any documentation generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.\n\n- **MANDATORY**: Run `./mvnw validate` or `mvn validate` before applying any documentation generation\n- **SAFETY**: If validation fails, stop immediately — do not proceed until all validation errors are resolved\n- **BEFORE APPLYING**: Read the reference for detailed good/bad examples, constraints, and safeguards for each documentation generation pattern\n- **EDGE CASE**: If request scope is ambiguous, stop and ask a clarifying question before applying changes\n- **EDGE CASE**: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance\n\n## When to use this skill\n\n- Improve the code with documentation\n- Apply documentation\n- Refactor the code with documentation\n\n## Workflow\n\n1. **Validate project before documentation changes**\n\nRun `./mvnw validate` or `mvn validate` and stop immediately if validation fails.\n\n2. **Read documentation reference and gather scope**\n\nRead `references/170-java-documentation.md` and identify required outputs (README, package-info, Javadoc enhancements).\n\n3. **Generate selected documentation artifacts**\n\nCreate or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).\n\n4. **Run documentation validation checks**\n\nExecute `./mvnw clean compile` and `./mvnw javadoc:javadoc` (or equivalent) to validate generated docs.\n\n## Reference\n\nFor detailed guidance, examples, and constraints, see [references/170-java-documentation.md](references/170-java-documentation.md).","tags":["170","java","documentation","cursor","rules","jabrena","agent-skills","ai-skills","claude","claude-code","claude-code-skills","claude-code-subagents"],"capabilities":["skill","source-jabrena","skill-170-java-documentation","topic-agent-skills","topic-ai-skills","topic-claude","topic-claude-code","topic-claude-code-skills","topic-claude-code-subagents","topic-claude-skills","topic-cursor-agent","topic-cursor-ai","topic-cursor-skills","topic-cursorai","topic-github-copilot"],"categories":["cursor-rules-java"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/jabrena/cursor-rules-java/170-java-documentation","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add jabrena/cursor-rules-java","source_repo":"https://github.com/jabrena/cursor-rules-java","install_from":"skills.sh"}},"qualityScore":"0.631","qualityRationale":"deterministic score 0.63 from registry signals: · indexed on github topic:agent-skills · 362 github stars · SKILL.md body (2,354 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-04-26T12:53:36.292Z","embedding":null,"createdAt":"2026-04-18T22:02:09.511Z","updatedAt":"2026-04-26T12:53:36.292Z","lastSeenAt":"2026-04-26T12:53:36.292Z","tsv":"'/mvnw':116,120,149,254,307,311 '1':247 '170':1 '2':265 '3':284 '4':301 'adapt':33 'ambigu':197 'appli':125,155,175,205,239 'artifact':288 'ask':200,222 'base':29,51,63 'basic/detailed/minimal':98 'case':192,208 'chang':206,252 'check':305 'clarifi':202 'clean':117,308 'code':236,243 'compil':118,309 'comprehens':54,103 'configur':52 'constraint':123,183,326 'cover':67,79 'creat':289 'creation':96 'detail':180,322 'doc':319 'document':4,15,37,45,57,99,113,127,157,188,238,240,245,251,267,287,292,303 'edg':191,207 'enhanc':23,102,283 'ensur':129 'equival':315 'error':144,171 'exampl':182,324 'execut':306 'fail':135,162,264 'file':18,20,108,212,297 'file-handl':296 'final':112 'gather':270 'generat':10,46,53,84,128,158,189,285,318 'good/bad':181 'guidanc':228,323 'handl':109,298 'identifi':275 'immedi':137,164,261 'improv':12,234 'includ':16 'info':281 'input':211 'interact':30,64,75 'java':3,13,44,55 'java-document':2 'javadoc':22,71,101,121,122,282,312,313 'level':100 'mandatori':147 'maven':93 'miss':216,220 'modul':88,92 'modular':26,48,60 'multi':91 'multi-modul':90 'mvn':152,257 'need':8,38 'output':277 'overwrite/add/backup/skip':111,300 'packag':280 'package-info':279 'package-info.java':19,69,95 'param':104 'pattern':190 'proceed':140,167,225 'process':31,65 'project':14,56,94,131,249 'question':203 'read':176,266,272 'readm':278 'readme.md':17,68,83 'refactor':241 'refer':178,268,320 'references/170-java-documentation.md':273,328,329 'report':217 'request':43,194 'requir':210,276 'resolv':146,173 'return':105 'run':148,253,302 'safeguard':185 'safeti':159 'scope':195,271 'see':327 'select':286,295 'setup':227 'singl':87 'single-modul':86 'skill':76,82,233 'skill-170-java-documentation' 'source-jabrena' 'specif':36 'step':28,50,62 'step-bas':27,49,61 'stop':136,163,198,260 'strategi':110,299 'tag':107 'throw':106 'tool':214 'topic-agent-skills' 'topic-ai-skills' 'topic-claude' 'topic-claude-code' 'topic-claude-code-skills' 'topic-claude-code-subagents' 'topic-claude-skills' 'topic-cursor-agent' 'topic-cursor-ai' 'topic-cursor-skills' 'topic-cursorai' 'topic-github-copilot' 'trigger':41 'updat':291 'use':5,231,293 'valid':114,132,134,143,150,153,161,170,248,255,258,263,304,317 'whether':223 'workflow':246","prices":[{"id":"6005e1bd-aa1e-4d02-b57b-fc7cf12e42be","listingId":"28b07e1d-18c1-41dc-8745-3601d5a6254a","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"jabrena","category":"cursor-rules-java","install_from":"skills.sh"},"createdAt":"2026-04-18T22:02:09.511Z"}],"sources":[{"listingId":"28b07e1d-18c1-41dc-8745-3601d5a6254a","source":"github","sourceId":"jabrena/cursor-rules-java/170-java-documentation","sourceUrl":"https://github.com/jabrena/cursor-rules-java/tree/main/skills/170-java-documentation","isPrimary":false,"firstSeenAt":"2026-04-18T22:02:09.511Z","lastSeenAt":"2026-04-26T12:53:36.292Z"}],"details":{"listingId":"28b07e1d-18c1-41dc-8745-3601d5a6254a","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"jabrena","slug":"170-java-documentation","github":{"repo":"jabrena/cursor-rules-java","stars":362,"topics":["agent-skills","ai-skills","claude","claude-code","claude-code-skills","claude-code-subagents","claude-skills","cursor-agent","cursor-ai","cursor-skills","cursorai","github-copilot","intellij-idea","java","prompting","system-prompts"],"license":"apache-2.0","html_url":"https://github.com/jabrena/cursor-rules-java","pushed_at":"2026-04-26T12:50:01Z","description":"A curated and opinionated collection of Skills and Agents to be used in modern SDLC workflows for Java Enterprise development with your favorite AI Agent harness.","skill_md_sha":"fdd98eadd76df059f474d3aea992882a1f209ed0","skill_md_path":"skills/170-java-documentation/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/jabrena/cursor-rules-java/tree/main/skills/170-java-documentation"},"layout":"multi","source":"github","category":"cursor-rules-java","frontmatter":{"name":"170-java-documentation","license":"Apache-2.0","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. Part of cursor-rules-java project"},"skills_sh_url":"https://skills.sh/jabrena/cursor-rules-java/170-java-documentation"},"updatedAt":"2026-04-26T12:53:36.292Z"}}