Документация AIOps организована по разделам в соответствии с ролями и задачами пользователей.
Основные разделы
0. С чего начать
Для кого: Все новые участники проекта
Вводная информация о продукте, быстрая навигация, контакты.
1. Product (Продукт)
Для кого: PM, PO, Stakeholders, все, кто хочет понять продуктовый контекст
Продуктовое видение, фичи, требования, метрики.
Ключевые страницы: - Product Mission — миссия продукта - Authentication Feature — ключевая capability - Functional Requirements — требования
2. Domains (Домены)
Для кого: Архитекторы, Backend Engineers, DDD-практики
Доменная модель системы (Domain-Driven Design).
Ключевые страницы: - Identity Domain — домен идентичности - Domain Boundaries — границы доменов
3. Architecture (Архитектура)
Для кого: Архитекторы, Tech Leads, Senior Engineers
Системная архитектура, паттерны, принципы проектирования.
Ключевые страницы: - System Overview — обзор системы - C4 Model — диаграммы (Context, Container, Component, Deployment) - Security Architecture — безопасность
4. Engineering (Инженерия)
Для кого: Все Engineers (Backend, Frontend, Data, ML/DS, QA)
Технические детали реализации: сервисы, паттерны, best practices.
Подразделы: - Services — каталог сервисов платформы - Backend — backend архитектура и паттерны - Frontend — frontend (planned) - Data — архитектура данных - QA — тестирование
Ключевые страницы: - Service Catalog — полный список сервисов - Identity service — пример Clean Architecture
5. Platform (Платформа)
Для кого: Platform Engineers, DevOps, SRE
Инфраструктура, окружения, CI/CD, observability.
Ключевые страницы: - Infrastructure — Kubernetes, PostgreSQL, Kafka - Environments — dev, stage, prod - Observability — monitoring, logging, tracing
6. Development (Разработка)
Для кого: Все разработчики
Процесс разработки: Git workflow, code review, standards.
Ключевые страницы: - Getting Started — как начать - Git Workflow — работа с Git - Code Review Guide — ревью кода
7. Operations (Эксплуатация)
Для кого: SRE, On-call Engineers
On-call, incident management, runbooks.
Ключевые страницы: - Incident Management — управление инцидентами - Runbooks — операционные процедуры
8. Analytics (Аналитика)
Для кого: Data Analysts, Product Analytics
Метрики, дашборды, эксперименты.
Ключевые страницы: - Event Tracking Plan — план трекинга событий - Dashboards Catalog — каталог дашбордов
9. Governance (Управление)
Для кого: Tech Leads, Compliance, Security
ADR, security & compliance, ownership, glossary.
Ключевые страницы: - Decisions (ADR) — Architecture Decision Records - Security & Compliance — compliance - Glossary — термины и определения
Как искать информацию
По ролям
- Backend Engineer: Разделы 4 (Engineering), 6 (Development), 2 (Domains)
- Platform Engineer: Разделы 5 (Platform), 7 (Operations)
- Architect: Разделы 3 (Architecture), 2 (Domains), 9 (Governance)
- PM/PO: Разделы 1 (Product), 8 (Analytics)
По задачам
- Понять архитектуру сервиса: Engineering > Services > [Service Name]
- Найти API endpoint: Engineering > Services > API Gateway
- Понять event flow: Architecture > Data Flow > Event Flow
- Настроить окружение: Development > Local Setup
- Разобраться в инциденте: Operations > Runbooks
Навигационные элементы
На большинстве страниц вы найдете:
- Разделы — подстраницы текущего раздела
- Связанные страницы — перекрестные ссылки на другие разделы (Продукт ↔ Домены ↔ Архитектура ↔ Сервисы)
- Куда идти дальше — следующие шаги
Связанные страницы
- Быстрые ссылки — часто используемые страницы
- Карта репозиториев — где что лежит
- Кому писать — контакты команды