mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-08-08 00:08:36 +02:00
Luong NGUYENandGitHub
b9a973bf32
Internal accuracy pass against v2.1.220 — no missing upstream features, but broken example code, disagreeing counts, and metadata drift.
Functional fixes: pre-commit.sh now exits 2 so it actually blocks; dependency-check.sh reads file_path from stdin JSON instead of $1; database-mcp.json uses ${DATABASE_URL}; broken fences repaired; three command templates had invalid skill names.
Factual corrections: /fork and /subtask unswapped and /subtask added; /fewer-permission-prompts; permissions.defaultMode; dontAsk/auto unreversed; 31 hook events verified name-by-name; subagent depth 3; skill precedence enterprise > project > personal; /output-style removed not deprecated; permissionDecision gained defer.
Follow-up review fixed defects the pass left behind: zh/vi headers claiming 31 events above 25-name lists, a surviving hardcoded DB credential in the MCP README examples, an unbalanced fence swallowing a metadata footer, and non-canonical tool names. All four translated CATALOG summary tables were recounted so their arithmetic holds.
Full detail in CHANGELOG.md under v2.1.220-r2.
Плагін Documentation
Комплексна генерація та підтримка документації для вашого проєкту.
Функції
✅ Генерація API-документації ✅ Створення та оновлення README ✅ Синхронізація документації ✅ Покращення коментарів коду ✅ Генерація прикладів
Встановлення
/plugin install documentation
Що включено
Слеш-команди
/generate-api-docs— Генерація API-документації/generate-readme— Створення або оновлення README/sync-docs— Синхронізація документації зі змінами коду/validate-docs— Валідація документації
Субагенти
api-documenter— Спеціаліст з API-документаціїcode-commentator— Покращення коментарів кодуexample-generator— Створення прикладів коду
Шаблони
api-endpoint.md— Шаблон документації ендпоінту APIfunction-docs.md— Шаблон документації функціїadr-template.md— Шаблон Architecture Decision Record
MCP-сервери
- Інтеграція з GitHub для синхронізації документації
Використання
Генерація API-документації
/generate-api-docs
Створення README
/generate-readme
Синхронізація документації
/sync-docs
Валідація документації
/validate-docs
Вимоги
- Claude Code 2.1+
- Доступ до 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-токен для синхронізації документації:
export GITHUB_TOKEN="your_github_token"
Найкращі практики
- Тримайте документацію близько до коду
- Оновлюйте документацію разом зі змінами коду
- Включайте практичні приклади
- Регулярно валідуйте
- Використовуйте шаблони для консистентності