mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-07-11 23:26:32 +02:00
qszhu
120 lines
3.9 KiB
Markdown
120 lines
3.9 KiB
Markdown
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="../../../resources/logos/claude-howto-logo-dark.svg">
|
|
<img alt="Claude How To" src="../../../resources/logos/claude-howto-logo.svg">
|
|
</picture>
|
|
|
|
# Плагін Documentation
|
|
|
|
Комплексна генерація та підтримка документації для вашого проєкту.
|
|
|
|
## Функції
|
|
|
|
✅ Генерація API-документації
|
|
✅ Створення та оновлення README
|
|
✅ Синхронізація документації
|
|
✅ Покращення коментарів коду
|
|
✅ Генерація прикладів
|
|
|
|
## Встановлення
|
|
|
|
```bash
|
|
/plugin install documentation
|
|
```
|
|
|
|
## Що включено
|
|
|
|
### Слеш-команди
|
|
- `/generate-api-docs` — Генерація API-документації
|
|
- `/generate-readme` — Створення або оновлення README
|
|
- `/sync-docs` — Синхронізація документації зі змінами коду
|
|
- `/validate-docs` — Валідація документації
|
|
|
|
### Субагенти
|
|
- `api-documenter` — Спеціаліст з API-документації
|
|
- `code-commentator` — Покращення коментарів коду
|
|
- `example-generator` — Створення прикладів коду
|
|
|
|
### Шаблони
|
|
- `api-endpoint.md` — Шаблон документації ендпоінту API
|
|
- `function-docs.md` — Шаблон документації функції
|
|
- `adr-template.md` — Шаблон Architecture Decision Record
|
|
|
|
### MCP-сервери
|
|
- Інтеграція з GitHub для синхронізації документації
|
|
|
|
## Використання
|
|
|
|
### Генерація API-документації
|
|
```
|
|
/generate-api-docs
|
|
```
|
|
|
|
### Створення README
|
|
```
|
|
/generate-readme
|
|
```
|
|
|
|
### Синхронізація документації
|
|
```
|
|
/sync-docs
|
|
```
|
|
|
|
### Валідація документації
|
|
```
|
|
/validate-docs
|
|
```
|
|
|
|
## Вимоги
|
|
|
|
- Claude Code 1.0+
|
|
- Доступ до GitHub (опціонально)
|
|
|
|
## Приклад робочого процесу
|
|
|
|
```
|
|
User: /generate-api-docs
|
|
|
|
Claude:
|
|
1. Сканує всі API-ендпоінти в /src/api/
|
|
2. Делегує субагенту api-documenter
|
|
3. Витягує сигнатури функцій та JSDoc
|
|
4. Організує за модулями/ендпоінтами
|
|
5. Використовує шаблон api-endpoint.md
|
|
6. Генерує комплексну markdown-документацію
|
|
7. Включає приклади curl, JavaScript та Python
|
|
|
|
Результат:
|
|
✅ API-документація згенерована
|
|
📄 Створені файли:
|
|
- docs/api/users.md
|
|
- docs/api/auth.md
|
|
- docs/api/products.md
|
|
📊 Покриття: 23/23 ендпоінти задокументовано
|
|
```
|
|
|
|
## Використання шаблонів
|
|
|
|
### Шаблон ендпоінту API
|
|
Використовуйте для документування REST API ендпоінтів з повними прикладами.
|
|
|
|
### Шаблон документації функції
|
|
Використовуйте для документування окремих функцій/методів.
|
|
|
|
### Шаблон ADR
|
|
Використовуйте для документування архітектурних рішень.
|
|
|
|
## Конфігурація
|
|
|
|
Налаштуйте GitHub-токен для синхронізації документації:
|
|
```bash
|
|
export GITHUB_TOKEN="your_github_token"
|
|
```
|
|
|
|
## Найкращі практики
|
|
|
|
- Тримайте документацію близько до коду
|
|
- Оновлюйте документацію разом зі змінами коду
|
|
- Включайте практичні приклади
|
|
- Регулярно валідуйте
|
|
- Використовуйте шаблони для консистентності
|