📘 {PROJECT}-PROJECT-MASTER

Проект: {PROJECT_NAME}
Версия: 1.0.0
Последнее обновление: {ДАТА}

📑 СОДЕРЖАНИЕ

1. Обзор проекта
2. Бизнес-модель
3. Технологический стек
4. Архитектура
5. База данных
6. Интеграции
7. Конфигурация
8. Текущее состояние
9. Ссылки на документацию

🎯 ОБЗОР ПРОЕКТА {#обзор-проекта}

Что это?

{ОПИСАНИЕ} - развёрнутое описание проекта, какую проблему решает, для кого предназначен.

Для кого?

Целевая аудитория:
- {ПОЛЬЗОВАТЕЛЬ_1}
- {ПОЛЬЗОВАТЕЛЬ_2}

Основные функции

1. {ФУНКЦИЯ_1} - описание
2. {ФУНКЦИЯ_2} - описание
3. {ФУНКЦИЯ_3} - описание

💼 БИЗНЕС-МОДЕЛЬ {#бизнес-модель}

Проблема

{КАКУЮ_ПРОБЛЕМУ_РЕШАЕМ}

Решение

{НАШЕ_РЕШЕНИЕ}

Ценностное предложение

• ✅ {ПРЕИМУЩЕСТВО_1}
• ✅ {ПРЕИМУЩЕСТВО_2}
• ✅ {ПРЕИМУЩЕСТВО_3}

Метрики успеха

• {МЕТРИКА_1}: {ЦЕЛЕВОЕ_ЗНАЧЕНИЕ}
• {МЕТРИКА_2}: {ЦЕЛЕВОЕ_ЗНАЧЕНИЕ}

🛠️ ТЕХНОЛОГИЧЕСКИЙ СТЕК {#технологический-стек}

Backend

• Язык: Python 3.11 / Node.js 18 / {ЯЗЫК}
• Фреймворк: FastAPI / Django / Flask / Express / {ФРЕЙМВОРК}
• ORM: SQLAlchemy / Prisma / {ORM}

Frontend

• Фреймворк: React / Vue / Streamlit / {ФРЕЙМВОРК}
• UI библиотека: Material-UI / Tailwind / {UI_LIB}

База данных

• Основная БД: PostgreSQL / MySQL / SQLite / {БД}
• Кеш: Redis / Memcached / {КЕШ}

Инфраструктура

• Сервер: {СЕРВЕР_ОПИСАНИЕ}
• Развёртывание: Docker / K8s / PM2 / {РАЗВЁРТЫВАНИЕ}
• CI/CD: GitHub Actions / GitLab CI / {CI_CD}

Сторонние сервисы

• {СЕРВИС_1} - назначение
• {СЕРВИС_2} - назначение

🏗️ АРХИТЕКТУРА {#архитектура}

Общая схема

[Описание архитектуры или ссылка на диаграмму]

Компоненты

1. {КОМПОНЕНТ_1}

Назначение: {ОПИСАНИЕ}
Технологии: {ТЕХНОЛОГИИ}
Расположение: {ПУТЬ_К_КОДУ}

2. {КОМПОНЕНТ_2}

Назначение: {ОПИСАНИЕ}
Технологии: {ТЕХНОЛОГИИ}
Расположение: {ПУТЬ_К_КОДУ}

Data Flow

Пользователь → Frontend → Backend API → База данных
                                    ↓
                            Внешние API (если есть)

🗄️ БАЗА ДАННЫХ {#база-данных}

Схема БД

[Ссылка на ER диаграмму или текстовое описание]

Таблицы

users

{ТАБЛИЦА_2}

Индексы

• ix_users_email - на users.email (для быстрого поиска)
• ix_{таблица}_{поле} - назначение

Миграции

Миграции управляются через:
- Alembic (Python/SQLAlchemy)
- Prisma Migrate (Node.js)
- Django Migrations

# Создать миграцию
{КОМАНДА_СОЗДАНИЯ_МИГРАЦИИ}

# Применить миграции
{КОМАНДА_ПРИМЕНЕНИЯ}

🔌 ИНТЕГРАЦИИ {#интеграции}

{ИНТЕГРАЦИЯ_1} (например, Ozon API)

Назначение: {ДЛЯ_ЧЕГО}
Документация: {ССЫЛКА}
Модуль: modules/api/{название}.py

Основные методы:
- method1() - описание
- method2() - описание

Rate limits: {ЛИМИТЫ}

{ИНТЕГРАЦИЯ_2}

...

⚙️ КОНФИГУРАЦИЯ {#конфигурация}

Переменные окружения

См. .env.example для полного списка.

Обязательные:

DATABASE_URL=postgresql://user:pass@localhost/dbname
SECRET_KEY=your-secret-key

Опциональные:

REDIS_URL=redis://localhost:6379/0
LOG_LEVEL=INFO

Конфигурационные файлы

• config.py / config.ts - основная конфигурация
• {ДРУГИЕ_КОНФИГИ}

📊 ТЕКУЩЕЕ СОСТОЯНИЕ {#текущее-состояние}

✅ Что работает

• [x] {РЕАЛИЗОВАННАЯ_ФУНКЦИЯ_1}
• [x] {РЕАЛИЗОВАННАЯ_ФУНКЦИЯ_2}
• [x] {РЕАЛИЗОВАННАЯ_ФУНКЦИЯ_3}

🚧 В разработке

• [ ] {ФУНКЦИЯ_В_РАЗРАБОТКЕ_1}
• [ ] {ФУНКЦИЯ_В_РАЗРАБОТКЕ_2}

📋 Запланировано

См. {PROJECT}-ROADMAP.md для детального плана.

❌ НЕ реализовано

• {ФУНКЦИЯ_НЕ_РЕАЛИЗОВАНА_1}
• {ФУНКЦИЯ_НЕ_РЕАЛИЗОВАНА_2}

🔗 ССЫЛКИ НА ДОКУМЕНТАЦИЮ {#ссылки-на-документацию}

• 📝 {PROJECT}-CHANGELOG.md - История изменений
• 🗺️ {PROJECT}-ROADMAP.md - План развития
• 🔌 {PROJECT}-API-GUIDE.md - Справочник API
• 💻 CODE-GUIDE.md - Стандарты кодирования
• 🔄 WORKFLOWS.md - Рабочие процессы
• 🏗️ ARCHITECTURE.md - Детальная архитектура
• 🚀 DEPLOYMENT.md - Развёртывание

Последнее обновление: {ДАТА}
Автор: {АВТОР}