Символ с полосой Подробное представление

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

Методическая указания рассмотрены на заседании цикловой комиссии прикладной информатики и программирования.

Протокол № ­­­____ от “____”______________2010

Председатель комиссии_______________А.С. Шандриков

1. ОБЩИЕ СВЕДЕНИЯ

Дипломный проект представляет собой совокупность текстовых и графических документов разработанного программного продукта. Текстовые документы дипломного проекта выполняются в виде сброшюрованных пояснительной записки и приложений на листах писчей бумаги формата А4 (210× 297 мм). Графические документы выполняются на листах чертёжной бумаги формата А1 (594× 841 мм). Пояснительная записка и графические материалы должны быть оформлены в строгом соответствии с требованиями стандартов Единой системы программной документации. Пояснительная записка включает следующие разделы:

– титульную часть;

– информационную часть;

– основную часть;

– приложения.

2. ОФОРМЛЕНИЕ ТИТУЛЬНОЙ ЧАСТИ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

Титульная часть состоит из листа утверждения и титульного листа.

2.1. Оформление листа утверждения

Лист утверждения является первым листом пояснительной записки. Лист утверждения не нумеруется и не входит в общее количество листов пояснительной записки [1]. Лист утверждения заполняют по форме, представленной на рис. 1.

Содержание полей:

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

поле 2 – в правой части подпись заведующего отделением, допустившего дипломный проект к защите. Справа от подписи проставляют инициалы и фамилию заведующего отделением, поставившего подпись. Между инициалами пробел не набирают, а фамилия отделяется от инициалов одним пробелом, например, «А.Н. Сидоренко». Ниже подписи проставляют дату подписания;

Рисунок 1 – форма заполнения листа утверждения и титульного листа

поле 3 – полное наименование темы дипломного проекта в соответствии с заданием на дипломный проект, наименование документа. Наименование темы указывают прописными буквами, а наименование документа – как в предложении;

поле 4 – обозначение документа. Обозначение документа имеет следующую структуру:

ВГПТ.400101.Д06.816-ЛУ,

где ВГПТ – аббревиатура полного наименования учреждения образования, в данном примере – Витебский государственный политехнический техникум;

400101 – номер специальности;

буква Д - дипломный проект;

06 – год защиты, в данном примере – 2006;

816 – регистрационный номер дипломного проекта;

ЛУ – лист утверждения;

поле 5 не заполняют;

поле 6 – в правой части располагают:

– подпись учащегося, выполнившего дипломный проект с указанием обозначения учебной группы;

– подпись руководителя дипломного проекта;

– подпись консультанта по экономической части дипломного проекта;

– подпись нормоконтролёра;

– подпись рецензента.

Справа от каждой подписи проставляются инициалы и фамилии лиц подписавших документ, а снизу – дата подписания;

поле 7 – год выпуска документа (без указания слова «год» или «г»);

поле 8 – отметка об учёте и хранении документа по ГОСТ 19.601-78;

поле 9 – строка изменений по ГОСТ 19.604-78;

поле 10 – литера документа.

Перенос слов по слогам на листе утверждения не разрешается.

Точка в конце наименования темы дипломного проекта, наименования и обозначения документа не ставится.

Пример заполнения листа утверждения приведён в приложении 1.

2.2. Оформление титульного листа

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

Титульный лист заполняют по тем же правилам, что и лист утверждений, но при этом:

поле 2 не заполняют;

поле 3 заполняют так же, как и в листе утверждения, но в обозначении документа вместо аббревиатуры «ЛУ» указывают аббревиатуру «ПЗ»;

в поле 5 указывают объём документа (количество листов);

поле 6 не заполняют.

В левом верхнем углу титульного листа должна быть надпись «Утверждён» и ниже надписи указывают обозначение листа утверждения.

Пример заполнения титульного листа приведён в приложении 2.

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

3. ОФОРМЛЕНИЕ ИНФОРМАЦИОННОЙ ЧАСТИ

ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

В состав информационной части входят:

– задание на дипломный проект;

– содержание.

3.1. Оформление задания.

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

3.2. Оформление содержания

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

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

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

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

3.4. Параметры страницы

Содержание, основная часть текста пояснительной записки и приложения располагаются на листах формата А4 (210 × 297 мм). Все указанные разделы пишутся (печатаются) на одной стороне листа с соблюдением следующих размеров полей [1]: левое – 20 мм, правое – 10 мм, верхнее – 25 мм, нижнее – 15 мм. Границы полей какими-либо линиями или рамкой не обозначаются.

Оформление текста пояснительной записки с использованием печатающих устройств ЭВС рекомендуется осуществлять в среде текстового процессора WORD из пакета Microsoft Office. В этом случае необходимо выполнить следующие настройки;

1) установить размеры полей в соответствии с указанными в данном подразделе;

2) задать гарнитуру шрифта Times New Roman с высотой кегля 12;

3) установить межстрочный интервал 1, 25;

4) задать режим выравнивания текста по ширине;

5) активизировать режим автоматического переноса слов по слогам;

6) установить режим нумерации страниц: задать начальный номер 3, отменить нумерацию первой страницы. В результате выполненных настроек на третьей странице пояснительной записки (первой странице текстового файла), на которой начинается раздел «Содержание», номер проставлен не будет, а на всех последующих страницах он будет проставляться автоматически по мере набора текста. Расположение номера страницы следует указать в центре верхней строки листа;

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

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

4. ОФОРМЛЕНИЕ ОСНОВНОЙ ЧАСТИ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

4.5. Построение документа

4.5.1. Структурными элементами текста документа являются разделы, подразделы, пункты, под­пункты и перечисления [2].

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

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

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

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

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

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

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

Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т. д. Допускается выделять перечисления проста­новкой дефиса перед текстом.

Не рекомендуется делать ссылки на элементы перечисления.

Каждый структурный элемент начинается с абзацного отступа.

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

Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).

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

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

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

Не допускается располагать заголовок раздела, подраздела, пункта, подпункта на последней строке листа (страницы).

4.5.3 Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой за исключением разделов «Содержание», «Введение», «Заключение», «Литература» и приложений. Разделы должны иметь порядковый номер (1, 2 и т. д.).

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

Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в дан­ный раздел, разделённые точкой (2.1; 3.1. и т. д.).

При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый но­мер пункта и подпункта (3.1.1, 3.1.1.1. и т.д.).

Пример:

4.6. Общие требования к тексту

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

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

При этом допускается использовать повествовательную форму изложения текста документа, например «применяют», «указывают» и т.п.

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

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

4.6.2. В тексте документа не допускается:

– применять обороты разговорной речи, техницизмы, профессионализмы;

– применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов врусском языке;

– применять произвольные словообразования;

– применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе;

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

4.6.3. В тексте документа, за исключением формул, таблиц и рисунков, не допускается:

– применять математический знак минус (–) перед отрицатель­ными значениями величин (следует писать слово «минус»);

– применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак «Ø»;

– применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), > (больше или равно), < (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент);.

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

4.6.4. Условные буквенные обозначения, изображения или знаки должны соответствовать принятым в действующем законодательстве и государственных стандартах. В тексте документа перед обозначе­нием параметра дают его пояснение, например «Время задержки сигнала t_з».

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

4.6.5. В тексте документа следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417.

Наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физи­ческих величин не допускается.

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

Примеры:

1) … содержатся пять файлов конфигурации, каждая длиной 5 кБ.

2) Скопировать 15 файлов в …

4.6.7. Единица физической величины одного и того же параметра в пределах одного документа должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и гой же единице физической величины, то ее указывают только после последнего числового значения, например 1, 50, 1, 75, 2, 00 м.

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

Примеры:

1) От 1 до 5 мм.

2) От10 до 100 кг.

3) От плюс 10 до минус 40 º С. От плюс 10 до плюс 40 º С.

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

4.6.9. Приводя наибольшие или наименьшие значения величин следует применять словосочетание «должно быть не более (не менее)».

Приводя допустимые значения отклонений от указанных норм, требований следует применять словосочетание «не должно быть более (менее)», например: «оперативная память должна быть не менее 128 кБ».

4.6.10. Числовые значения величин в тексте следует указывать со степенью точности, которая необходима для обеспечения требуемых свойств изделия, при этом в ряду величин осуществляется вырав­нивание числа знаков после запятой.

Округление числовых значений величин до первого, второго, третьего и т.д. десятичного знака для различных типоразмеров, марок и т.п. изделий одного наименования должно быть одинаковым. Например, если градация толщины стальной горячекатаной ленты 0, 25 мм, то весь ряд толщин ленты должен быть указан с таким же количеством десятичных знаков, например: «1, 50; 1, 75; 2, 00».

4.6.11. Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать ¼ ″, ½ ″.

4.6.12. Разрешается использовать компьютерные возможности акцентирования внимания на определённых терминах, формулах, теоремах, применяя шрифты разной гарнитуры.

4.7. Оформление иллюстраций

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

4.7.2. Чертежи, графики, диаграммы, схемы, помещаемые в работе, должны соответствовать требованиям государственных стандартов ЕСПД и ЕСКД.

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

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

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

В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установлен­ном для основного текста документа.

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

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

Слово «Рисунок» и наименование помещают после пояснительных данных и располагают по центру строки относительно границ левого и правого полей следующим образом: Рисунок 4 – Диалоговое окно помощи. Слово «Рисунок» и его наименование располагают посередине строки относительно левой и правой границ текста.

4.7.5. Ссылки на иллюстрации дают по типу: «рис.12» или «(рис.12)».

Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом «смотри», например, «см. рис. 12».

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

Надписи, обозначающие величины, отложенные по осям графиков, располагаются строкой параллельной оси. В надписи указывают название отложенной величины и единицы измерения.. Единицы измерения указывают в стандартных сокращениях и отделяют от названия величины запятой, например: «напряжение, мкВ», «ток, А». В случае применения условных (относительных) безразмерных единиц следует писать «условные единицы», например: «напряжённость поля, усл. ед».

Допускается заменять названия физических величин их условными обозначениями, например: «U, мВ», «E, мкВ/м». Стрелки на осях графиков делать не следует.

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

4.8. Написание формул и уравнений

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

При оформлении пояснительной записки с использованием ЭВС написание формул следует выполнять с использованием редактора формул, встроенного в текстовый процессор WORD.

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

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

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

где τ =RC – постоянная времени.

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

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

U = I·R, мВ,

где I – ток, мкА; R – резистивное сопротивление, кОм.

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

При делении документа на разделы номер формулы включает номер раздела и порядковый номер формулы, раз­делённые точкой, например: «в формуле (1.4)».

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

	(1)
	(2)

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

4.8.6. Ссылки в тексте на порядковый номер формулы дают в скобках, например: «…в формуле (3)…».

4.9. Построение таблиц

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

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

Примеры оформления таблиц приведены в приложении 5

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

При делении документа на разделы допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы включает номер раздела и порядковый номер таблицы в пределах раздела, раз­делённые точкой, например: «Таблица 1.4».

Номер таблицы располагается с выравниванием по левой границе таблицы.

Между номером таблицы и таблицей должна быть одна пустая строка.

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

Название таблицы выполняют строчными буквами. Прописными буквами обозначают заглавные буквы и аббревиатуры.

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

4.9.4. Таблицу с большим количеством строк допускается переносить на другой лист (страницу). При переносе части таблицы на другой лист (страницу) слово “Таблица” и номер ее указывают один раз слева над первой частью таблицы, над другими частями пишут слово “Продолжение” и указывают номер таблицы, например: “Продолжение таблицы 1”. При переносе таблицы на другой лист (страницу) название таблицы помещается только над ее первой частью.

Пример

Таблица …

В миллиметрах

Продолжение таблицы …

В миллиметрах

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

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

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

Пример

Таблица …

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

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

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

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

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

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

Головка таблицы должна быть отделена линией от остальной части таблицы.

4.9.7. Графу " Номер по порядку" в таблицу включать не допускается. * Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части, а также при переносе части таблицы на следующую страницу.

Пример

Таблица …

Размеры в миллиметрах

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

Пример

Таблица …

4.9.8. Ограничительные слова «более», «не более», «менее», «не менее» и др. должны быть помещены в одной строке или графе таблицы с наименованием соответствующего показателя после обозначения его единицы физической величины, если они относятся ко всей; строке или графе. При этом после наименования показателя перед ограничительными словами ставится запятая.

4.10. Оформление сносок

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

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

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

4.10.2. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы с абзацного отступа.

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

4.11. Оформление ссылок

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

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

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

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

4.12. Оформление примечаний

4.12.1. Слово «Примечание» следует печатать с прописной буквы с абзацного отступа вразрядку и не подчеркивать.

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

4.12.3. Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания.

Одно примечание не нумеруют. После слова «Примечание» ставят точку и текст примечания начинают печатать в этой же строке с прописной буквы.

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

Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы.

4.13. Оформление библиографического описания источников информации

Библиографическое описание источников информации является заключительным разделом основной части пояснительной записки, имеющим заголовок «Источники информации». Библиографическое описание составляют непосредственно по произведению печати или выписывают из каталогов и библиографических указателей полностью без пропусков каких-либо элементов, сокращений заглавий и т.п. в соответствии с требованиями [5].

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

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

Связь библиографического описания с основным текстом осуществляется по номерам источников информации. При ссылке на какой-либо источник информации в основном тексте указывается его номер, заключённый в прямые скобки, например [12]. Допускается одновременно ссылаться на несколько источников информации а также указывать номера страниц, например [9, 14], [4–6], [2, с. 12], [5, с. 16-18].

Порядок составления записи описания каждого отдельного источника информации зависит от вида издания, количества авторов и др. факторов. Ниже приведены примеры различных видов библиографических описаний [1].

Один, два или три автора:

1. Ганус А.А. Тайна земных катастроф / А.А. Ганус. – М.: Мысль, 1985. – 189 с.

2.Морозов К.К. Использование ЭЦВМ при конструировании некоторых узлов РЭА / К.К. Морозов, В.Г. Одиноков. - М.: Сов. радио, 1972.

3. Корячко В.П. Теоретические основы САПР / В.П. Корячко, В.М. Курейчик, И.П. Норенков И.П. - М.: Энергоатомиздат, 1987.

Четыре, пять и более авторов:

4. Современная флексографическая печать: Учеб. пособие / Ф.С. Савицкий [и др.]; – Киев: Наукова думка, 1969. – 72 с.

5. Разработка и оформление конструкторской документации радиоэлектронной аппаратуры: Справочник / Э.Т. Романычева [и др.]; под ред. Э.Т. Романычевой. – 2-е изд., перераб. и доп. - М.: Радио и связь, 1989.

Коллективный автор:

6. Составление библиографического описания: Краткие правила / Междувед. каталогизац. комис. при Гос. б-ке СССР им. Ленина. – М.: Изд-во «Кн. палата», 1991. – 224 с.

7. Результаты и показатели медицинской науки Беларуси: информационный бюллетень / Белорусский центр медицинских технологий, информатики, управления и экономики здравоохранения. – Минск, 1996. – 167 с.

Многотомное издание:

8. Изотопы и радиация в сельском хозяйстве: в 2 т. / пер. с англ. В.Д. Цындебаев. – М.: Агропромиздат, 1989.

Т.1: Почва – растения – влага. – 302 с.

Т.2: Животные – растения – питание – окружающая среда. – 306 с.

9. Сборник единичных расценок на ремонтно-строительные работы в Республике Беларусь: в 2 кн. / гл. ред. А.В. Пурцев. – Минск, 1992. 2 кн.

5. ОФОРМЛЕНИЕ ГРАФИЧЕСКОЙ ЧАСТИ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

5.1. Символы для выполнения структурных схем программ

и блок-схем алгоритмов

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

При выполнении схем алгоритмов и программ отдельные функции алгоритмов и программ с учётом их детализации отображаются в виде условных графических обозначений – символов в соответствии с [3].

Символы разделяются на следующие группы:

1) символы данных;

2) символы процесса;

3) символы линий;

4) специальные символы.

Наименование, условное графическое обозначение (с размерами), назначение символов и отображаемые ими функции в алгоритмах и программах обработки данных представлены в таблице 5.1.

Таблица 5.1

Наименование	Условное графическое обозначение	Назначение символа	Функция символа в алгоритмах и программах
Символы данных
Ввод-вывод		Отображает данные, носитель данных не определен	Преобразование данных в форму, пригодную для обработки (ввод) или отображения результатов обработки (вывод)
Неавтономная память		Отображает хранимые данные в виде, пригодном для обработки, носитель данных не определен	Ввод-вывод данных в случае использования запоминающего устройства, управляемого непосредственно процессором
Продолжение таблицы 5.1
Наименование	Условное графическое обозначение	Назначение символа	Функция символа в алгоритмах и программах
Автономная память			Ввод-вывод данных в случае использования запоминающего устройства, не управляемого непосредственно процессором
Оперативная память		Отображает данные, хранящиеся в оперативном запоминающем устройстве	Ввод-вывод данных, носителем которых служит магнитный сердечник
Магнитный барабан		Отображает данные, хранящиеся в запоминающем устройстве с прямым доступом	Ввод-вывод данных, носителем которых служит магнитный барабан
Магнитный диск		Ввод-вывод данных, носителем которых служит магнитный диск
Перфокарта		Ввод-вывод данных, носителем которых служит перфокарта
Перфолента		Ввод-вывод данных, носителем которых служит перфолента
Продолжение таблицы 5.1
Наименование	Условное графическое обозначение	Назначение символа	Функция символа в алгоритмах и программах
Магнитная лента		Отображает данные, хранящиеся в запоминающем устройстве с прямым доступом	Ввод-вывод данных, носителем которых служит магнитная лента
Магнитная карта		Отображает данные, представленные на магнитной карте	Ввод-вывод данных, носителем которых служит магнитная карта
Документ		Отображает данные, представленные на носителе в удобочитаемой форме	Ввод-вывод данных, носителем которых служит бумага
Ручной ввод		Отображает данные, вводимые вручную во время обработки с устройств любого типа	Ввод данных вручную при помощи неавтономных устройств с клавиатурой, набором переключателей, кнопок
Дисплей		Отображает данные, представленные в удобочитаемой форме на экранах для визуального наблюдения, индикаторах ввода информации	Ввод-вывод данных, если непосредственно подключенное к процессу устройство воспроизводит данные и позволяет оператору ЭВМ вносить изменения в процессе их обработки
Архив			Хранение комплекта упорядоченных носителей данных в целях повторного применения
Продолжение таблицы 5.1
Наименование	Условное графическое обозначение	Назначение символа	Функция символа в алгоритмах и программах
Символы процесса
Процесс		Отображает функцию обработки данных любого вида	Выполнение операций или группы операций, в результате которых изменяется значение, форма представления или расположение данных
Предопределённый процесс		Отображает предопределённый процесс, состоящий из одной или нескольких операций или шагов программы, которые определены в другом месте (в подпрограмме, модуле)	Использование ранее созданных и отдельно описанных алгоритмов или программ
Ручная операция		Отображает любой процесс, выполняемый человеком	Автономный процесс, выполняемый вручную или при помощи неавтоматически действующих средств
Модификация		Отображает модификацию команды или группы команд с целью воздействия на некоторую последующую функцию	Выполнение операций, меняющих команды или группу команд, изменяющих программу
Решение		Отображает решение или функцию переключающего типа, имеющую один вход и ряд альтернативных выходов, один и только один из которых может быть активизирован после вычисления условий, определённых внутри этого символа	Выбор направления выполнения алгоритма или программы в зависимости от некоторых переменных условий
Продолжение таблицы 5.1
Наименование	Условное графическое обозначение	Назначение символа	Функция символа в алгоритмах и программах
Выделение			Удаление одного или нескольких множеств из единого множества
Группировка			Объединение двух или более множеств с выделением нескольких других множеств
10. Сортировка			Упорядочение множества по заданным признакам
Граница цикла		Отображает начало и конец цикла.	Указание начала и окончания цикла вычислений.
Пуск-останов		Отображает выход во внешнюю среду и вход из внешней среды	Начало, конец, прерывание процесса обработки данных или выполнения программы
Символы линий
Линия		Отображает поток данных или управления	Указание последовательности между символами
Параллельные действия		Отображает синхронизацию двух или более параллельных операций	Начало или окончание двух и более одновременно выполняемых операций
Продолжение таблицы 5.1
Наименование	Условное графическое обозначение	Назначение символа	Функция символа в алгоритмах и программах
Передача управления		Отображает непосредственную передачу управления от одного процесса к другому.	Передача управления от одного процесса к другому, иногда с возможностью прямого возвращения к инициирующему процессу после того, как инициирующий процесс завершит свои функции
Канал связи		Отображает передачу данных по каналу связи	Передача данных по каналам связи
Специальные символы
Соединитель			Указание связи между прерванными линиями потока, связывающими символами
Комментарий		Символ используется для добавления описательных комментариев или пояснительных записей	Связь между элементом схемы и пояснением

Размер a должен выбираться из ряда 10, 15, 20 мм. Допускается увеличивать размер a на число, кратное 5. Размер b равен 1, 5a.

П р и м е ч а н и я:

1. При ручном выполнении схем алгоритмов и программ для символов «Процесс», «Решение», «Модификация», «Предопределённый процесс», «Ручная операция», «Ручной ввод», «Ввод-вывод», «Перфокарта», «Пуск-останов» и «Архив» допускается устанавливать размер b равным 2a.

2. Символы «Выделение», «Группировка», «Сортировка» и «Автономная память» допускается представлять в виде равнобедренного прямоугольного треугольника с катетом a.

5.2. Правила применения символов и выполнения схем

5.2.1. Правила применения символов

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

5.2.1.2. Символы в схеме должны быть расположены равномерно. Следует придерживаться разумной длины соединений и минимального числа длинных линий.

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

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

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

Пример.

Если объем текста, помещаемого внутри символа, превышает его размеры, следует использовать символ комментария.

Если использование символов комментария может запутать или разрушить ход схемы, текст следует помещать на отдельном листе и давать перекрестную ссылку на символ.

5.2.1.5. В схемах может использоваться идентификатор символов. Это связанный с данным символом идентификатор, который определяет символ для использования в справочных целях в других элементах документации (например, в листинге программы). Идентификатор символа должен располагаться слева над символом.

Пример.

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

Пример.

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

Пример.

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

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

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

Символ с полосой Подробное представление

5.2.2. Правила выполнения соединений

5.2.2.1. Потоки данных или потоки управления в схемах показываются линиями. Направление потока слева направо и сверху вниз считается стандартным.

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

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

Пример.

5.2.2.3. Две или более входящие линии могут объединяться в одну исходящую линию. Если две или более линии объединяются в одну линию, место объединения должно быть смещено.

Пример.

5.2.2.4. Линии в схемах должны подходить к символу либо слева, либо сверху, а исходить либо справа, либо снизу. Линии должны быть направлены к центру символа.

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

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

Пример.