 |
Оформление дипломной работы
|
|
|
|
Оформление электронной версии разработанного приложения
Разрабатываемая программа должна включать справочную информацию об основных терминах, определяемых тематикой работы, и данные о работе программы.
Разрабатываемые программные модули должны быть самодокументированы, т.е. тексты программ должны содержать все необходимые комментарии. Программный код должен быть выполнен в соответствии с правилами хорошего стиля и максимально оптимизирован.
Оформление пояснительной записки
При оформлении текстовых и графических материалов, входящих в программную документацию следует придерживаться действующих стандартов. Некоторые положения этих стандартов приведены ниже.
Общие требования
Пояснительная записка должна быть отпечатана на белой бумаге формата A4 (210x297 мм, ГОСТ 9327). Текст располагается на одной стороне листа с соблюдением следующих полей: слева – 30 мм, сверху – 15 мм, снизу – 15 мм, справа – 10 мм. Размер абзацного отступа – 1,25 см. Межстрочный интервал – полуторный. Для печати основного текста используется шрифт Times New Roman, размер – 14 пунктов, цвет – черный.
Разрешается использовать возможности акцентирования внимания на терминах, формулах и т.п., применяя полужирное и/или курсивное начертание шрифта.
Опечатки, описки и графические неточности, обнаруженные в процессе подготовки пояснительной записки, допускается исправлять закрашиванием белой краской и нанесением на том же месте исправленного текста (графики) черными чернилами, пастой или тушью.
Текст должен быть написан грамотно, с соблюдением всех требований русского языка. Язык пояснительной записки должен быть сжатым и точным, свойственным научно-техническим документам. Не следует злоупотреблять описаниями устройств или программного обеспечения, известными из литературы. Не должны использоваться жаргонные технические выражения. Нельзя употреблять сокращения слов, за исключением общепринятых и таких аббревиатур, как ГОСТ, ТУ, ТЗ, ЭВМ и т.п. При необходимости сокращенного обозначения выражений, слов, наименований сигналов, команд или шин приводится таблица принятых в тексте сокращений.
|
|
|
Первая страница введения и все последующие должны иметь штамп.
Весь текст, заголовки и иллюстрации должны быть выполнены в единообразном редакционном стиле.
Количество рисунков – иллюстраций (схем, эскизов, графиков, чертежей) в пояснительной записке определяется ее содержанием и должно обеспечивать ясность, конкретность и полноту изложения текста.
Фамилии, названия учреждений, организаций, фирм, названия изделий и другие имена собственные приводят на языке оригинала. Допускается транслитерировать имена собственные и приводить названия организаций в переводе на русский язык с добавлением (при первом упоминании) оригинального названия.
Сокращения русских слов и словосочетаний в тексте – по ГОСТ 7.12.
Нумерация страниц
Нумерация страниц пояснительной записки – сквозная, арабскими цифрами, внизу, справа листа без точки в штампе. Страницами считают, как листы с текстами и рисунками, так и листы приложений. Первым листом считается титульный лист, номер на титульном листе не ставится. Вторым листом – лист задания, далее следуют листы содержания и первый лист введения. Все эти листы включаются в общую нумерацию листов, но номера на них не ставятся. Первый лист, на котором ставится номер – лист введения.
Разделы и подразделы
Пояснительная записка состоит из введения, заключения, списка использованных источников, приложений и четырех разделов:
|
|
|
1 Анализ предметной области
2 Разработка программных модулей программного обеспечения
3 Документирование программного обеспечения. Составление руководства пользователей
4 Экономическая оценка программного обеспечения
Разделы состоят из подразделов. Номер подраздела включает номер раздела и порядковый номер подраздела в разделе, разделенные точкой (например, “2.2” – второй подраздел второго раздела). Подразделы состоят из пунктов. Номер пункта включает номер раздела, порядковый номер подраздела в разделе и порядковый номер пункта в подразделе, разделенные точками (например, “2.2.1” – первый пункт второго подраздела второго раздела).
При оформлении пояснительной записки в соответствии с ГОСТ 2.105-95, в конце номеров разделов, подразделов и пунктов точка не ставится, например, «2.2 Проектирование».
Единственный подраздел в разделе (а также единственный пункт в подразделе) не нумеруется.
Разделы, подразделы и пункты должны иметь заголовки. Заголовки разделов печатаются строчными буквами, первая буква прописная, выравнивание по левому краю, отступ первой строки 1,25 пт. Заголовки подразделов и пунктов следует печатать с прописной буквы и размещать с абзацным отступом.
В конце заголовка точка не ставится. Если заголовок состоит из двух предложений, их разделяют точкой. Переносы слов и подчеркивание в заголовках не допускаются. Между заголовком и текстом (как выше, так и ниже его) должен находиться абзацный отступ 10-12 пт. Недопустимо, когда заголовок находится в нижней части листа, а текст раздела, подраздела, пункта или подпункта начинается на следующем листе.
Каждый раздел записки начинается с новой страницы. Каждый подраздел, пункт и перечисления записываются с нового абзаца.
Списки
Содержащиеся в тексте перечисления требований, указаний, положений, оформляются в виде ненумерованных (маркированных) или нумерованных списков. Отдельные позиции в ненумерованных списках помечаются знаком короткого тире «–». После номера позиции в нумерованных списках ставится скобка. Каждая позиция списка записывается с абзацного отступа (отступ маркера – 1,25 см, табуляция и отступ текста – 1,6 см).
Рисунки
Все иллюстрации (графики, схемы алгоритмов, диаграммы) именуют рисунками. Рисунки должны располагаться сразу же после первого упоминания в тексте, либо на следующей странице. Рисунки следует нумеровать в пределах каждого раздела либо допустимо использовать сквозную нумерацию. Если используется нумерация внутри раздела, номер рисунка состоит из номера раздела и порядкового номера рисунка в пределах данного раздела, разделенных точкой. Например, Рисунок 2.3 – третий рисунок во втором (технологическом) разделе. Рисунки в приложениях нумеруются отдельно. Например, Рисунок П.2 – второй рисунок в приложениях.
|
|
|
Рисунки должны иметь наименование, а, при необходимости, также и пояснительные данные (обозначение кривых, условия их получения и т.п.).
При оформлении пояснительной записки в соответствии с ГОСТ 2.105-95, номер и название рисунка разделяются тире. Слово «Рисунок», номер и наименование рисунка помещают посередине строки под рисунком после пояснительных данных. Например, «Рисунок 2.3 – Логическая схема базы данных». Если рисунок занимает более одной страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Например: Рисунок 12 ‑ Продолжение
Рисунки следует размещать так, чтобы их можно было рассматривать без поворота страницы. Если такое размещение невозможно, рисунки следует располагать так, чтобы для просмотра надо было повернуть страницу по часовой стрелке.
Если в иллюстрации используются стандартные графические элементы, например, в структурных схемах или в схемах алгоритмов, то их нужно изображать в соответствии с ГОСТ.
Таблицы
Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Таблицу следует располагать непосредственно после текста, в котором она упоминается впервые, либо на следующей странице. Нумерация таблиц аналогична нумерации рисунков (в пределах каждого раздела либо сквозная нумерация). Например, Таблица 3.1 – первая таблица третьего раздела.
При оформлении пояснительной записки в соответствии с ГОСТ 2.105-95, номер и название таблицы разделяются тире. Слово «Таблица», номер и наименование таблицы помещают в одну строку над таблицей слева, без абзацного отступа. Например, «Таблица 1.3 – Характеристики языков веб-программирования».
|
|
|
Для и текста таблицы рекомендуется применять шрифт размером 12 пунктов.
Заголовки граф и строк таблицы следует писать с прописной буквы в единственном числе, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков точки не ставятся. Рекомендуется выделять заголовки и подзаголовки жирным начертанием шрифта. Заголовки граф, как правило, записывают параллельно строкам таблицы, но допускается и перпендикулярное их расположение.
Таблицы слева, справа и снизу, как правило, ограничивают линиями. Горизонтальные и вертикальные линии, разграничивающие элементы таблицы, допускает не проводить, если их отсутствие не затрудняет пользование таблицей. Головка таблицы должна быть отделена линией от остальной части таблицы. Допускается помещать таблицу вдоль длинной стороны листа.
Если строки или графы таблицы не умещаются на странице, таблицу делят на части, помещая одну часть под другой, при этом в каждой части повторяют ее головку и боковик. Над первой частью слева пишут слово «Таблица» с указанием номера и названия таблицы, а над другими частями слева пишут «Продолжение таблицы» с указанием номера таблицы.
Формулы
Уравнения и формулы следует выделять из текста в отдельную строку, отделяя от остального текста абзацным отступом. Если уравнение не умещается в одну строку, то оно должно быть перенесено после знака равенства или одного из знаков арифметических операций, причем этот знак должен быть повторен в начале следующей строки. Пояснение значений символов и числовых коэффициентов следует приводить непосредственно под формулой. Формулы, используемые в тексте, могут вписываться с помощью редактора формул при таких геометрических параметрах, чтобы они были удобочитаемы, но в то же время не очень крупными. Следует учитывать, что формула – это равноправный член предложения и при ее написании надо соблюдать правила пунктуации (точка после формулы, если ею завершается предложение, или запятая).
Формула может быть пронумерована, но только в том случае, если на нее есть ссылка в тексте, причем сначала по тексту идет упоминание формулы, а затем должна быть вписана собственно формула. Формулу нумеруют по тем же правилам, что и рисунки (пораздельно либо сквозная нумерация). Номер формулы арабскими цифрами ставят в круглых скобках справа от ее изображения по границе текста. Например:
|
|
|
(12)
Формула всегда первоначально приводится в общем (буквенном) виде, а ниже следует привести пояснения с указанием размерности каждой величины. Например:
I – сила тока, А;
Формулу, приведенную в общем виде, недопустимо завершать знаком равенства и числом – результатом подстановки конкретных числовых величин.
|
|
|
