i18n(uk): translate 07-plugins devops-automation & documentation

- Translate READMEs, commands, agents for both plugins
- Code/config/hooks files unchanged (no translation needed)

Ref: luongnv89/claude-howto#63
This commit is contained in:
Evgenij I
2026-04-10 00:13:13 +03:00
parent 1a567be793
commit f5659be047
16 changed files with 227 additions and 227 deletions

View File

@@ -3,117 +3,117 @@
<img alt="Claude How To" src="../../resources/logos/claude-howto-logo.svg">
</picture>
# Documentation Plugin
# Плагін Documentation
Comprehensive documentation generation and maintenance for your project.
Комплексна генерація та підтримка документації для вашого проєкту.
## Features
## Функції
API documentation generation
README creation and updates
Documentation synchronization
Code comment improvements
Example generation
Генерація API-документації
Створення та оновлення README
Синхронізація документації
Покращення коментарів коду
Генерація прикладів
## Installation
## Встановлення
```bash
/plugin install documentation
```
## What's Included
## Що включено
### Slash Commands
- `/generate-api-docs` - Generate API documentation
- `/generate-readme` - Create or update README
- `/sync-docs` - Sync docs with code changes
- `/validate-docs` - Validate documentation
### Слеш-команди
- `/generate-api-docs` — Генерація API-документації
- `/generate-readme` — Створення або оновлення README
- `/sync-docs` — Синхронізація документації зі змінами коду
- `/validate-docs` — Валідація документації
### Subagents
- `api-documenter` - API documentation specialist
- `code-commentator` - Code comment improvements
- `example-generator` - Code example creation
### Субагенти
- `api-documenter` — Спеціаліст з API-документації
- `code-commentator` — Покращення коментарів коду
- `example-generator` — Створення прикладів коду
### Templates
- `api-endpoint.md` - API endpoint documentation template
- `function-docs.md` - Function documentation template
- `adr-template.md` - Architecture Decision Record template
### Шаблони
- `api-endpoint.md` — Шаблон документації ендпоінту API
- `function-docs.md` — Шаблон документації функції
- `adr-template.md` — Шаблон Architecture Decision Record
### MCP Servers
- GitHub integration for documentation syncing
### MCP-сервери
- Інтеграція з GitHub для синхронізації документації
## Usage
## Використання
### Generate API Documentation
### Генерація API-документації
```
/generate-api-docs
```
### Create README
### Створення README
```
/generate-readme
```
### Sync Documentation
### Синхронізація документації
```
/sync-docs
```
### Validate Documentation
### Валідація документації
```
/validate-docs
```
## Requirements
## Вимоги
- Claude Code 1.0+
- GitHub access (optional)
- Доступ до GitHub (опціонально)
## Example Workflow
## Приклад робочого процесу
```
User: /generate-api-docs
Claude:
1. Scans all API endpoints in /src/api/
2. Delegates to api-documenter subagent
3. Extracts function signatures and JSDoc
4. Organizes by module/endpoint
5. Uses api-endpoint.md template
6. Generates comprehensive markdown docs
7. Includes curl, JavaScript, and Python examples
1. Сканує всі API-ендпоінти в /src/api/
2. Делегує субагенту api-documenter
3. Витягує сигнатури функцій та JSDoc
4. Організує за модулями/ендпоінтами
5. Використовує шаблон api-endpoint.md
6. Генерує комплексну markdown-документацію
7. Включає приклади curl, JavaScript та Python
Result:
✅ API documentation generated
📄 Files created:
Результат:
✅ API-документація згенерована
📄 Створені файли:
- docs/api/users.md
- docs/api/auth.md
- docs/api/products.md
📊 Coverage: 23/23 endpoints documented
📊 Покриття: 23/23 ендпоінти задокументовано
```
## Templates Usage
## Використання шаблонів
### API Endpoint Template
Use for documenting REST API endpoints with full examples.
### Шаблон ендпоінту API
Використовуйте для документування REST API ендпоінтів з повними прикладами.
### Function Documentation Template
Use for documenting individual functions/methods.
### Шаблон документації функції
Використовуйте для документування окремих функцій/методів.
### ADR Template
Use for documenting architectural decisions.
### Шаблон ADR
Використовуйте для документування архітектурних рішень.
## Configuration
## Конфігурація
Set up GitHub token for documentation syncing:
Налаштуйте GitHub-токен для синхронізації документації:
```bash
export GITHUB_TOKEN="your_github_token"
```
## Best Practices
## Найкращі практики
- Keep documentation close to code
- Update docs with code changes
- Include practical examples
- Validate regularly
- Use templates for consistency
- Тримайте документацію близько до коду
- Оновлюйте документацію разом зі змінами коду
- Включайте практичні приклади
- Регулярно валідуйте
- Використовуйте шаблони для консистентності

View File

@@ -1,14 +1,14 @@
---
name: api-documenter
description: API documentation specialist
description: Спеціаліст з API-документації
tools: read, write, grep
---
# API Documenter
# API-документатор
Creates comprehensive API documentation:
- Endpoint documentation
- Parameter descriptions
- Response schemas
- Code examples (curl, JS, Python)
- Error codes
Створює комплексну API-документацію:
- Документація ендпоінтів
- Описи параметрів
- Схеми відповідей
- Приклади коду (curl, JS, Python)
- Коди помилок

View File

@@ -1,14 +1,14 @@
---
name: code-commentator
description: Code comment and inline documentation specialist
description: Спеціаліст з коментарів коду та інлайн-документації
tools: read, write, edit
---
# Code Commentator
# Коментатор коду
Improves code documentation:
- JSDoc/docstring comments
- Inline explanations
- Parameter descriptions
- Return type documentation
- Usage examples
Покращує документацію коду:
- JSDoc/docstring коментарі
- Інлайн-пояснення
- Описи параметрів
- Документація типів повернення
- Приклади використання

View File

@@ -1,14 +1,14 @@
---
name: example-generator
description: Code example and tutorial specialist
description: Спеціаліст з прикладів коду та туторіалів
tools: read, write
---
# Example Generator
# Генератор прикладів
Creates practical code examples:
- Getting started guides
- Common use cases
- Integration examples
- Best practices
- Troubleshooting scenarios
Створює практичні приклади коду:
- Гайди початку роботи
- Поширені сценарії використання
- Приклади інтеграції
- Найкращі практики
- Сценарії усунення проблем

View File

@@ -1,15 +1,15 @@
---
name: Generate API Documentation
description: Generate comprehensive API documentation from source code
description: Генерація комплексної API-документації з вихідного коду
---
# API Documentation Generator
# Генератор API-документації
Generate complete API documentation:
Генерація повної API-документації:
1. Scan API endpoints
2. Extract function signatures and JSDoc
3. Organize by module/endpoint
4. Create markdown with examples
5. Include request/response schemas
6. Add error documentation
1. Сканування API-ендпоінтів
2. Витягування сигнатур функцій та JSDoc
3. Організація за модулями/ендпоінтами
4. Створення markdown з прикладами
5. Включення схем запитів/відповідей
6. Додавання документації помилок

View File

@@ -1,15 +1,15 @@
---
name: Generate README
description: Create or update project README
description: Створення або оновлення README проєкту
---
# README Generator
# Генератор README
Generate comprehensive README:
Генерація комплексного README:
1. Project overview and description
2. Installation instructions
3. Usage examples
4. API documentation links
5. Contributing guidelines
6. License information
1. Огляд та опис проєкту
2. Інструкції з встановлення
3. Приклади використання
4. Посилання на API-документацію
5. Настанови для контриб'юторів
6. Інформація про ліцензію

View File

@@ -1,14 +1,14 @@
---
name: Sync Documentation
description: Sync documentation with code changes
description: Синхронізація документації зі змінами коду
---
# Documentation Sync
# Синхронізація документації
Synchronize documentation with codebase:
Синхронізація документації з кодовою базою:
1. Detect code changes
2. Identify outdated documentation
3. Update affected docs
4. Verify examples still work
5. Update version numbers
1. Виявлення змін коду
2. Визначення застарілої документації
3. Оновлення уражених документів
4. Перевірка працездатності прикладів
5. Оновлення номерів версій

View File

@@ -1,14 +1,14 @@
---
name: Validate Documentation
description: Validate documentation for completeness and accuracy
description: Валідація документації на повноту та точність
---
# Documentation Validation
# Валідація документації
Validate documentation quality:
Перевірка якості документації:
1. Check for broken links
2. Verify code examples
3. Ensure completeness
4. Check formatting
5. Validate against actual code
1. Перевірка на зламані посилання
2. Верифікація прикладів коду
3. Забезпечення повноти
4. Перевірка форматування
5. Валідація відповідності реальному коду