diff --git a/PRODUCT.md b/PRODUCT.md index 1c9b4f2..0895b7a 100644 --- a/PRODUCT.md +++ b/PRODUCT.md @@ -33,6 +33,8 @@ AI Code Review бот для российских Git-платформ Готовый инструмент для пользователей открытых git-платформ +Готовое приложение, подвязывающееся по git к репозиторию и анализирующее его + ### 5. Каналы Яндекс директ @@ -44,7 +46,7 @@ AI Code Review бот для российских Git-платформ ### 6. Потоки прибыли -Формат подписки для пользователей существующих открытых git-платформ. +Формат подписки для пользователей существующих открытых git-платформ и пользователей приложения. Тариф для компаний (для доступа всех сотрудников одной компании к системе) @@ -60,4 +62,151 @@ AI Code Review бот для российских Git-платформ Количество использованний AI-агентов для ревью -Количество сайтов, подключивших систему \ No newline at end of file +Количество сайтов, подключивших систему + + +## Основные роли +Backend-Разработчики - пишет код с бизнес-логикой и связкой с AI-ботами, создаёт pull/merge requests, получает ревью. + +UI/UX Designer - проектирует логику пользовательского пути (UX) и отрисовывает визуальный интерфейс (UI). + +Fontend-Разработчики - берет проекты дизайнеров и пишет frontend. + +Team Lead - Проверяет код, принимает решения по merge, следит за качеством. + +DevOps / Администратор Git-платформы - настраивает интеграции, управляет доступами. + +## User Stories +### Для разработчиков-клиентов: +Как разработчик, я хочу получать автоматические комментарии к коду, чтобы быстрее находить ошибки. + +Как разработчик, я хочу видеть рекомендации по улучшению кода, чтобы писать чище. + +Как разработчик, я хочу получать ревью сразу после создания PR, чтобы не ждать человека. + +Как разработчик, я хочу видеть уровень критичности замечаний, чтобы понимать приоритет. + +Как разработчик, я хочу интеграцию с Git, чтобы не выходить из привычной среды. + +### Для тимлидов-клиентов: +Как тимлид, я хочу получать предварительное AI-ревью, чтобы экономить время. + +Как тимлид, я хочу фильтровать замечания AI, чтобы видеть только важное. + +Как тимлид, я хочу статистику по качеству кода команды, чтобы управлять процессом. + +### Для DevOps: +Как администратор, я хочу легко интегрировать бота, чтобы быстро внедрить систему. + +Как администратор, я хочу управлять доступами, чтобы контролировать безопасность. + +### Для компании: +Как компания, я хочу снизить время ревью кода, чтобы ускорить релизы. + +Как компания, я хочу централизованное решение, для автоматического review кода. + +### Общие: +Как пользователь, я хочу видеть историю ревью, чтобы отслеживать изменения. + +Как пользователь, я хочу настраивать правила анализа, чтобы адаптировать систему под проект. + +## Приоритизация функционала (MoSCoW) +### Must Have (обязательно) +Автоматическое ревью PR + +Комментарии прямо в Git + +Интеграция с Git-платформами + +Базовый анализ кода (ошибки, стиль) + +### Should Have (желательно) + +Классификация критичности + +Настройка правил + +История ревью + +### Could Have (можно позже) + +Статистика по команде + +Расширенные рекомендации (архитектура) + +UI-дэшборд + +### Won’t Have (пока не делаем) +Полная замена человека-ревьюера + +Deep анализ архитектуры уровня senior## MVP + +## MVP +Скелет: + +Интеграция с Git (webhook / API) + +Анализ pull request + +Генерация комментариев + +Базовые правила (линтинг + простая логика) + +Главная цель: бот уже реально помогает ревьюить код + +## MLP +Добавляем "вау": + +Умные рекомендации (не только ошибки) + +Приоритизация замечаний + +Красивый UI/дашборд + +Аналитика по проекту + +Настройка правил + +Цель: пользователи ХОТЯТ этим пользоваться, а не просто могут + +## Две главные истории из MVP и требования + +1. Автоматическое ревью PR +Функциональные требования: +Система принимает webhook от Git +Анализирует diff PR +Генерирует комментарии +Публикует их в PR +Нефункциональные требования: +Время ответа ≤ 10 секунд +Поддержка ≥ 1000 PR/день +Надёжность (99.5% uptime) +Безопасность (только read-only доступ к коду) + +2. Интеграция с Git-платформой +Функциональные требования: +Подключение через API/token +Настройка репозитория +Включение/выключение бота +Поддержка популярных Git-систем +Нефункциональные требования: +Простота установки (≤ 15 минут) +Документация +Масштабируемость +Совместимость с разными версиями Git-серверов + +| Раздел | Содержание | +|--------------------|-----------| +| Роли | Developer, Team Lead, UI/UX Designer, DevOps | +| Кол-во User Stories| 15 | +| Основная ценность | Автоматизация code review | +| Must Have | Авто-ревью, комментарии, интеграция с Git | +| Should Have | Критичность, история, настройки | +| Could Have | Аналитика, UI, расширенные рекомендации | +| MVP | Интеграция + анализ PR + комментарии | +| MLP | Умные рекомендации + UI + аналитика | +| Ключевая история 1 | Автоматическое ревью PR | +| Ключевая история 2 | Интеграция с Git | +| НФ требования | Быстродействие, масштабируемость, безопасность | + + \ No newline at end of file diff --git a/diag1.png b/diag1.png new file mode 100644 index 0000000..97199de Binary files /dev/null and b/diag1.png differ