jyjeanne/java-docs
skills/java-docs/SKILL.md
Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.
$ install --global
skillsauthnpx skillsauth add jyjeanne/ai-setup-forge java-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 23, 2026, 1:10 AM133.2s1 file scanned
SKILL.md
- name:
- java-docs
- description:
- Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.
Java Documentation (Javadoc) Best Practices
- Public and protected members should be documented with Javadoc comments.
- It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.
- The first sentence of the Javadoc comment is the summary description. It should be a concise overview of what the method does and end with a period.
- Use
@paramfor method parameters. The description starts with a lowercase letter and does not end with a period. - Use
@returnfor method return values. - Use
@throwsor@exceptionto document exceptions thrown by methods. - Use
@seefor references to other types or members. - Use
{@inheritDoc}to inherit documentation from base classes or interfaces.- Unless there is major behavior change, in which case you should document the differences.
- Use
@param <T>for type parameters in generic types or methods. - Use
{@code}for inline code snippets. - Use
<pre>{@code ... }</pre>for code blocks. - Use
@sinceto indicate when the feature was introduced (e.g., version number). - Use
@versionto specify the version of the member. - Use
@authorto specify the author of the code. - Use
@deprecatedto mark a member as deprecated and provide an alternative.
Related Skills
jyjeanne/legacy-circuit-mockups
development
VerifiedTrustedCommunity
Generate breadboard circuit mockups and visual diagrams using HTML5 Canvas drawing techniques. Use when asked to create circuit layouts, visualize electronic component placements, draw breadboard diagrams, mockup 6502 builds, generate retro computer schematics, or design vintage electronics projects. Supports 555 timers, W65C02S microprocessors, 28C256 EEPROMs, W65C22 VIA chips, 7400-series logic gates, LEDs, resistors, capacitors, switches, buttons, crystals, and wires.
1SKILL.mdUpdated Apr 6, 2026
jyjeanne/lean-ux
development
VerifiedTrustedCommunity
Apply lean thinking to UX: hypothesis-driven design, collaborative sketching, and rapid experiments instead of heavy deliverables. Use when the user mentions "Lean UX", "design hypothesis", "UX experiment", "collaborative design", or "outcome over output". Covers hypothesis statements, MVPs for UX, and cross-functional collaboration. For Build-Measure-Learn, see lean-startup. For usability audits, see ux-heuristics.
1SKILL.mdUpdated Apr 6, 2026
jyjeanne/lean-startup
development
VerifiedTrustedCommunity
Design MVPs, validated learning experiments, and pivot-or-persevere decisions using Build-Measure-Learn. Use when the user mentions "MVP scope", "validated learning", "pivot or persevere", "vanity metrics", or "test assumptions". Covers innovation accounting and actionable metrics. For 5-day prototype testing, see design-sprint. For customer motivation analysis, see jobs-to-be-done.
1SKILL.mdUpdated Apr 6, 2026
jyjeanne/langsmith
tools
VerifiedTrustedCommunity
Instrument, trace, evaluate, and monitor LLM applications and AI agents with LangSmith. Use when setting up observability for LLM pipelines, running offline or online evaluations, managing prompts in the Prompt Hub, creating datasets for regression testing, or deploying agent servers. Triggers on: langsmith, langchain tracing, llm tracing, llm observability, llm evaluation, trace llm calls, @traceable, wrap_openai, langsmith evaluate, langsmith dataset, langsmith feedback, langsmith prompt hub, langsmith project, llm monitoring, llm debugging, llm quality, openevals, langsmith cli, langsmith experiment, annotate llm, llm judge.
1SKILL.mdUpdated Apr 6, 2026