mirror of https://github.com/luongnv89/claude-howto.git synced 2026-07-07 11:17:48 +02:00

Files

T

Evgenij I 6172aacfd5 feat(uk): translate P3 examples for modules 01, 02

01-slash-commands: 7 slash command examples
02-memory: 3 CLAUDE.md examples

Progress: 25/67 files

Ref: luongnv89/claude-howto#63

2026-04-09 22:31:43 +03:00

2.5 KiB

Raw Blame History

name, description, tags

name	description	tags
Documentation Refactor	Реструктуризація документації проєкту для ясності та доступності	documentation, refactoring, organization

Рефакторинг документації

Рефакторинг структури документації проєкту з адаптацією до типу проєкту:

Аналіз проєкту: Визначити тип (бібліотека/API/веб-додаток/CLI/мікросервіси), архітектуру та персони користувачів
Централізація документації: Перемістити технічну документацію до docs/ з належними перехресними посиланнями
Кореневий README.md: Оптимізувати як точку входу з оглядом, швидким стартом, резюме модулів/компонентів, ліцензією, контактами
Документація компонентів: Додати README файли на рівні модулів/пакетів/сервісів з інструкціями налаштування та тестування
Організація docs/ за відповідними категоріями:
- Архітектура, Довідник API, База даних, Дизайн, Усунення несправностей, Деплой, Контрибʼюція (адаптувати до потреб проєкту)
Створення посібників (оберіть застосовні):
- Посібник користувача: Документація для кінцевих користувачів додатків
- Документація API: Ендпоінти, автентифікація, приклади для API
- Посібник розробника: Налаштування, тестування, процес контрибʼюції
- Посібник деплою: Деплой на продакшн для сервісів/додатків
Використання Mermaid для всіх діаграм (архітектура, потоки, схеми)

Тримайте документацію лаконічною, зручною для сканування та контекстно відповідною типу проєкту.

Останнє оновлення: 9 квітня 2026

2.5 KiB Raw Blame History

Рефакторинг документації

2.5 KiB

Raw Blame History