1. Набор документов и данных для защиты индивидуального задания (проекта)
- Исходный код проекта.
- Описание кода, если отсутствуют комментарии в коде.
- Блок-схема работы алгоритма (по коду).
- Презентация проекта (не менее 10 слайдов).
- Спитч-текст для спикеров (пофамильно, для нескольких).
- Отчет о проделанной работе в предложенном формате.
- Исполняемый файл проекта, без дополнительной "подгрузки" библиотек или других программ.
2. Требование к спикерам, проджект-менеджерам
- Иметь спитч-текст.
- Способность точно и четко объяснить любой алгоритм в тексте (коде).
- При использовании какой-либо технологии, быть готовым к специфическим вопросам по данной технологии.
- Быть готовым взять ответственность за свою часть в проекте / проект.
3. Исходный код
- Исходный код должен быть оформлен в стиле "Стайлгайд" и быть читаемым.
- Исходный код должен быть локальным, как и весь проект, никаких ссылок на Git-ы.
- Желательно разделять логические части на отдельные файлы кода.
4. Блок схема
- Используйте стандарты построения блок-схем.
- Используйте популярные форматы блок-схем.
5. Отчет о проделанной работе: структура и оформление
Документ: «Описание реализации проекта» (Пояснительная записка)
Титульный лист
- Название проекта
- ФИО автора (или всех участников с указанием ролей)
- Дата
- Группа, курс, научный руководитель
Раздел 1. Введение (Актуальность и цель)
1–1.5 страницы
- Что писать: Почему эта тема важна прямо сейчас? (Пример: «Рынок доставки растёт, а существующие приложения неудобны для малого бизнеса»).
- Какая проблема есть у пользователей/компании.
- Цель проекта: (Одна фраза) «Разработать веб-приложение для…»
- Задачи: (Список из 4–6 пунктов, что вы сделали для достижения цели):
- Провести анализ аналогов
- Спроектировать архитектуру
- Реализовать фронтенд
- Написать бэкенд
- Протестировать
- Внедрить
Раздел 2. Обзор существующих решений (Аналитика)
1–2 страницы
- Что писать: Какие аналоги (конкуренты) уже есть на рынке? (2–3 примера).
- В чём их сильные и слабые стороны (таблица сравнения).
- Чем ваш проект отличается от них? (Ваше уникальное преимущество — например, «бесплатность», «скорость работы», «ориентация на мобильные устройства»).
Раздел 3. Технические требования и архитектура (Спецификация)
2–3 страницы
- Что писать: Стек технологий (языки, фреймворки, базы данных, библиотеки). Напишите, почему выбрали именно их (например: «Django — потому что он позволяет быстро прототипировать»).
- Архитектурная схема (если не можете нарисовать, опишите словами: «Клиент общается с сервером через REST API, данные хранятся в PostgreSQL»).
- Диаграмма базы данных (если есть — приложите картинку или таблицу с описанием сущностей).
- Функциональные требования (что конкретно система умеет делать: регистрация, поиск, корзина, оплата, админка).
Раздел 4. Реализация (Ход работы)
Это самый большой раздел — 3–5 страниц
Что писать: Разбейте весь процесс на этапы:
- Этап 1: Подготовка (установка ПО, настройка окружения).
- Этап 2: Создание макетов/дизайна.
- Этап 3: Разработка ключевых модулей.
- Этап 4: Интеграция модулей.
- Этап 5: Тестирование.
Для каждого этапа укажите:
- Что было сделано конкретно (например: «Настроена аутентификация через JWT-токены»).
- Какие инструменты использовались (например: «Postman для тестирования API»).
- Какие сложности возникли и как их решили (очень важно для экспертной оценки!).
Если работа групповая: Обязательно вставьте подраздел «Распределение ролей» — кто что делал (например: «Иванов — фронтенд, Петров — база данных, Сидоров — тестирование и документация»).
Раздел 5. Тестирование и качество
1 страница
- Что писать: Какие виды тестов проводились? (Юнит-тесты, интеграционные, ручное тестирование).
- Количество тестов (если автоматические: «Написано 42 теста, покрытие кода 85%»).
- Примеры найденных и исправленных ошибок (багов).
- Результаты нагрузочного тестирования (если было).
Раздел 6. Результаты и выводы
1–2 страницы
- Что писать: Что получилось в итоге? (Список реализованных функций).
- Соответствие поставленным целям (из Раздела 1) — всё ли удалось выполнить.
- Экономическая/практическая ценность: почему ваш проект полезен и как его можно монетизировать или внедрить.
- Планы на развитие (что можно добавить, улучшить, расширить).
Раздел 7. Заключение
0,5 страницы
- Краткий итог: «Проект успешно реализован, все задачи выполнены, получен опыт работы с [технология] и навыки командной работы/самоорганизации. Документация прилагается. Код доступен по ссылке».
Раздел 8. Список использованных источников (Библиография)
- Ссылки на книги, статьи, официальную документацию использованных фреймворков, сайты-аналоги.
Раздел 9. Приложения
- Скриншоты интерфейса (если не вставили в Раздел 4).
- Инструкция по установке и запуску (How-to).
- Инструкция по использованию.
Что добавить, если проект индивидуальный?
- Если вы работали один, во вступлении напишите: «Проект реализован мной самостоятельно» — и акцентируйте, что вы прошли все этапы (от анализа до тестов). Если у вас группа, во всех разделах (особенно в Реализации и Результатах) пишите «Мы», но потом в подразделе «Роли» чётко разделите ответственность.
6. Общее требование к исполнителям
Не быть вайб-кодером. Разбираться в "теме", уметь брать на себя ответственность, быть готовым ответить на самые нестандартные вопросы по проекту.