📚 Документация Шкед

Добро пожаловать в документацию проекта Шкед — современной платформы для управления расписанием занятий в университете МФТИ.

📖 Корневые файлы проекта

Следующие файлы находятся в корне проекта согласно стандартам GitHub:

• README.md — Главная документация проекта
• LICENSE — Лицензия MIT
• CHANGELOG.md — История изменений проекта

🗂️ Структура документации

🚀 Быстрый старт (getting-started/)

Документы для быстрого начала работы с проектом:

• QUICK_DEPLOY.md — Быстрое развертывание на сервере
• QUICK_MIGRATE.md — Быстрая миграция для inline комментариев

👨‍💻 Разработка (development/)

Руководства для разработчиков проекта:

• CONTRIBUTING.md — Руководство для контрибьюторов
• CODE_OF_CONDUCT.md — Кодекс поведения сообщества
• TESTING.md — Руководство по тестированию
• STRUCTURE.md — Структура проекта
• SCORECARD.md — OpenSSF Scorecard: оценка безопасности
• TYPESCRIPT_FIXES.md — Отслеживание TypeScript исправлений

🚢 Развертывание (deployment/)

Инструкции по развертыванию приложения:

• DEPLOYMENT.md — Полное руководство по развертыванию
• DOCKER_DEPLOY.md — Развертывание через Docker

⚡ Функциональность (features/)

Описание основных возможностей системы:

• USER_ROLES.md — Роли пользователей и права доступа
• ACTIVITY_LOG.md — Лог активности пользователей и аудит действий
• SUBGROUPS.md — Система управления подгруппами
• TELEGRAM_BOT.md — Интеграция с Telegram
• MDX_EDITOR_INTEGRATION.md — Rich text редактор для заданий

🏷️ Релизы и версионирование (releases/)

Документы о управлении версиями и релизами:

• VERSIONING.md — Система версионирования проекта
• RELEASE_GUIDE.md — Руководство по созданию релизов
• GITHUB_RELEASES.md — Автоматизация GitHub релизов
• RELEASE_PROCESS.md — Автоматизированный процесс релизов через PR

📄 Мета информация (meta/)

Общая информация о проекте:

• AUTHOR.md — Информация об авторе
• SECURITY.md — Политика безопасности
• FUNDING.md — Информация о финансировании

📋 Отчёты о реализации (implementation/)

Детальные отчёты о реализации функционала:

• README.md — Индекс отчётов о реализации
• SUMMARY.md — Итоговый отчёт о реализации КТП (English)
• FINAL_REPORT_RU.md — Финальный отчёт (Russian)
• KTP_REPORT_RU.md — Детальный отчёт реализации КТП (Russian)
• codebase_compliance_report.md — Отчёт о соответствии кодовой базы требованиям

🧪 Тестирование (testing/)

Документация по тестированию:

• Acceptance_Testing_Template.md — Шаблон ПТИ

📋 Требования (requirements/)

Исходные требования и роли:

• Roles_and_Functions_KTP_Variant_0.md — Роли и функции (Markdown)
• BUSINESS_PROCESSES_TO_BE.md — Полный реестр бизнес-процессов (To-Be)

💡 Как использовать документацию

Для новичков

1. Начните с главного README
2. Изучите роли пользователей
3. Следуйте руководству по быстрому развертыванию

Для разработчиков

1. Прочитайте руководство для контрибьюторов
2. Изучите кодекс поведения
3. Ознакомьтесь с руководством по тестированию
4. Изучите структуру проекта

Для DevOps

1. Ознакомьтесь с полным руководством по развертыванию
2. Используйте Docker инструкцию
3. Настройте систему версионирования
4. Следуйте процессу автоматизированных релизов

Для менеджеров проекта

1. Изучите систему релизов
2. Отслеживайте изменения в CHANGELOG
3. Понимайте роли и права доступа

🔄 Обновление документации

При внесении изменений в проект обязательно обновляйте соответствующую документацию:

• ✅ CHANGELOG.md — при каждом значимом изменении
• ✅ USER_ROLES.md — при изменении ролевой модели
• ✅ Технические документы — при архитектурных изменениях
• ✅ README.md — при добавлении новых функций

📝 Формат коммитов

Проект использует Conventional Commits:

# Примеры правильных коммитов
feat(admin): добавить CRUD для групп
fix(api): исправить валидацию email
docs(readme): обновить установку

Подробнее см. в руководстве по релизам.

🛠️ Технологический стек

• Frontend: Next.js 14, React 18, TypeScript, Tailwind CSS, Radix UI
• Backend: Next.js API Routes, Prisma ORM
• База данных: PostgreSQL
• Аутентификация: NextAuth.js
• Интеграции: Telegram Bot API, OpenAI API
• DevOps: Docker, GitHub Actions

📊 Статистика проекта

• Документов: 20+ файлов
• Категорий: 6 основных разделов
• Языки: Русский (документация), TypeScript/JavaScript (код)
• Лицензия: MIT

🤝 Вклад в проект

Мы приветствуем вклад в проект! Пожалуйста:

1. Прочитайте CONTRIBUTING.md
2. Следуйте CODE_OF_CONDUCT.md
3. Создавайте понятные Pull Request'ы
4. Пишите тесты для нового функционала

🔒 Безопасность

Если вы обнаружили уязвимость безопасности, пожалуйста, следуйте инструкциям в SECURITY.md.

📧 Контакты

• Автор: Павел Викторович Шершнёв
• Проект: Шкед
• Репозиторий: GitHub

📅 История обновлений

Актуальная история версий проекта доступна в CHANGELOG.md.

Текущая версия проекта: 0.4.0-alpha
Версия документации: 0.4.0-alpha
Последнее обновление: 19 ноября 2025
Статус: ✅ Актуальная