documentation

Automate JavaDoc, ADR, OpenAPI, and changelog updates in Java/Spring PR workflows.

Updated Apr 20, 2026
One-click install
npx skills add https://github.com/rivkode/reservation --skill documentation-rivkode
Or copy as Structured Prompt for Agentโ–ผ
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/rivkode/reservation/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/rivkode/reservation --skill documentation-rivkode

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Java/Spring ํ”„๋กœ์ ํŠธ์˜ ์ฝ”๋“œ ๊ตฌํ˜„ ํ›„ ๋ฌธ์„œ๋ฅผ ์ฒด๊ณ„์ ์œผ๋กœ ์ •๋ฆฌํ•˜๊ณ  ํ‘œ์ค€ํ™”ํ•ฉ๋‹ˆ๋‹ค. JavaDoc, ADR, API ๋ฌธ์„œ, ์•„ํ‚คํ…์ฒ˜ ๋‹ค์ด์–ด๊ทธ๋žจ, CHANGELOG ์—…๋ฐ์ดํŠธ๋ฅผ ๊ฐ™์€ PR์— ํฌํ•จ์‹œํ‚ค๋Š” ๊ฒƒ์„ ๋ณด์žฅํ•ฉ๋‹ˆ๋‹ค.

Core Features & Use Cases

  • JavaDoc ์ž‘์„ฑ ๋ฐ ์ปจ๋ฒค์…˜ ์ค€์ˆ˜
  • ADR ๋ฐ ์•„ํ‚คํ…์ฒ˜ ๋‹ค์ด์–ด๊ทธ๋žจ ๊ฐฑ์‹ 
  • API ๋ฌธ์„œ(OpenAPI/Swagger) ๊ฐฑ์‹  ๋ฐ README ์—…๋ฐ์ดํŠธ
  • ๋ณ€๊ฒฝ ๋กœ๊ทธ ๊ด€๋ฆฌ ๋ฐ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ๊ฐ€์ด๋“œ ์ž‘์„ฑ

Quick Start

Update JavaDoc, ADRs, OpenAPI specs, architecture diagrams, and changelogs in the same PR as code changes.

Frequently Asked Questions about documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate JavaDoc and OpenAPI updates within a Spring project PR?โ–ผ

You can automate JavaDoc and OpenAPI updates within a Spring project PR by using a Skill that enforces including documentation maintenance directly inside your code change workflows. This ensures public APIs and specs are consistently versioned.

What is the best way to manage ADRs and architecture diagrams for Java projects?โ–ผ

The best way to manage ADRs and architecture diagrams for Java projects is to automate their updates alongside code changes. This keeps architecture decisions consistently described and synchronized within the same pull request workflow.

How do I keep a CHANGELOG updated automatically when merging Java code changes?โ–ผ

You keep a CHANGELOG updated automatically by integrating documentation maintenance into your PR workflows after code completion. This approach manages changelog updates and writes migration guides simultaneously with the code modifications.

Can I generate migration guides and API documentation in the same pull request?โ–ผ

Yes, you can generate migration guides and update API documentation in the same pull request. Automating this process ensures that OpenAPI specs, READMEs, and changelogs are consistently described and versioned with the code.

Does this documentation automation work with existing Spring workflows?โ–ผ

Yes, this documentation automation works with existing Spring workflows by applying updates after code completion. It integrates directly into your PR workflows to ensure JavaDoc, ADRs, and OpenAPI specs are maintained without leaving the codebase.