Skip to content

README.md

Latest commit

 

History

History
149 lines (110 loc) · 8.23 KB

README.md

File metadata and controls

149 lines (110 loc) · 8.23 KB

🧭 Документация Super Valera

Обновлено: 27.10.2025 Проект: Super Valera - AI-powered чат-бот для автоматизации автосервиса Технологии: Ruby on Rails 8.1, ruby_llm, telegram-bot Назначение: Единая точка входа в документацию проекта для всех аудиторий

🎯 Навигация по ролям {#навигация-по-ролям}

🤖 Для AI-агентов и Claude {#для-ai-агентов}

Оптимальный путь изучения проекта:

  1. FLOW.md — процесс разработки (критически важно)
  2. ../CLAUDE.md — технические инструкции и стек
  3. architecture/decisions.md — архитектурные решения
  4. gems/README.md — документация по ключевым gem

👨‍💻 Для разработчиков {#для-разработчиков}

Путь для эффективной разработки:

  1. FLOW.md — процесс работы с требованиями
  2. ../CLAUDE.md — технический стек и команды
  3. requirements/README.md — система требований
  4. gems/README.md — техническая документация

👔 Для Product Owner и менеджеров {#для-product-owner}

Путь для управления продуктом:

  1. product/constitution.md — конституция продукта
  2. ROADMAP.md — дорожная карта развития
  3. product/business-metrics.md — бизнес-метрики
  4. product/customer-profiles.md — профили клиентов (CustDev)
  5. requirements/README.md — пользовательские истории

🚖 Критически важные документы {#критически-важные-документы}

FLOW.md — Процесс разработки {#flow-md}

  • Приоритет: Критический
  • Содержание: Двухдокументный подход (User Story + TSD)
  • Когда читать: Перед любой разработческой задачей
  • Ключевые моменты: FLOW-подход, быстрое прототипирование

../CLAUDE.md — Технические инструкции {#claude-md}

  • Приоритет: Критический
  • Содержание: Технический стек, команды, архитектура
  • Когда читать: При работе с кодом проекта
  • Ключевые моменты: Ruby on Rails 8.1, ruby_llm, telegram-bot

domain/glossary.md — Базовая терминология {#glossary-md}

  • Приоритет: Высокий
  • Содержание: Базовые термины проекта
  • Когда читать: При работе с доменной областью
  • Ключевые моменты: PDR, ЛКП, ДТП, базовые понятия

📋 Задачные ссылки {#задачные-ссылки}

🛠️ Разработка {#разработка}

  • Создать User Story: requirements/templates/user-story-template.md
  • Создать TSD: requirements/templates/technical-specification-document-template.md
  • Изучить Telegram: gems/telegram-bot/README.md
  • Изучить AI: gems/ruby_llm/README.md
  • Понять домен: domain/glossary.md
  • Начать разработку: development/README.md

📊 Бизнес {#бизнес}

  • Профили клиентов: product/customer-profiles.md — для CustDev и сегментации
  • Анализ показателей: product/business-metrics.md
  • Бизнес-цели: product/constitution.md
  • Прогресс по целям: ROADMAP.md
  • Конкурентный анализ: saas/competitors.md
  • SaaS модель: saas/saas-overview.md

🚀 DevOps и операции {#devops}

  • Конфигурация: CONFIG.md — переменные окружения
  • Развернуть проект: deployment/README.md
  • Docker настройка: deployment/DOCKER.md
  • Мониторинг: deployment/MONITORING.md
  • Аналитика: analytics/README.md
  • Безопасность: patterns/error-handling.md

📋 Принципы документации {#принципы-документации}

🎯 Zero дублирование {#zero-дублирование}

  • WHY документы (почему) → architecture/decisions.md, product/
  • HOW документы (как) → ../CLAUDE.md, FLOW.md, техническая документация
  • WHAT документы (что) → requirements/, domain/
  • ССЫЛКИ вместо копирования → каждый концепт описывается один раз

🔄 Единый источник правды {#единый-источник-правды}

  • Каждый концепт описывается только в одном месте
  • Остальные документы ссылаются на первоисточник
  • Избегаем копирования информации между документами

🎨 Консистентность {#консистентность}

  • Единый стиль форматирования
  • Стандартизированная структура заголовков
  • Согласованная терминология через domain/glossary.md

🔧 Поддержка документации {#поддержка-документации}

Регламент обновления {#регламент-обновления}

Еженедельно (по пятницам):

  • Lead Developer — полный аудит документации

Перед релизами:

  • Product Owner — проверка критических файлов

Перед commit изменений:

  • Разработчик — быстрая проверка ссылок

Ответственные {#ответственные}

  • 📧 Техническая документация: Development Team
  • 🎯 Продуктовая документация: Product Owner
  • 🔧 Общая навигация: Documentation Maintainer

📋 Быстрая навигация

По ролям: #для-ai-агентов | #для-разработчиков | #для-product-owner

Ключевые документы: #flow-md | #claude-md | #glossary-md

Задачи: #разработка | #бизнес | #devops

Принципы: #zero-дублирование | #единый-источник-правды | #консистентность

ПРОЕКТ vs ПРОДУКТ

КРИТИЧЕСКИ ВАЖНО: Понимать разницу между проектом и продуктом!

  • ПРОЕКТ = Super Valera Repository - Open-source репозиторий для владельцев автосервисов
  • ПРОДУКТ = AI Bot Instance - Telegram бот для клиентов автосервиса

📝 Документ создан: 27.10.2025 🔄 Обновлен: 27.10.2025 👤 Ответственный: Documentation Maintainer 📏 Объем: 134 строки (оптимизировано с 236 строк) 📊 Сокращение: 43% (экономия 102 строки)