Документация проекта

Обязательные материалы

Каждый проект должен содержать следующие документы:

Шаблоны и чек-листы

Мы подготовили готовые шаблоны для всех необходимых документов:

Требования к README.md

README должен содержать следующие обязательные секции:

1. Описание проекта

• Проблема: Какую проблему решает проект (2-3 предложения)
• Решение: Как AI-система решает проблему
• Целевая аудитория: Кто будет использовать

2. Команда

Таблица с информацией о каждом участнике:

3. Архитектура

• Технологический стек: LLM, VLM, RAG, Backend, Frontend, DevOps
• Диаграмма системы: Mermaid или изображение
• Описание AI pipeline: Как данные проходят через систему

4. Установка и запуск

# Клонировать репозиторий
git clone https://github.com/your-org/project.git

# Настроить окружение
cp .env.example .env

# Запустить через Docker Compose
docker-compose up -d

Обязательно указать:

• Требования (Docker версия, Node.js и т.д.)
• Порты на которых доступны сервисы
• Переменные окружения

5. Демо и результаты

• Скриншоты: Минимум 3-4 основных экрана
• Видео: Ссылка на видео демонстрацию
• Метрики: Response time, token usage, test coverage

6. Документация

Ссылки на:

• API Reference (Swagger/OpenAPI)
• Architecture Decision Records
• Deployment Guide

Требования к презентации

Структура (10-12 слайдов, 10 минут)

1. Титульный слайд — название, команда, дата
2. Проблема (SA/PO, 2 мин) — что решаем и почему важно
3. Решение (SA/PO + AI Engineer, 2 мин) — как AI решает проблему
4. Технологии (AI Engineer + MLOps, 1 мин) — стек и архитектура
5. Демо (Fullstack, 3 мин) — показать работу системы
6. Метрики (MLOps + AI Engineer, 1 мин) — результаты и производительность
7. Уроки (SA/PO, 1 мин) — что узнали, челленджи
8. Roadmap — что сделано, что планируется

Распределение времени по ролям

• SA/PO 🔴: 2-3 минуты (проблема, решение, итоги)
• AI Engineer 🟣: 2-3 минуты (AI pipeline, модели, A/B тесты)
• MLOps 🟢: 2-3 минуты (инфраструктура, CI/CD, Grafana)
• Fullstack 🟠: 2-3 минуты (UX, демо интерфейса)

Требования к дизайну

• ✅ Читаемые шрифты (минимум 24pt)
• ✅ Контрастные цвета
• ✅ Больше визуалов, меньше текста
• ✅ Единый стиль
• ❌ Не читать текст со слайдов
• ❌ Не перегружать информацией

Требования к видео демо

Что показать (2-5 минут)

1. Вступление (10 сек): название и команда
2. Проблема (20 сек): что решаем
3. Демо интерфейса (2-3 мин): основной user flow
4. Behind the scenes (30 сек): Langfuse, Grafana
5. Заключение (10 сек): призыв попробовать

Технические требования

• Разрешение: минимум 1080p
• Формат: MP4 (H.264)
• Звук: качественный микрофон
• Длительность: 2-5 минут
• Хостинг: YouTube (unlisted) или Loom

Чек-лист готовности к Demo Day

Критерии оценки документации

Документация оценивается как часть общей оценки за проект:

Полезные ссылки