method

Как правило, объем пояснительной записки не должен превышать 70 страниц без учета приложений. При этом большая часть объема записки должна быть посвящена описанию выполненной работы по проектированию и реализации компонентов информационного и программного обеспечений.

Общие рекомендации к стилю написания пояснительной записки можно сформулировать следующим образом:

1.Текст документа должен быть кратким, четким, исключающим возможность неоднозначного толкования.

2.Термины и определения должны быть едиными и соответствовать установленным стандартами, а при их отсутствии - общепринятым в научнотехнической литературе, и приводиться в перечне терминов.

3.Необходимо использовать хороший литературный русский язык (рекомендуется тщательно вычитывать текст на предмет исправления грамматических, орфографических, стилистических и других ошибок).

4.Следует использовать лаконичный, объективно-беспристрастный, безличный стиль изложения, принятый в научно-технических произведениях. Журналистский пафос и элементы разговорного жанра здесь не уместны.

5.Следует специально структурировать работу и представлять результаты в наглядной форме. Рекомендуется использовать диаграммы, схемы

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

6.Необходимо следить за точностью формулировок и корректностью употребляемых терминов и понятий, использовать термины строго по их назначению.

7.Везде, где возможно, необходимо использовать стандартные нотации. Схемы и диаграммы системы целесообразно представлять в известных нотациях языка UML и других популярных стандартов. Допускается применение нотаций принятых в используемых при проектировании CASEсредствах, средах программирования и СУБД.

8.Способ и форма изложения материала должны облегчить понимание читателем того, какие из результатов, упоминаемых в работе, являются авторскими, а какие - продуктом чужого творчества или уже являются общепринятыми. При необходимости использования в проекте чужих результатов нужно указывать это с точной ссылкой на источник в соответствии с принятыми требованиями цитирования. В особенности это важно для проектов, в которых автор разрабатывал отдельные компоненты крупной системы. При описании таких проектов нужно четко выделять результаты собственной разработки и указать части, которые были разработаны ранее или другими исполнителями общего проекта. Не следует излишне «раздувать» записку и включать в нее материалы обзорного характера. Использование источников

11

положительно характеризует работу и подчеркивает профессионализм автора. Однако реферирование источников не является целью курсового проектирования, а объем проекта не является показателем его качества.

2.5Правила оформления пояснительной записки

Вчасти оформления пояснительная записка должна соответствовать требованиям ГОСТ 19.106 [8].

2.5.1Общие требования

Изложение текста и оформление пояснительной записки выполняют в соответствии с требованиями ГОСТ 2.105 [9].

Пояснительная записка должна быть выполнена с использованием компьютера и принтера на одной стороне листа белой бумаги формата А4 через полтора интервала. Допускается вставлять отделные страницы в формате А3. Цвет шрифта должен быть черным, высота букв, цифр и других знаков — не менее 1,8 мм (кегль не менее 12). Текст пояснительной записки следует печатать, соблюдая следующие размеры полей: левое – 20 мм, правое – 10 мм, верхнее – 25 мм, нижнее – 15 мм. Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, применяя шрифты отличные от шрифта основного текста.

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

Допускается включать в документ части текста программы, оформляемые в соответствии с правилами языка, на котором написан текст программы.

Фамилии, названия учреждений, организаций, фирм, название изделий и другие имена собственные в пояснительной записке приводят на языке оригинала. Допускается транслитерировать имена собственные и приводить названия организаций в переводе на язык пояснительной записки с добавлением (при первом упоминании) оригинального названия.

Сокращение русских слов и словосочетаний в пояснительной записке производится по ГОСТ Р 7.0.12 [12]. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ Р 7.0.12 [12], следует приводить в перечне принятых сокращений.

12

2.5.2Нумерация структурных элементов пояснительной записки

Наименования структурных элементов пояснительной записки «Аннотация», «Содержание», «Задание на проектирование», «Введение», «Техническое задание», «Технорабочий проект», «Руководство пользователя», «Тестирование пользовательского интерфейса», «3аключение», «Список использованных источников» служат заголовками структурных элементов пояснительной записки и не нумеруются.

Основную часть пояснительной записки составляют документы. Заголовки документов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста или выравнивают по левой границе текста.

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

Раздел - первая ступень деления, обозначенная номером и снабженная заголовком.

Подраздел - часть раздела, обозначенная номером и имеющая заголо-

вок.

Пункт - часть раздела или подраздела, обозначенная номером. Может иметь заголовок.

Подпункт - часть пункта, обозначенная номером, может иметь заго-

ловок.

Абзац - логически выделенная часть текста, не имеющая номера.

При отсутствии разделов в тексте документа его первым структурным элементом является пункт.

Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.

Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами и записывать с абзацного отступа. Например:

1 Общие сведения

2 Назначение и цели создания системы

3 Характеристика объектов автоматизации и т.д.

Разделы должны иметь порядковую нумерацию в пределах одного документа. Приложения также имеют самостоятельную нумерацию разделов.

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

13

Например:

3.1Объекты автоматизации

3.2Концептуальная модель предметной области и т.д.

Номер пункта включает номер подпункта или раздела и порядковый номер пункта, разделенные точкой.

Например:

4.1.1Требования к структуре и функционированию системы

4.1.2Требования к численности и квалификации персонала системы и режиму его работы

и т.д. или

1.1 Наименование системы

1.2 Шифр темы

1.3 Заказчик и Разработчик системы и т.д.

Номер подпункта включает номер раздела, подраздела, пункта и порядковый номер подпункта, разделенные точкой.

Например:

4.1.1.1Архитектура системы

4.1.1.2Информационный обмен между компонентами системы

4.1.1.3Взаимосвязи со смежными системами

Например:

3 Заголовок третьего раздела

3.1 Заголовок первого подраздела

3.1.1

3.1.2

3.1.3 3.2 Заголовок второго подраздела

3.2.1

3.2.2

3.2.3

После номера раздела, подраздела, пункта и подпункта в тексте точку не ставят.

Если раздел или подраздел имеет только один пункт, или пункт имеет один подпункт, то нумеровать его не следует. Наличие одного подраздела в разделе эквивалентно их фактическому отсутствию.

Разделы, подразделы должны иметь заголовки. Пункты, как правило, заголовков не имеют. Заголовки должны четко и кратко отражать содержание разделов, подразделов. Заголовки разделов, подразделов и пунктов сле-

14

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

Внутри пунктов или подпунктов могут быть приведены перечисления. Перед каждым перечислением следует ставить дефис или, при необходимости ссылки в тексте документа на одно из перечислений, строчную букву (за исключением ё, з, о, г, ь, й, ы, ъ), после которой ставится скобка.

Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа, как показано в примере.

Например:

а) ____________

б) ____________

1)______

2)______

в) ____________

2.5.3Нумерация страниц

Страницы пояснительной записки следует нумеровать арабскими цифрами, соблюдая сквозную нумерацию по всему тексту пояснительной записки вместе с приложениями. Отдельная нумерация страниц в пределах документа, раздела или подраздела не допускается. Номер страницы проставляют в центре верхней части листа. Титульный лист включают в общую нумерацию страниц пояснительной записки. Номер страницы на титульном листе и листах с заданием на проектирование не проставляют.

Иллюстрации и таблицы, расположенные на отдельных листах, включают в общую нумерацию страниц. Иллюстрации и таблицы на листе формата А3 учитывают как одну страницу.

2.5.4Иллюстрации

Иллюстрации (графики, схемы, копии экранов, диаграммы и т.п.) следует располагать непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. Иллюстрации могут быть цветными. На все иллюстрации должны быть даны ссылки в тексте пояснительной записки.

Иллюстрации, за исключением иллюстрации приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается «Рисунок 1». Слово «Рисунок» и его наименование рас-

15

полагают под рисунком посередине строки. Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой.

Например:

Рисунок 1.1 – Диаграмма вариантов использования

Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения.

Например:

Рисунок А.3 – Диаграмма классов

При ссылках на иллюстрации следует писать «... в соответствии с рисунком 12» или «(рис. 12)».

2.5.5Таблицы

Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5 [13] и ГОСТ 2.105 [9].

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

Например:

Таблица 2.1 - Атрибуты класса «Сотрудник» (Employee)

Пример оформления таблицы приведен на рисунке 1.

Таблица _____–________________

Боковик (графа Графы (колонки) для заголовков)

Рисунок 1

Таблицу следует располагать в пояснительной записке непосредственно после текста, в котором она упоминается впервые, или на следующей

16

странице. На все таблицы должны быть ссылки в тексте. При ссылке следует писать слово «Таблица» с указанием ее номера.

Таблицу с большим количеством строк допускается переносить на другой лист (страницу). При переносе части таблицы на другой лист (страницу) головку таблицы повторяют.

Таблицу с большим количеством граф допускается делить на части и помещать одну часть под другой в пределах одной страницы. Если строки и графы таблицы выходят за формат страницы, то в первом случае в каждой части таблицы повторяется головка, во втором случае — боковик.

Если повторяющийся в разных строках графы таблицы текст состоит из одного слова, то его после первого написания допускается заменять кавычками; если из двух и более слов, то при первом повторении его заменяют словами «То же», а далее — кавычками. Ставить кавычки вместо повторяющихся цифр, марок, знаков, математических и химических символов не допускается. Если цифровые или иные данные в какой-либо строке таблицы не приводят, то в ней ставят прочерк.

Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой. Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, то она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.

Заголовки граф и строк таблицы следует писать с прописной буквы в единственном числе, а подзаголовки граф — со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят.

Таблицы слева, справа и снизу, как правило, ограничивают линиями. Допускается применять размер шрифта в таблице меньший, чем в тексте. Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается. Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.

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

17

2.5.6Формулы и уравнения

Уравнения и формулы следует выделять из текста в отдельную строку. Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки. Если уравнение не умещается в одну строку, то оно должно быть перенесено после знака равенства (=) или после знаков плюс (+), минус (-), умножения (×), деления (:), или других математических знаков, причем знак в начале следующей строки повторяют. При переносе формулы на знаке, символизирующем операцию умножения, применяют знак «×».

Пояснение значений символов и числовых коэффициентов следует приводить непосредственно под формулой в той же последовательности, в которой они даны в формуле.

Формулы следует нумеровать порядковой нумерацией в пределах всего документа арабскими цифрами в круглых скобках в крайнем правом положении на строке.

Например:

Одну формулу обозначают — (1).

Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (В.1).

Ссылки в тексте на порядковые номера формул дают в скобках, например: « … в формуле (1) …». Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например: « … в формуле

(3.1) …».

2.5.7Сноски

Необходимые пояснения к тексту документа могут оформляться снос-

ками.

Сноска обозначается числом, вынесенным на уровень линии верхнего обреза шрифта, например: «печатающее устройство2 . . .».

Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы, начинают с номера сноски и отделяют от основного текста линией длиной 3 см, проведенной в левой части страницы.

18

2.5.8Примечания

Впримечаниях к тексту и таблицам указывают только справочные и пояснительные данные.

Одно примечание не нумеруется. После слова «Примечание» ставят

точку.

Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечания» ставят двоеточие.

Например:

Примечание. _______________________________________________________

__________________________________________________________________

или

Примечания:

1.________________________________________________________________

__________________________________________________________________

2.________________________________________________________________

__________________________________________________________________

Текст примечаний допускается печатать через один интервал.

2.5.9Ссылки

Впояснительной записке допускаются ссылки на стандарты, технические условия и другие документы (в соответствии с ГОСТ Р 7.0.5 [14]) при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом. Ссылаться следует на документ в целом или его разделы и приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускается.

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

Ссылки на использованные источники следует приводить в квадратных скобках.

Например: «… в соответствии с ГОСТ Р 7.0.12 [12] …» или «… в соответствии с [12, разд. 2] …» или «… в соответствии с [12, с. 13].

2.5.10Перечень обозначений и сокращений

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

19

2.5.11 Список использованных источников

Сведения об источниках следует располагать в порядке появления ссылок на источники в тексте отчета и нумеровать арабскими цифрами без точки и печатать с абзацного отступа. Библиографическую запись источника делают в соответствии с ГОСТ 7.1 [11].

2.5.12 Приложения

Приложение оформляют как продолжение данного документа на последующих его листах. В тексте документа на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте документа.

Каждое приложение следует начинать с новой страницы с указанием заголовка. Заголовок размещается наверху посередине страницы (или выравнивается по левому краю). Заголовок приложения начинается со слова «Приложение»; затем идет обозначение приложения, ставится точка. После точки с прописной буквы пишется название приложения строчными буквами. Точка после названия приложения не ставится.

Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, Й, 0, Ч, Ь, Ы, Ъ. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и O. В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.

Если в документе одно приложение, оно обозначается «Приложение

А».

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

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

2.5.13 Типичные ошибки

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

20