Документация AqStream¶
Добро пожаловать в техническую документацию платформы AqStream.
Быстрые ссылки по ролям¶
Разработчик¶
| Задача | Документ |
|---|---|
| Начать разработку | Environments |
| Создать новый сервис | Service Template |
| Написать тесты | Testing Strategy |
| Понять API conventions | API Guidelines |
QA¶
| Задача | Документ |
|---|---|
| Стратегия тестирования | Testing Strategy |
| API документация | API Documentation |
| Окружения | Environments |
DevOps / Operations¶
| Задача | Документ |
|---|---|
| Настройка сервера | Server Setup |
| Настроить CI/CD | CI/CD |
| Деплой | Deploy |
| Мониторинг | Observability |
| Runbook | Runbook |
Business / Product¶
| Задача | Документ |
|---|---|
| Видение продукта | Vision |
| Ролевая модель | Role Model |
| План развития | Roadmap |
| Требования | Functional Requirements |
| Сценарии использования | User Journeys |
Навигация¶
Архитектура¶
| Документ | Описание |
|---|---|
| Overview | Общий обзор архитектуры |
| Service Topology | Микросервисы и их взаимодействие |
| Data Architecture | Архитектура данных, БД, кэширование |
Бизнес¶
| Документ | Описание |
|---|---|
| Vision | Видение продукта и цели |
| Role Model | Ролевая модель платформы |
| User Journeys | Сценарии использования |
| Functional Requirements | Функциональные требования |
| Roadmap | План развития |
Данные¶
| Документ | Описание |
|---|---|
| Domain Model | Модель предметной области |
| Migrations | Управление миграциями БД |
Tech Stack¶
| Документ | Описание |
|---|---|
| Overview | Обзор технологий |
| Tooling | Инструменты разработки |
Backend:
| Документ | Описание |
|---|---|
| Architecture | Архитектура backend |
| API Guidelines | Правила проектирования API |
| Common Library | Общие модули |
| Service Template | Шаблон сервиса |
| API Documentation | OpenAPI, Swagger, ReDoc |
Сервисы:
| Сервис | Описание |
|---|---|
| Gateway | API Gateway |
| User Service | Пользователи и организации |
| Event Service | События и регистрации |
| Payment Service | Платежи |
| Notification Service | Уведомления |
| Media Service | Файлы и изображения |
| Analytics Service | Аналитика |
Frontend:
| Документ | Описание |
|---|---|
| Architecture | Архитектура frontend |
| Components | Компоненты UI |
QA:
| Документ | Описание |
|---|---|
| Testing Strategy | Стратегия тестирования |
Operations¶
| Документ | Описание |
|---|---|
| Environments | Окружения |
| Server Setup | Настройка сервера |
| Deploy | Деплой |
| CI/CD | Пайплайны |
| Observability | Мониторинг и логирование |
| Runbook | Операционные процедуры |
Experience¶
| Документ | Описание |
|---|---|
| Security | Безопасность |
| Community | Контакты, лицензия |
Задачи (To-Dos)¶
| Документ | Описание |
|---|---|
| To-Dos | Задачи проекта |
| Template | Шаблон задачи |