GOLOOT Knowledge Base
Внутренняя документация проекта GOLOOT — Telegram Mini App платформа для викторин с геймификацией.
Цель документации
Сохранение контекста бизнес-решений и архитектурных выборов:
- Почему сделано именно так, а не иначе
- Какие бизнес-правила действуют в каждом домене
- Где находится код для каждой функциональности
Структура документации
Domains — Бизнес-домены
Основная документация организована по доменам:
| Категория | Описание | Домены |
|---|---|---|
| Economy | Экономические механики | Cases, Daily Spins, Inventory, Craft, Budget, Withdrawals |
| Gamification | Геймификация | Quizzes, Quests, Achievements, Streaks, Buffs, Seasons |
| Users | Пользователи | Profile, Onboarding, Settings |
| Social | Социальные механики | Referrals, Leaderboard, Feed, Raffle |
| Marketing | Маркетинг | UTM Tracking, Promo Codes, Banners, Notifications |
| Integrations | Интеграции | Telegram Bot, Steam Trade, Rust Plugin |
| Admin | Администрирование | User Management, Analytics, Feedback |
Glossary — Терминология
Централизованный глоссарий всех терминов проекта.
Architecture — Архитектура
(В процессе наполнения)
UI/UX — Дизайн-решения
UI/UX guidelines и ADR (Architectural Decision Records) по компонентам интерфейса:
- Design Principles — базовые принципы TMA
- Inventory Cards — решения по карточкам инвентаря
Как использовать
- Ищешь информацию о домене → Перейди в соответствующую категорию
- Хочешь понять "почему так" → Смотри секцию ADR в каждом документе
- Нужны API эндпоинты → В каждом документе есть ссылки на API Reference
Статус документации
⚠️ Документация в процессе наполнения
Большинство файлов содержат заглушки с TODO. Заполняются постепенно.
Полностью задокументировано:
- ✅ Cases — пример полной документации
Заглушки готовы для заполнения:
- Economy: 5 файлов
- Gamification: 6 файлов
- Users: 3 файла
- Social: 4 файла
- Marketing: 4 файла
- Integrations: 3 файла
- Admin: 3 файла
При изменении кода — обновляй соответствующую документацию.