Содержание
Оформление пояснительной записки к курсовой работе
Требования к оформлению пояснительной записки можно скачать тут
Шаблон к пояснительной записке можно скачать тут
Общие требования
Аннотация
Аннотация - краткое содержание/краткая характеристика работы. В аннотации к курсовой работе необходимо указать следующее:
- Краткое описание кода программы, которая была написана (краткое описание задания)
- Информацию о демонстрации работы программы (представлены скриншоты / сгенерированы тестовые данные / демонстрация работы программы для различных данных)
Цель и задачи
Цель - одно предложение, кратко характеризующее желаемый конечный результат, который планируется достигнуть в ходе работы. Примерный шаблон: «Целью данной работы является изучение… создание… разработка… ».
Задачи - список действий для достижения цели работы. Обычно переход от цели к задачам оформляется следующей фразой: «Для достижения поставленной цели требуется решить следующие задачи: ». Далее перечисляются задачи: изучение …, разработка … , сборка …, тестирование… и т.д.
Содержание отчета
Отчет должен содержать подробное описание выполненной вами работы, программной реализации того или иного функционала. Включать в себя обоснование принятых вами решений и скриншоты/изображения и, при необходимости, таблицы для более наглядного объяснения.
В отчете в приложении должен быть представлен полный код программы.
Примеры работы программы
Примеры работы программы должны быть оформлены следующим образом:
- Каждый пример должен содержать заголовок, в котором описано, какой конкретно функционал проверяется.
- Весь функционал, реализованный в курсовой работе, должен быть представлен в примерах работы программы (может и не по одному разу)
- Лучше использовать несколько небольших примеров, чем один большой
Примеры работы программы должны быть хорошо читаемыми.
На что обратить внимание
- В pull-request необходимо добавлять PDF и редактируемую (.doc(x)/.odt) версии отчёта
- Титульный лист не нумеруется, шрифт нумерации должен быть идентичен тому, которым оформлен текст
- Особое внимание уделить выравниванию текста и в таблицах на первых страницах
- Подписи к изображениям и таблицам имеют свой стиль/размер/шрифт
- Аннотация дублиурется на английский язык
- В документах из начала старницы указано как оформлять текст и разделы (шрифт, выравнивание, поля, где нужны разрывы страниц)
- Личные формулировки (я/мы/сделал/изучил/тп) про себя использовать запрещено
- Код или содержимое терминала надо вставлять текстом с
моноширинным шрифтом, а не скриншотом. - Рисунки необходимо подписывать и ссылаться на них в тексте
- Разделы (в нумерации которых одна цифра) необходимо нумеровать и начинать с новой страницы. Введение, заключение и список источников не нумеруются
- Разделы начинаются с новой страницы
- Рисунки для тестирования необходимо сводить в таблицу, а не делать до и после на одном рисунке
- Таблицу с тестированием желательно выносить в приложение
- Источники литературы нужно оформлять по правилам из шаблона, в частности, указывать авторов методичек и книг
- Код необходимо представлять в отчёте в приложении
- На титульном листе преподавателем нужно указывать того, кто указан в расписании по лабораторным работам
- Книга Кернигана и Ритчи «Язык программирования Си» является обязательной к указанию в списке источников
- Для сохранения форматирования из шаблона рекомендуется использовать вставку текста без форматирования (Ctrl+Shift+V)
Пример хороших отчётов с прошлых годов
Отчёт в TeX
Для тех, кто знаком с TeX, есть возможность написать отчёт в нём по предварительному согласованию с преподавателем лабораторных работ. При возниконовении трудностей или несоответствий требованиям к оформлению исправлять их необходимо самостоятельно
