Описания программных документов в приложениях должны выполняться в соответствии со следующими стандартами:
ГОСТ 19.401-78 Текст программы. Требования к содержанию и оформлению.
ГОСТ 19.402-78 Описание программы.
ГОСТ 19.502-78 Описание применения. Требования к содержанию и оформлению.
ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению.
ГОСТ 19.504-79 Руководство программиста. Требования к содержанию и оформлению.
ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению.
ГОСТ 19.506-79. ЕСПД. Описание языка. Требования к содержанию и оформлению.
ГОСТ 24.204-80. СТД АСУ. Требования к содержанию документа «Описание постановки задачи».
ГОСТ 24.211-82 Требования к содержанию документа «Описание алгоритма».
Требования к содержанию документов, разрабатываемых при создании автоматизированных систем (АС), установлены РД50-34.698-90, а также ГОСТ 34.602-89.
Виды и комплектность документов регламентированы ГОСТ 34.201-89.
3. ОФОРМЛЕНИЕ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ ВКР
Оформление элементов пояснительной записки ВКР необходимо выполнять с учетом требований следующих государственных стандартов:
ГОСТ 2.105-95 «Единая система конструкторской документации. Общие требования к текстовым документам»,
ГОСТ 7.32-2001 «Отчет о научно-исследовательской работе»,
ГОСТ 19.106-78 «Единая система программной документации. Требования к программным документам, выполненным печатным способом»,
ГОСТ 24.301-80 «Система технической документации на АСУ. Общие требования к выполнению текстовых документов»,
РД 50-34.698-90 «ЕКС АС. Требования к содержанию документов».
ОСТ 29.115–88. «Оригиналы авторские и текстовые издательские. Общие технические требования».
Кроме того, много полезных сведений по оформлению технической документации можно найти на сайте http://author-it.ru/.
Ниже изложены требования с учетом названных источников.
3.1. ФОРМАТИРОВАНИЕ ТЕКСТА. ПЕЧАТАНИЕ ЗНАКОВ
Пояснительная записка ВКР является комплексным документом, включающим текст, таблицы, формулы, рисунки, графики, диаграммы, схемы, фотографии, чертежи и т.п. элементы, поясняющие текстовую часть.
Страницы текста ПЗ, включенные в неё иллюстрации и таблицы должны соответствовать формату А4 по ГОСТ 9327-60.
Все листы пояснительной записки, выполняются без рамки, кроме пояснительной дипломного проекта и чертежей.
Все страницы дипломной работы, начиная со второй, должны быть оформлены рамками с основными надписями по форме 2а (ГОСТ 2.104-2006), пример оформления которых представлен в приложении С, где границы текста от рамки слева, снизу, справа на расстоянии 5мм, сверху –на 10мм.
ПЗ выполняется на принтере на одной стороне листа белой односортной бумаги формата А4.
При выполнении текстовой части работы на компьютере текст должен быть оформлен в текстовом редакторе Word for Windows.
Шрифт основного текста: Times New Roman, обычный, размер 14 пт. Межсимвольный интервал: обычный. Междустрочный интервал: полуторный. Абзацный отступ обычно устанавливается равным 1,25 см.
Текст следует печатать, соблюдая следующие размеры полей: верхнее — 25 мм, левое — 25 мм, нижнее — 20 мм и правое — 15 мм.
Текст должен быть выровнен по ширине листа (см.приложение Т).
Перед набором текста устанавливается автоматический режим переносов (кроме переносов в заголовках разделов, подразделов и пунктов, а также в названиях рисунков, таблиц и приложений).
Отдельные слова или словосочетания могут быть выделены стилем шрифта (курсивом, полужирным начертанием, подчёркиванием), если на них требуется акцентировать внимание. В случае необходимости могут выделяться одно или несколько предложений. Но злоупотреблять этими средствами не следует.
Если в тексте приводятся надписи, используемые, к примеру, в интерфейсе программного обеспечения, их выделяют стилем шрифта без употребления кавычек. Например: «…в меню Файл», «… предназначена кнопка Выполнить расчёт». Но тексты сообщений, наименования режимов (и т. д.) обрамляются кавычками, например, «… выводится сообщение «Расчёт выполнен». Следует применять только угловые кавычки (« »). Обычные кавычки могут использоваться лишь в английских текстах.
Фамилии, названия предприятий и другие имена собственные приводятся в тексте записки на языке оригинала. Допускается транскрибировать имена собственные или переводить их на русский язык (за исключением фамилий) с добавлением при первом упоминании оригинального названия.
Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графики) машинописным способом или черными чернилами, пастой или тушью рукописным способом. При этом не должно быть повреждений листов, помарок и следов прежнего текста.
При выполнении текста необходимо соблюдать равномерную плотность, контрастность и четкость изображения по всему документу. В ПЗ должны быть четкие, нерасплывшиеся линии, буквы, цифры и знаки.
Не следует использовать для оформления текста какой-либо другой цвет, кроме чёрного
Правила печатания знаков. Знаки препинания (точка, запятая, двоеточие, точка с запятой, многоточие, восклицательный и вопросительный знаки) от предшествующих слов пробелом не отделяют, а от последующих отделяют одним пробелом.
Дефис (короткая чёрточка) применяется в основном для разделения частей сложных слов и никогда не отделяется пробелами.
Тире (длинная чёрточка) – знак препинания, используемый в предложениях. Тире всегда отделяется пробелами с двух сторон, но не переносится так, чтобы с него начиналась новая строка (поэтому перед тире лучше ставить «неразрывный» пробел, если это позволяет текстовый редактор).
Кавычки и скобки не отбивают от заключенных в них элементов. Знаки препинания от кавычек и скобок не отбивают.
Знак № применяют только с относящимися к нему числами, между ними ставят пробел.
Знаки сноски (звездочки или цифры) в основном тексте печатают без пробела, а от текста сноски отделяют одним ударом (напр.: слово1, 1 Слово).
Знаки процента и промилле от чисел отбивают.
Знаки углового градуса, минуты, секунды, терции от предыдущих чисел не отделяют, а от последующих отделяют пробелом (напр.: 5º 17´´).
Знак градуса температуры отделяется от числа, если за ним следует сокращенное обозначение шкалы (напр., 15 ºС, но 15º Цельсия).
3.2. СТРУКТУРА ТЕКСТА (РУБРИКАЦИЯ, ЗАГОЛОВКИ, НУМЕРАЦИЯ)
Основную часть ПЗ следует делить на разделы, подразделы и пункты. Пункты, при необходимости, могут делиться на подпункты. При делении текста отчета на пункты и подпункты необходимо, чтобы каждый пункт содержал законченную информацию.
Разделы должны иметь порядковую нумерацию в пределах всего текста, за исключением приложений.
Пример — 1, 2, 3 и т. д.
Номер подраздела или пункта включает номер раздела и порядковый номер подраздела или пункта, разделенные точкой.
Пример — 1.1, 1.2, 1.3 и т. д.
Номер подпункта включает номер раздела, подраздела, пункта и порядковый номер подпункта, разделенные точкой.
Пример - 1.1.1.1, 1.1.1.2, 1.1.1.3 и т. д.
После номера раздела, подраздела, пункта и подпункта в тексте точку не ставят.
Если раздел или подраздел имеет только один пункт, или пункт имеет один подпункт, то нумеровать его не следует.
Если текст ПЗ подразделяют только на пункты, их следует нумеровать, за исключением приложений, порядковыми номерами в пределах всего отчета.
Разделы, подразделы должны иметь заголовки. Пункты, как правило, заголовков не имеют. Заголовки должны четко и кратко отражать содержание разделов, подразделов.
Заголовки разделов, подразделов и пунктов следует печатать без точки в конце, не подчеркивая.
Если заголовок состоит из двух предложений, их разделяют точкой.
Переносить части слова заголовка или части обозначения на другую строку не допускается.
Наименование разделов записываются в виде заголовков (симметрично тексту) прописными буквами: шрифт Times New Roman, размер 14 пт, полужирный.
Наименование подразделов записываются в виде заголовков (с выравниванием по левому краю) прописными буквами: шрифт Times New Roman, размер 14 пт, обычный.
Наименование пунктов записываются в виде заголовков (с выравниванием по левому краю) строчными буквами (кроме первой прописной), шрифт Times New Roman, размер 14 пт, полужирный.
Расстояние между заголовком и текстом, между заголовками раздела и подраздела должно быть равно одному интервала (см. приложение Т).
Каждый раздел текстового документа рекомендуется начинать с нового листа (страницы).
Структурные части записки «Аннотация», «Содержание», «Список использованных сокращений и обозначений», «Введение», «Заключение», «Список использованных источников» не нумеруют.
Для выделения объединённых по смыслу частей длинного текста он разбивается на абзацы. Число предложений в абзаце обычно колеблется от двух до пяти-шести. Абзацный отступ должен быть одинаковым в пределах всей записки.
Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным листом, в верхней части листа (над текстом, посередине), за исключением ПЗ дипломного проекта, где номера листов указывают в основной надписи.
Титульный лист включают в общую нумерацию страниц отчета. Номер страницы на титульном листе не проставляют.
Иллюстрации и таблицы, расположенные на отдельных листах, включают в общую нумерацию страниц отчета.
Иллюстрации и таблицы на листе формата А3 учитывают как одну страницу.
Нумерация страниц отчета и приложений, входящих в состав отчета, должна быть сквозная.
3.3. ИЗЛОЖЕНИЕ ТЕКСТА
Изложение содержания пояснительной записки должно быть кратким и четким, исключающим возможность неверного толкования.
В документах должны применяться научно-технические термины, обозначения и определения, установленные соответствующими стандартами, а при их отсутствии - общепринятые в научно-технической литературе.
Пояснительная записка является техническим документом, поэтому следует избегать употребления в её тексте обращений от первого лица (не «я выбрал», а «было выбрано»), оборотов разговорной речи, предложений с восклицательными знаками и т. п. При изложении обязательных требований следует применять слова «должен», «следует», «необходимо», «обеспечить» и т. п., при изложении менее категоричных положений – слова «могут быть», «как правило», «при необходимости», «в случае» и т. д.
В тексте документа не допускается:
- применять обороты разговорной речи, техницизмы, профессионализмы;
- применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;
- применять произвольные словообразования;
- применять сокращения слов, кроме установленных правилами русской орфографии и соответствующими государственными стандартами;
- сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц и в расшифровках буквенных обозначений, входящих в формулы и рисунки.
3.4. УСЛОВНЫЕ ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ
При оформлении ПЗ допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в разделе «Определения, обозначения и сокращения».
Сокращение русских слов и словосочетаний в тексте — по ГОСТ 7.12-93.
В тексте документа, за исключением формул, таблиц и рисунков, не допускается:
- применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово "минус");
- применять знак "диаметра" для обозначения диаметра (следует писать слово "диаметр"). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак "диаметр";
- применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), >= (больше или равно), <= (меньше или равно), =/ (не равно), а также знаки N (номер), % (процент).
Условные буквенные обозначения, изображения или знаки должны соответствовать принятым в действующем законодательстве и государственных стандартах. В тексте документа перед обозначением параметра дают его пояснение, например "Временное сопротивление разрыву сигма_в".
При необходимости применения условных обозначений, изображений или знаков, не установленных действующими стандартами, их следует пояснять в тексте или в перечне обозначений.
Используемые сокращения должны соответствовать правилам грамматики, а также требованиям государственных стандартов.
Однотипные слова и словосочетания везде должны либо сокращаться, либо нет (напр.: в 1919 году и ХХ веке или в 1919 г. и ХХ в.; и другие, то есть или и др., т.е.).
Существует ряд общепринятых графических сокращений:
Сокращения, употребляемые самостоятельно: и др., и пр., и т.д., и т.п.
Употребляемые только при именах и фамилиях: г-н, т., им., акад., д-р., доц., канд.физ.-мат.наук, ген., чл.-кор. Напр.: доц. Иванов И.И.
Слова, сокращаемые только при географических названиях: г., с., пос., обл., ул., просп. Например: в с. Н. Павловка, но: в нашем селе.
Употребляемые при ссылках, в сочетании с цифрами или буквами: гл.5, п.10, подп.2а, разд.А, с.54 – 598, рис.8.1, т.2, табл.10 – 12, ч.1.
Употребляемые только при цифрах: в., вв., г., гг., до н.э., г.н.э., тыс., млн., млрд., экз., к., р. Например: 20 млн. р., 5 р. 20 к.
Используемые в тексте сокращения поясняют в скобках после первого употребления сокращаемого понятия. Обозначение, встречающееся в тексте в первый раз, указывается в скобках, сразу за его расшифровкой, например, «... может применяться генетический алгоритм (ГА)». Далее по тексту обозначение употребляется уже без скобок. Допускается приводить расшифровку одного и того же обозначения в каждом из разделов записки.
В пояснительной записке собственные сокращения, как правило, вводить не требуется, но могут использоваться общепринятые сокращения, применяемые при записи единиц измерения, а также грамматические сокращения, в том числе:
после перечисления: и т. д. (и так далее), и т. п. (и тому подобное), и др.
(и другие), и пр. (и прочие);
при пояснении: т. е. (то есть);
при ссылках: см. (смотри), ср. (сравни), напр. (например);
при цифровом обозначении веков и годов: в. (век), вв. (века), г. (год), гг. (годы).
Запрещается применять сокращенные обозначения единиц измерения (в том числе денежных), если они употребляются без цифр, за исключением использования сокращений в таблицах и расшифровках формул. Сокращения типа «и др.» ставятся только перед знаком препинания или закрывающей скобкой, в середине текста их нужно записывать полностью. В конце части общеупотребительных сокращений (м, г) принято точку не ставить.
3.5. ФИЗИЧЕСКИЕ ВЕЛИЧИНЫ
В пояснительной записке следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417-2002. В качестве обозначений предусмотрены буквенные обозначения и специальные знаки, напр.: 20.5кг, 438 Дж/(кг/К), 36ºС. При написании сложных единиц комбинировать буквенные обозначения и наименования не допускается. Наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению.
Представление в ПЗ данных о свойствах веществ и материалов проводятся по ГОСТ 7.54-88.
При отборе численных данных в первую очередь необходимо использовать официально утвержденные нормативные документы: государственные и отраслевые стандарты, таблицы стандартных и рекомендуемых справочных данных, стандарты и рекомендации СЭВ и международных организаций и источники, содержащие критически оцененные численные данные (научные публикации, массивы банков данных).
В ПЗ следует включать сведения о свойствах веществ и материалов из источников, появляющихся в отечественной и зарубежной литературе. При этом следует разграничивать численные данные, полученные авторами и заимствованные ими из других источников.
Применение в одном документе разных систем обозначения физических величин не допускается.
В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти - словами.
Примеры:
1 Провести испытания пяти труб, каждая длиной 5 м.
2 Отобрать 15 труб для испытаний на давление.
Единица физической величины одного и того же параметра в пределах одного документа должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например 1,50; 1,75; 2,00 м.
Если в тексте документа приводят диапазон числовых значений физической величины, выраженных в одной и той же единице физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона.
Примеры:
1. От 1 до 5 мм.
2. От 10 до 100 кг.
3. От плюс 10 до минус 40 °С.
4. От плюс 10 до плюс 40 °С.
Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы), кроме единиц физических величин, помещаемых в таблицах, выполненных машинописным способом.
Приводя наибольшие или наименьшие значения величин следует применять словосочетание «должно быть не более (не менее)». Приводя допустимые значения отклонений от указанных норм, требований, следует применять словосочетание «не должно быть более (менее)». Например, массовая доля углекислого натрия в технической кальцинированной соде должна быть не менее 99,4 %.
Числовые значения величин в тексте следует указывать со степенью точности, которая необходима для обеспечения требуемых свойств изделия, при этом в ряду величин осуществляется выравнивание числа знаков после запятой.
Округление числовых значений величин до первого, второго, третьего и т.д. десятичного знака для различных типоразмеров, марок и т.п. изделий одного наименования должно быть одинаковым. Например, если градация толщины стальной горячекатаной ленты 0,25 мм, то весь ряд толщин ленты должен быть указан с таким же количеством десятичных знаков, например 1,50; 1,75; 2,00.
Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать 1/4″; 1/2″.
При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А -4С)/(40В + 20).
Буквенные обозначения единиц счета и измерений физических величин применяют в тексте только при числовых значениях и записывают без точки (например: 5 шт, 10 кг).
Наименование единиц счета и измерений физических величин, употребляемые в тексте без числовых значений, следует записывать без сокращений (например: длина приведена в миллиметрах).
3.6. ЗНАКИ И ЧИСЛА. ЧИСЛИТЕЛЬНЫЕ
Знаки №, §, %, +, - и т. д. следует применять только при числовых значениях. В тексте эти знаки следует писать словами. Математические знаки («+», «-», «=», «>», «<» и др.) используются только в формулах, в тексте их следует писать словами.
Римские цифры следует употреблять только для обозначения сорта (категории) изделия, кварталов года, полугодия. В остальных случаях применяют арабские цифры.
Многозначные числа пишут арабскими цифрами и разбивают на классы (напр.: 13 692). Не разбивают четырехзначные числа и числа, обозначающие номера.
Числа должны быть отбиты от относящихся к ним наименований (напр.: 25 м). Числа с буквами в обозначениях не разбиваются (напр.: в пункте 2б). Числа и буквы, разделенные точкой, не имеют отбивки (напр.: 2.13.6).
Основные математические знаки перед числами в значении положительной или отрицательной величины, степени увеличения от чисел не отделяют (напр.: -15, ×20).
Для обозначения диапазона значений употребляют один из способов: многоточие, тире, знак ÷, либо предлоги от … до … . По всему тексту следует придерживаться принципа единообразия.
Сложные существительные и прилагательные с числами в их составе рекомендуется писать в буквенно-цифровой форме (напр.: 150-летие, 30-градусный, 25-процентный).
Стандартной формой написания дат является следующая: 20.03.93 г. Возможны и другие как цифровые, так и словесно-цифровые формы: 20.03.1993 г., 22 марта 1993 г., 1 сент. 1999 г.
Все виды некалендарных лет (бюджетный, отчетный, учебный), т.е. начинающихся в одном году, а заканчивающихся в другом, пишут через косую черту: В 1993/94 учебном году. Отчетный 1993/1994 год.
Представление дат и времени дня определяется по ГОСТ 7.64—90.
Количественные числительные записываются цифрами, если они являются многозначными, и словами, если они однозначны. Например, «десять модулей», но «25 строк». При количественных числительных, записанных арабскими цифрами, падежные окончания не пишутся, если числительные сопровождаются существительными. Например, не «12-ти рублей», а «12 рублей».
Порядковые числительные пишутся либо словами («седьмой», «двадцать первый»), либо арабскими цифрами. Для выбора способа записи целесообразно использовать то же правило, что и для количественных числительных. При записи цифрами числительные имеют падежные окончания. При перечислении нескольких порядковых числительных падежное окончание ставится только один раз. Например, «уравнения 2 и 3-й степени». При записи римскими цифрами порядковые числительные падежных окончаний не имеют. Например, «XXI век», а не «XXI-й век».
При размещении в записке цифрового материала должны использоваться только арабские цифры, за исключением нумерации кварталов, полугодий и т. п., которые традиционно обозначаются римскими цифрами.
Числа с размерностью следует писать цифрами, а без размерности – словами. Например: «не более 2,5 сек.», «время уменьшится в два с половиной раза».
Если приводится ряд величин одной и той же размерности, то единица измерения указывается только после последнего числа. Аналогично, знаки номера, градуса, процента пишутся только один раз, соответственно, при первой или последней цифре. Например: «№ 2, 3, 5, 9», «7; 10; 12».
Для величин, составляющих диапазон, единица измерения пишется только один раз при второй цифре, к примеру: «3-5 см», «от 3 до 5 см».
Недопустимо отделять единицу измерения от числового значения (переносить её на следующую строку).
3.7. ПЕРЕЧИСЛЕНИЯ
При изложения большого числа однородных фактов в тексте можно использовать перечисления (списки), причем сразу после заголовка (без вводного предложения, которое предшествует перечислению) они не допускаются. Перед перечислением ставится двоеточие. Все элементы перечисления должны грамматически подчиняться вводному предложению.
Перечисления могут быть маркированными, нумерованными или буквенными.
Элементы маркированных списков с текстовыми фрагментами из нескольких предложений следует начинать с прописной буквы и в конце фрагментов ставить точку.
При мелких, например, однострочных элементах перечислений, их следует начинать со строчной буквы и заканчивать точкой с запятой.
Если элементы перечисления не имеют внутренних знаков пунктуации, например, содержат по одному слову или слову с определением, их можно разделять запятой.
Хотя при использовании текстового редактора роль маркера может выполнять произвольный символ, в пояснительной записке для поддержания строгого стиля оформления следует использовать только тире.
В нумерованных списках с крупными текстовыми фрагментами используются арабские цифры с точкой, после которой текст начинается с прописной буквы и завершается точкой. Если перечисление состоит из коротких элементов, они нумеруются арабскими цифрами со скобкой, начинаются со строчной буквы и разделяются точкой с запятой или запятой. Использование римских цифр не допускается. Аналогично, в буквенных списках в первом случае роль идентификатора элемента списка играют прописные буквы с точкой после них, а во втором – строчные буквы со скобкой.
Перечисления, элементы которых не содержат отдельных предложений, могут включаться в состав абзаца. Например, «оперативная память в системах с массовым параллелизмом имеет трёхуровневую структуру: 1) кэш-память процессора, 2) локальная оперативная память узла, 3) оперативная память других узлов».
В маркированных списках рекомендуется использовать одинаковые маркеры по всей работе.
3.8. ТАБЛИЦЫ
Объёмный цифровой материал, а также многомерный текстовой материал должен оформляться в виде таблиц. Эта форма дает лучшую наглядность и сравнимость показателей.
Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа документа.
Название таблицы, при его наличии, должно отражать ее содержание, быть точным и кратким.
Название таблицы следует помещать над таблицей слева, без абзацного отступа в одну строку с ее номером через тире (рис. 4). Заголовок следует выполнять строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры.
Рис. 4
При переносе части таблицы на ту же или другие страницы название помещают только над первой частью таблицы.
Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В. Дополнительный интервал, перед этой строкой, должен составлять 12 пт. При наличии тематического заголовка его помещают над таблицей в следующей строке и выравнивают по центру. Точка в конце заголовка таблицы не ставиться. Дополнительный начальный интервал для абзаца, следующего после таблицы, должен быть равен 18 пт.
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой.
На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком. В конце заголовков и подзаголовков точка не ставится. Обозначение единицы измерения, общей для всех данных в графе или строке, следует указывать через запятую вслед за заголовком графы или строки.
Заголовки и подзаголовки граф указывают в единственном числе.
Таблица со всех сторон, как правило, ограничивается линиями. «Шапка» таблицы также должна быть отделена линией от остальной части таблицы. Горизонтальные и вертикальные линии, разграничивающие строки и столбцы таблицы, допускается не проводить, если это не затрудняет изучение таблицы.
Использовать диагональные разделяющие линии в таблице недопустимо.
Заголовки и подзаголовки граф выравниваются по центру соответствующий графы. Они, как правило, записываются параллельно строкам таблицы, но также допускается их перпендикулярное расположение, если параллельная запись затруднительна.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Высота строк таблицы должна быть не менее 8 мм.
Графу «Номер но порядку» в таблицу включать не допускается.
При необходимости нумерация показателей, параметров или других данных порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед их наименованием, не используя отдельную графу.
Заменять кавычками повторяющиеся в таблице цифры, математические знаки, знаки процента и номера, обозначение марок материалов и типоразмеров изделий, обозначения нормативных документов не допускается.
Если параметры одной графы имеют одинаковые значения в двух и более строках, то допускается объединение соответствующих ячеек данной графы в одну ячейку и проставление параметра один раз. То же относится и к одинаковым значениям параметра в одной строке.
При отсутствии отдельных данных в таблице следует ставить прочерк (тире).
Если все показатели, приведённые в графах таблицы, выражены в одной и той же единице измерения, то её обозначение следует помещать непосредственно над таблицей справа, например, «Длительность в секундах». При делении таблицы на части это обозначение указывается над каждой её частью.
Сноски к таблицам располагают непосредственно под таблицей. Например:
Таблица 2 - Наборы данных, используемые для распечатки
Назначение
|
Стандартное имя
|
Используемое устройство
|
Для информационной распечатки
|
SSSSSSS1)
|
Печатающее устройство2)
|
Для распечатки во время выполнения программы
|
РРРРРРРР
|
Печатающее устройство2)
|
1) Имя SSSSSSS должно быть задано при настройке операционной системы.
2) Для уменьшения простоев центрального процессора из-за операций ввода-вывода может быть использована магнитная лента.
Если таблица текстовая, то текст в ячейках таблицы всегда начинается с прописной буквы без точки в конце. Однако все промежуточные знаки препинания проставляются, в том числе и точки между предложениями. Текстовое значение записывается на уровне первой строки наименования показателя. Числовое значение показателя проставляется на уровне последней строки наименования показателя. При этом числа должны располагаться так, чтобы цифры одного разряда во всей графе были расположены точно друг под другом. Числовые величины в одной графе должны иметь одинаковое количество десятичных знаков.
Если строки или графы таблицы выходят за формат листа, таблицу делят на части, помещая одну часть под другой. И в каждой части таблицы повторяют её шапку и боковик (первую графу). При этом во второй и последующих частях допускается замена шапки и боковика таблицы соответственно номерами граф и строк. Также нумерация граф или строк производится, если на них имеются ссылки в тексте. Номера граф задаются отдельной строкой сразу после шапки таблицы, номера строк – первой графой.
Если таблица занимает несколько листов пояснительной записки, то в начале каждого листа, на котором продолжается таблица, рекомендуется добавлять строку с записью «Продолжение табл.», выровненной по правому краю, и указывать номер таблицы, например, «Продолжение табл. 6.1». Название таблицы при этом не повторяется.
Примеры оформления таблиц в пояснительной записке приведены в приложении У.
3.9. ИЛЛЮСТРАЦИИ
Все имеющиеся в работе иллюстрации (чертежи, графики, схемы, компьютерные распечатки, диаграммы, фотоснимки и пр.) именуются рисунками.
Количество иллюстраций должно быть достаточным для пояснения излагаемого текста.
Чертежи, графики, диаграммы, схемы, иллюстрации, помещаемые в ПЗ, должны соответствовать требованиям государственных стандартов (см.п.1.3.2 настоящих методических указаний).
Перечень допускаемых сокращений слов в графических документах установлен в ГОСТ 2.316-2008.
Иллюстрации могут быть расположены в тексте документа и (или) в приложениях.
Иллюстрации следует располагать в ПЗ непосредственно после текста, в котором они упоминаются впервые, или на следующей странице.
Иллюстрации, если их в данном документе более одной, за исключением иллюстрации приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа. Допускается не нумеровать мелкие иллюстрации, размещенные непосредственно в тексте и на которые в дальнейшем нет ссылок.
Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 - Детали прибора.
Слово «рисунок», его номер и наименование рисунка помещают ниже изображения и пояснительных данных, по центру (относительно рисунка).
Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющими данными.
Текст, обтекающий иллюстрацию, должен отстоять от нее на расстоянии не менее 8 мм. Дополнительный интервал между текстом (сверху) и иллюстрацией, между подписью иллюстрации и текстом (снизу) – 12 пт, между иллюстраций и её подписью – 6 пт.
Размеры иллюстраций не должны превышать формата страницы с учетом полей. Если ширина рисунка больше 8 см, то его располагают симметрично посередине. Если его ширина менее 8 см, то рисунок, как правило, располагают с краю, в обрамлении текста. Допускается размещение нескольких иллюстраций на одном листе. Сложные иллюстрации могут выполняться на листах формата А3 и больше со сгибом для размещения в пояснительной записке.
Фотоснимки размером меньше формата А4 должны быть наклеены на стандартные листы белой бумаги.
Рисунки, фотографии, вставляемые в ПЗ, должны быть без пометок, карандашных исправлений, пятен, трещин и загибов.
На все иллюстрации должны быть даны ссылки в ПЗ. При ссылках на иллюстрации следует писать «... в соответствии с рисунком 2» при сквозной нумерации и «... в соответствии с рисунком 1.2» при нумерации в пределах раздела.
В тексте, где идет речь о теме, связанной с иллюстрацией, помещают ссылку либо в виде заключенного в круглые скобки выражения (рис.3.1) либо в виде оборота типа «…как это видно на рис.3.1».
Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом «смотри», например, «см. рис. 12».
Иллюстрации должны быть расположены так, чтобы их было удобно рассматривать без поворота работы или с поворотом по часовой стрелке.
При переносе объёмной иллюстрации на следующий лист (в исключительных случаях) её наименование не повторяется, однако ниже указывается номер иллюстрации со словом «продолжение», например, «Продолжение рис. 3.1».
Иллюстрации, размещаемые на отдельном листе, могут иметь как вертикальную, так и горизонтальную ориентацию.
Иллюстрации могут быть в компьютерном исполнении, в том числе и цветные.
Иллюстрации должны быть вставлены в текст одним из следующих способов:
- либо командами ВСТАВКА-РИСУНОК (используемые для вставки рисунков из коллекции, из других программ и файлов, со сканера, созданные кнопками на панели рисования, автофигуры, объекты Word Art, а так же диаграммы). При этом все иллюстрации, вставляемые как рисунок, должны быть преобразованы в формат графических файлов, поддерживаемых Word;
- либо командами ВСТАВКА-ОБЪЕКТ. При этом необходимо, чтобы объект, в котором создана вставляемая иллюстрация, поддерживался редактором Word стандартной конфигурации.
Примеры оформления различных иллюстраций в ПЗ показаны в приложениях Ф, Х, Ц [23], Ш к данным методическим указаниям.
С дополнительными требованиями к иллюстрациям рекомендуется ознакомиться в п.п.6.10 – 6.25 ГОСТ 2.601-2006.
3.10. ФОРМУЛЫ
В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами. Все расчеты представляются в системе СИ. Размерность одного и того же параметра в пределах одного документа должна быть постоянной.
Формулы и расчеты должны органически вписываться в текст, не разрывая его грамматической структуры. Формулы следует располагать на середине строки, а связывающие их слова «где», «следовательно», «откуда», «находим», «определяем» – в начале строк.
Небольшие и не имеющие особого значения формулы можно размещать непосредственно в строке текста, а объёмные, достаточно важные формулы, на которые будут делаться ссылки, следует выделять в отдельную строку. В этом случае формулы размещают с абзацного отступа или выравнивают по центру, отделяя от текста снизу и сверху дополнительным интервалом в 6 пт.
Формулы лучше размещать отдельными строками, но небольшие формулы можно размещать по тексту. Если формула имеет высоту до 1,5 интервала и в тексте на нее нет ссылок, то она может быть помещена в текст.
Формулы, следующие одна за другой и не разделенные текстом, отделяют запятыми.
Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки. Для удобства чтения следует между формулой (группой формул) и текстом установить интервал, равный одному интервалу текста.
Формулы, следующие одна за другой и не разделённые текстом, отделяют друг от друга запятой или точкой с запятой, которые ставят за формулами до их номера. При написании формул, не помещающихся по ширине листа, их разделяют на две, три и более строк. Переносы формул со строки на строку осуществляются в первую очередь на знаках отношения (=; ≠; ≥, ≤ и т.п.), во вторую – на знаках сложения и вычитания, в третью – на знаке умножения. При переносе эти знаки повторяются в конце и начале строк. При переносе формулы на знаке умножения применяют знак «×». Не допускаются переносы на знаке деления (:). Переносить на другую строку допускается только самостоятельные члены формулы. Не допускается при переносе разделение показателей степени, выражений в скобках, дробей, а также выражений, относящихся к знакам корня, интеграла, суммы, логарифма, тригонометрических функций и т. п.
Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под формулой. Пояснения каждого символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова "где" без двоеточия после него.
Пояснение для того или иного символа или коэффициента не даётся, если оно уже было сделано ранее в этом разделе (для другой формулы или в тексте).
Формулы, на которые в дальнейшем придется ссылаться, следует нумеровать. Все формулы нумеруются арабскими цифрами, номер ставят с правой стороны листа на уровне формулы в круглых скобках (номер формулы выравнивается по правому краю текста). Нумерация формул в разделе начинается с единицы.
Номер формулы состоит из 2-х частей, разделенный точкой, например (3.1), первая часть выделена под номер раздела, вторая часть – номер формулы. Допускается нумерация формул в пределах пояснительной записки. При переносе формулы номер ставят напротив последней строки в край текста. Если формула помещена в рамку, номер помещают вне рамки против основной строки формулы. В приложениях формулы нумеруются в пределах каждого приложения с добавлением буквенного обозначения приложения.
Производные от приведённой ранее основной формулы можно обозначать, используя номер основной формулы с добавлением строчной буквы русского алфавита, которая пишется слитно с номером, например, (6.1а).
Группа формул, объединенных фигурной скобкой, имеет один номер, помещаемый точно против острия скобки.
В пределах всего документа или его частей, в случае деления документа на части, формулы имеют сквозную нумерацию.
Ссылки в тексте на порядковый номер формулы дают в скобках, например: «в формуле (3)», «…из формулы (3.1) следует…».
При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: «в формуле (1.4)».
В конце формулы и в тексте перед ней знаки препинания ставят в соответствии с правилами пунктуации.
Формулы, которые нельзя корректно представить в текстовом виде (многоуровневые, использующие операцию суммирования и т. д.), должны создаваться средствами редактора формул, встроенного в используемый текстовый редактор или внешнего.
Для подготовки формул в пояснительной записке может быть использован встроенный редактор формул MS Word.
При использовании других текстовых редакторов (например, группы TeX) следует стремиться к тому, чтобы высота символа в формуле и его начертание совпадали со шрифтом основного текста пояснительной записки.
В формулах английские и латинские буквы набираются курсивом, русские и греческие — прямым шрифтом.
Допускается также вписывать формулы в текст пояснительной записки от руки черной тушью (по ГОСТ 2.304) чертежным шрифтом высотой не менее 2,5 мм.
Применение машинописных и рукописных символов в одной формуле не допускается.
Пример. Для оценки значимости слов используется методы определения частот слов каждого документа и частот, рассчитанных по формуле Шеннона (сигнал-шум):
 (1.1)
где Sk– сигнал термина,
Nk– шум термина,
fk– частота k – го термина в i– м документе,
Fk– частота k – го термина по всем документам.
3.11. ПРИМЕЧАНИЯ, ПРИМЕРЫ И СНОСКИ
Примечания используются, если необходимы пояснения или справочные данные к содержанию текста, таблицы или иллюстрации. Их следует помещать непосредственно после материала, к которому они относятся. Примечания не должны содержать требования.
Слово «примечание» пишется с прописной буквы с абзацного отступа и выделяется полужирным стилем шрифта. После слова «примечание» ставится точка и приводится текст примечания, начинающийся с прописной буквы. Текст примечаний допускается печатать только через один интервал. Для записи примечаний целесообразно использовать кегль шрифта 12. Например:
|
