Образец отчёта по практике программиста: структура и пример

Каркас отчёта программиста

Пример введения

Введение программиста называет не только базу и сроки, но и роль в команде: стажёр, младший разработчик, тестировщик. Пример:

Производственная практика проходила с 1 по 26 июля в отделе разработки ООО «Пример» в роли стажёра-разработчика серверной части. Руководитель практики от организации — ведущий разработчик Иванов И. И.

Цель практики — получить опыт промышленной разработки в команде и закрепить навыки программирования, полученные при изучении профессиональных дисциплин. Задачи: изучить архитектуру сервиса и процесс разработки в команде; освоить работу с системой контроля версий и системой учёта задач; выполнить задачи по доработке и исправлению сервиса; написать автоматические тесты для одного из модулей.

Задачи сформулированы так, что каждой соответствует раздел отчёта, а результат можно проверить по истории задач.

Пример раздела о стеке и процессе работы

Стек описывают не списком модных слов, а с объяснением, что для чего используется. Пример:

Практика проходила в отделе разработки условной компании ООО «Пример», которая создаёт сервис онлайн-записи для небольших салонов и мастерских. Серверная часть написана на Python с использованием фреймворка Django, данные хранятся в PostgreSQL, клиентская часть — на JavaScript. Исходный код хранится в системе контроля версий Git, задачи ведутся в системе учёта задач.

Команда работает двухнедельными циклами: в начале цикла задачи распределяются на общей встрече, каждое утро проходит короткая встреча о ходе работы. Любое изменение кода перед объединением с основной веткой проходит проверку другим разработчиком и автоматические тесты.

Названия технологий пишут как есть, а процессы описывают по-русски: «проверка кода», «основная ветка», «цикл разработки».

Пример раздела о выполненных задачах

Перечень задач удобно дать таблицей, а одну задачу разобрать подробно.

Подробнее о второй задаче. Клиенты из других часовых поясов видели время записи со сдвигом. Изучив код, я выяснил, что время сохранялось в базе без указания часового пояса и выводилось в часовом поясе сервера. Я изменил сохранение на время с часовым поясом и добавил преобразование при выводе в часовой пояс салона. Чтобы ошибка не вернулась, написал тест, который проверяет вывод времени для двух разных часовых поясов.

Такое описание показывает ход мысли: симптом, причина, решение, проверка.

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

Каждое моё изменение проверял наставник. Основные замечания касались именования переменных, длины функций и отсутствия обработки ошибок при обращении к внешнему сервису отправки сообщений. После второй недели замечаний стало заметно меньше: я начал проверять код по списку типичных замечаний перед отправкой на проверку.

Автоматические тесты запускаются при каждом изменении. За время практики я написал модульные тесты для модуля уведомлений и научился использовать подставные объекты вместо обращения к реальному сервису.

Замечания на проверке кода — хороший материал для отчёта: они показывают, чему вы научились, лучше любого перечня технологий.

Чего не должно быть в отчёте

Не всё, что вы видели на практике, можно переносить в отчёт. Перед сдачей покажите его наставнику от компании и спросите, что можно оставить. Если код нужен для иллюстрации, напишите учебный фрагмент, который показывает тот же приём.

• Исходного кода компании целиком или крупными фрагментами: он, как правило, составляет коммерческую тайну.
• Адресов серверов, паролей, ключей доступа, конфигурационных файлов.
• Скриншотов с реальными данными клиентов: имена, телефоны, записи.
• Названий внутренних систем и клиентов компании, если организация против.
• Перечня технологий, с которыми вы не работали, «для объёма».

Что заменить своим материалом

• Продукт, команду и процесс — по вашей компании.
• Стек — только технологии, с которыми работали вы.
• Задачи — из своей системы учёта задач, своими формулировками.
• Замечания на проверке кода — реальные, обобщённые до типов ошибок.
• Выводы — о том, что вы теперь умеете, с конкретными примерами.

Вопросы и ответы