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. 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
- Installs
- 362
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/jabrena/plinth --skill 170-java-documentation- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads 170-java-documentation automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
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.
FAQ
What does the 170-java-documentation skill do?
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
How do I install 170-java-documentation?
Run npx skills add https://github.com/jabrena/plinth --skill 170-java-documentation in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/170-java-documentation/ (personal) or .claude/skills/170-java-documentation/ (project).
Which AI agents can use 170-java-documentation?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is 170-java-documentation safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains 170-java-documentation?
It is published by jabrena in jabrena/plinth. It has 362 recorded installs.
More from jabrena/plinth
110-java-maven-best-practices
jabrena/plinth
Use when you need to review, improve, or troubleshoot a Maven pom.xml file — including dependency management with BOMs, plugin configuration, version centralization, multi-module project structure, build profiles, or any situation where you want to align your Maven setup with industry best practices. This should trigger for requests such as Review pom.xml to improve it; Apply Maven best practices to pom.xml; Improve Maven POM configuration; Review Maven dependency management and plugin configuration; Modernize Maven build conventions for a Java project. Part of Plinth Toolkit
121-java-object-oriented-design
jabrena/plinth
Open the skill to read its SKILL.md instructions.
124-java-secure-coding
jabrena/plinth
Use when you need to apply Java secure coding best practices — including validating untrusted inputs, defending against injection attacks with parameterized queries, minimizing attack surface via least privilege, applying strong cryptographic algorithms, handling exceptions securely without exposing sensitive data, managing secrets at runtime, avoiding unsafe deserialization, and encoding output to prevent XSS. This should trigger for requests such as Review Java code for secure coding; Find input validation risks in Java code; Review Java code for injection vulnerabilities; Improve secure error handling in Java services; Harden Java code against common security flaws. Part of Plinth Toolkit
131-java-testing-unit-testing
jabrena/plinth
Open the skill to read its SKILL.md instructions.
141-java-refactoring-with-modern-features
jabrena/plinth
Open the skill to read its SKILL.md instructions.
125-java-concurrency
jabrena/plinth
Open the skill to read its SKILL.md instructions.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.