Правильное оформление приложений в дипломной работе: листинги и схемы
Что обязательно выносится в приложения
В основной части выпускной квалификационной работы (ВКР) должны содержаться только концептуальные схемы, ключевые формулы и выводы. В раздел Приложения помещается вспомогательный материал:
- Полные листинги исходного кода программных комплексов.
- Акты внедрения результатов исследования на предприятиях.
- Объемные таблицы промежуточных статистических расчетов.
- Электрические принципиальные схемы, сборочные чертежи и скриншоты программ по ГОСТ.
- Тексты опросников, анкет и протоколов испытаний.
Как нумеровать приложения в курсовой: запрещенные буквы алфавита
Главная тонкость нормоконтроля в том, как нумеровать приложения в курсовой согласно ГОСТ 7.32-2017:
«Приложения обозначают прописными буквами кириллического алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ъ, Ы, Ь. После слова „ПРИЛОЖЕНИЕ“ следует буква, обозначающая его последовательность. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и O» (ГОСТ 7.32-2017, п. 6.17.4).
Указанные буквы исключены, так как они зрительно похожи на цифры 3, 0, 4 или не употребляются в начале слов. Если в работе одно приложение, оно все равно обозначается «ПРИЛОЖЕНИЕ А».
Оформление приложений в дипломе гост: форма заголовка
Стандартное оформление приложений в дипломе гост требует начинать каждое приложение с новой страницы:
ПРИЛОЖЕНИЕ А
(обязательное / рекомендуемое / справочное)
Исходный код микросервиса аутентификации
В круглых скобках под словом ПРИЛОЖЕНИЕ указывается его статус (обычно (обязательное) или (справочное)), а ниже по центру печатается содержательный заголовок.
Настройка окружения appendix в LaTeX с русской нумерацией
В LaTeX команда \appendix сбрасывает счетчик разделов.
Номером приложения должна стать только буква, а слово «ПРИЛОЖЕНИЕ» добавляет оформление
заголовка: если вписать слово в сам номер
(\renewcommand{\thesection}{Приложение~\Asbuk{section}}), ссылка превратится в «в
приложении Приложение А», а содержание собьется. Рабочий вариант для класса article
с пакетом titlesec в преамбуле:
% В преамбуле: \usepackage{titlesec}
\appendix
\renewcommand{\thesection}{\Asbuk{section}} % А, Б, В...
\counterwithin{figure}{section} % Рисунок А.1, Б.1
\counterwithin{table}{section} % Таблица А.1
\counterwithin{equation}{section} % (А.1)
% «ПРИЛОЖЕНИЕ А» по центру, заголовок приложения строкой ниже
\titleformat{\section}[display]
{\normalfont\bfseries\filcenter}
{ПРИЛОЖЕНИЕ~\thesection}
{0pt}
{}
\clearpage % каждое приложение — с новой страницы
\section{Исходный код клиентского приложения}\label{app:code}
... листинг программы ...
\clearpage
\section{Акт внедрения результатов исследований}
... скан документа ...
Теперь \ref{app:code} дает букву «А», и ссылка читается
как «в приложении А», а нумерация рисунков начинается заново в каждом приложении. Команда
\Asbuk из babel пропускает буквы Ё, Й, Ъ, Ы, Ь, но не З, О и Ч, поэтому с ГОСТ она
совпадает только для первых семи приложений (А–Ж): восьмое получит «З» вместо «И». При большем
числе приложений задайте буквы вручную. В стандартной преамбуле Labkeeper разделы не нумеруются,
и буквы не будет вовсе — для приложений нужна своя преамбула, как в примере в редакторе.
Размещение длинных программных листингов и таблиц
Внутри приложений код оформляется через пакет listings
(правила верстки см. в статье об оформлении листингов в отчете) с
уменьшенным кеглем шрифта (basicstyle=\ttfamily\scriptsize) и плотными
междустрочными интервалами, чтобы рационально использовать площадь страниц.
Практические советы
Сквозная нумерация страниц
Страницы приложений входят в общую сквозную нумерацию работы и продолжают нумерацию основного текста ВКР.
Ссылки в основном тексте
Каждое приложение обязательно должно упоминаться в основном тексте диплома: «Полный текст разработанного модуля приведен в приложении~А».