# 170-java-documentation

Скилл ведёт агента по шагам и пишет README.md, package-info.java и Javadoc для Java-проекта на Maven. Пригодится, когда код есть, а документации к нему нет.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 359 установок · ★ 456
- Автор: Juan Antonio Breña Moral
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/jabrena/plinth/tree/HEAD/skills/170-java-documentation/SKILL.md
- Обновлён: 2026-10-21
- HTML: https://affpapa.org/nevibecode/skills/170-java-documentation

## Что делает

Скилл работает как пошаговый интерактивный процесс. Сначала он просит агента прогнать `./mvnw validate` или `mvn validate` и остановиться, если проверка упала. Дальше читается справочник `references/170-java-documentation.md`, уточняется объём работ: README для одного модуля или для многомодульного Maven-проекта, package-info.java, доработка Javadoc с тегами `@param`, `@return`, `@throws`. В конце — проверка результата через `./mvnw clean compile` и `./mvnw javadoc:javadoc`.

Файлы скилл трогает по выбранной стратегии: перезаписать, дописать, сделать бэкап или пропустить. Это важно, если README уже написан руками и терять его не хочется. Уровень детализации package-info тоже выбирается — от минимального до подробного.

Главное ограничение встроено в сам процесс: без прошедшей валидации проекта скилл не начинает работу. Если объём задачи непонятен или не хватает файлов и инструментов, он останавливается и задаёт вопрос, а не додумывает за вас. Проект должен быть на Maven — команды завязаны на `mvnw`.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add jabrena/plinth --skill 170-java-documentation -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/170-java-documentation/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/170-java-documentation/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add jabrena/plinth --skill 170-java-documentation -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/170-java-documentation/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add jabrena/plinth --skill 170-java-documentation -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/170-java-documentation/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install jabrena/plinth 170-java-documentation
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/170-java-documentation/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add jabrena/plinth --skill 170-java-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/jabrena/plinth --path skills/170-java-documentation
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/170-java-documentation/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add jabrena/plinth --skill 170-java-documentation -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/jabrena/plinth/tree/HEAD/skills/170-java-documentation/SKILL.md

## Когда брать
- написать README для многомодульного Maven-проекта
- добавить package-info.java в пакеты без описаний
- дополнить Javadoc тегами @param и @throws
- описать архитектуру Java API и рабочие процессы проекта
- обновить существующую документацию, не потеряв старую версию файла

## Примеры запросов агенту
- Улучши документацию в этом Java-проекте
- Сгенерируй README и developer-документацию для Maven-проекта
- Отрефактори код вместе с документацией: package-info и Javadoc

## Похожие
- [java-docs](https://affpapa.org/nevibecode/skills/java-docs.md) — скилл · 10752 установки
- [java-junit](https://affpapa.org/nevibecode/skills/java-junit.md) — скилл · 11632 установки
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [code-documentation](https://affpapa.org/nevibecode/skills/code-documentation.md) — скилл · 1900 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок

Из того же набора: [jabrena/plinth](https://affpapa.org/nevibecode/by/jabrena/plinth.md) — 40 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md