6172aacfd5
01-slash-commands: 7 slash command examples 02-memory: 3 CLAUDE.md examples Progress: 25/67 files Ref: luongnv89/claude-howto#63
28 lines
2.5 KiB
Markdown
28 lines
2.5 KiB
Markdown
---
|
|
name: Documentation Refactor
|
|
description: Реструктуризація документації проєкту для ясності та доступності
|
|
tags: documentation, refactoring, organization
|
|
---
|
|
|
|
# Рефакторинг документації
|
|
|
|
Рефакторинг структури документації проєкту з адаптацією до типу проєкту:
|
|
|
|
1. **Аналіз проєкту**: Визначити тип (бібліотека/API/веб-додаток/CLI/мікросервіси), архітектуру та персони користувачів
|
|
2. **Централізація документації**: Перемістити технічну документацію до `docs/` з належними перехресними посиланнями
|
|
3. **Кореневий README.md**: Оптимізувати як точку входу з оглядом, швидким стартом, резюме модулів/компонентів, ліцензією, контактами
|
|
4. **Документація компонентів**: Додати README файли на рівні модулів/пакетів/сервісів з інструкціями налаштування та тестування
|
|
5. **Організація `docs/`** за відповідними категоріями:
|
|
- Архітектура, Довідник API, База даних, Дизайн, Усунення несправностей, Деплой, Контрибʼюція (адаптувати до потреб проєкту)
|
|
6. **Створення посібників** (оберіть застосовні):
|
|
- Посібник користувача: Документація для кінцевих користувачів додатків
|
|
- Документація API: Ендпоінти, автентифікація, приклади для API
|
|
- Посібник розробника: Налаштування, тестування, процес контрибʼюції
|
|
- Посібник деплою: Деплой на продакшн для сервісів/додатків
|
|
7. **Використання Mermaid** для всіх діаграм (архітектура, потоки, схеми)
|
|
|
|
Тримайте документацію лаконічною, зручною для сканування та контекстно відповідною типу проєкту.
|
|
|
|
---
|
|
**Останнє оновлення**: 9 квітня 2026
|