Требования к оформлению текстовых документов
Оформление текста
2.1.1 Текст документа должен быть кратким, четким. При изложении обязательных требований используют слова: «должен», «следует», «необходимо», «запрещается», «не допускается», «в случае» и т.д.
В документе должны применяться научно-технические термины,обозначения и определения.
2.1.2 Текстовые документы оформляют шрифтом Times New Roman, размер 14, начертание обычное, межстрочный интервал полуторный, выравнивание по ширине. Отступ красной строки – 1,5 сантиметра.
2.1.3 В тексте документа не допускается:
применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово «минус»);
применять знак «?» для обозначения диаметра (следует писать слово «диаметр»);
применять без числовых значений математические знаки, например (больше), (меньше), = (равно), № (номер), % (процент) и др. ;
применять индексы ГОСТ, ОСТ, ТУ без регистрационного номера.
2.1.4 В тексте и таблицах не должно быть сокращений слов, за исключением установленных стандартом (см. приложение А). Допускается следующий способ сокращения, например:
Данный программный продукт (ПП) разработан в среде программирования Delphi.
В дальнейшем сочетание слов «программный продукт» можно заменять его сокращением «ПП».
2.1.5 Числовые значения единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти – словами.
Примеры:
провести испытания пяти труб, каждая длиной 5 м;
отобрать 15 труб для испытаний на давление.
2.1.6 Числовые значения физических величин, их диапазоны, дробные числа указывают согласно примерам:
1,50; 1,75; 2,00 м (количество десятичных знаков одинаково);
….от 1 до 5 мм;
….от 10 до 100 кг;
…от плюс 10 до плюс 40°С;
¼”; ½”
5/32 — запись простой дроби в одну строку.
2.1.7 При наборе текста можно применять перечисления. Перечисление записывают с абзацного отступа. Перед каждой позицией перечисления следует ставить дефис или при необходимости ссылки в тексте документа на одно из перечислений, строчную букву (за исключением ё, з, й, о, ч, ь, ы, ъ), после которой ставится скобка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа (см. приложение Б).
Оформление заголовков
2.2.1 Текст документа при необходимости разделяют на разделы и подразделы. Подразделы могут дробиться на пункты, пункты – на подпункты.
2.2.2 Разделы текстового документа начинаются с нового листа. Подразделы являются продолжением текста.
2.2.3 Цифровые обозначения разделов, подразделов, пунктов разделяются точками. В конце цифрового обозначения точка не ставится. Если раздел или подраздел состоит из одного пункта, он тоже нумеруется.
2.2.4 Заголовки разделов и подразделов, а также заголовки текстов общего характера («Введение», «Заключение») следует писать с прописной буквы с красной строки, без точки в конце. Заголовки разделов оформляются шрифтом Times New Roman размером 14 начертание обычное, выравнивание по ширине. Переносы слов в заголовках не допускаются. Если заголовок состоит из двух предложений, их разделяют точкой.
2.2.5 Заголовки текстов не имеющие цифрового обозначения («Содержание», «Замечания», «Список использованных источников» и т.д.), записывают строчными буквами, начиная с прописной. Выравнивание осуществляется по центру без использования красной строки и точки в конце.
2.2.6 Если заголовок раздела или подраздела находится в конце страницы без текста, то он переносится на следующую страницу.
2.2.7 Расстояние между заголовками раздела или подраздела и сплошным текстом – 3 интервала. Расстояние между заголовками раздела и подраздела – 2 интервала.
Изложение формул в пояснительной записке
2.3.1 Все формулы в тексте набираются при помощи встроенного редактора формул, размер шрифта совпадает со шрифтом основного текста, формулы выравниваются по центру.
2.3.2 Все формулы нумеруют арабскими цифрами сквозной нумерацией,за исключением формул приложения. Если в тексте одна формула, то ее обозначают цифрой – (1). Номера формул выравниваются по правому краю. Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например (В.1). Допускается нумерация формул в пределах раздела, например, (3.1),где первая цифра обозначает номер раздела, а вторая – порядковый номер формулы.
2.3.3 Пояснение символов и числовых коэффициентов, входящих в формулу, если они не пояснены раннее в тексте, приводятся непосредственно под формулой. Первая строка пояснения начинается со слова«где» без учета красной строки, без двоеточия после него.
Пример.
Площадь вычисляется по формуле (1):
 |
(1)
где S – площадь искомой фигуры;
f(x) – график верхней линии;
g(x) – график нижней линии;
a и b – границы интервалов интегрирования.
.
2.3.4 Переносить формулы на следующую строку допускается только на знаках выполняемых операций, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак х.
2.3.5 Ссылки в тексте на порядковые номера формул дают в скобках, например, «… расчеты были произведены по формуле (1)».
2.4.1 Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Название следует помещать над таблицей, выравнивание по левому краю таблицы. Название таблицы отделяется от номера пробелами и символом «–», в конце названия точка не ставится.
При переносе части таблицы на ту же или другие страницы название помещают только над первой частью таблицы.
2.4.2 Толщина всех линий в таблице – 1 пт.
2.4.3 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой, например «Таблица 4.1», где первая цифра обозначает номер раздела, вторая цифра – порядковый номер таблицы в данном разделе.
2.4.4 На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «Таблица» с указанием ее номера.
2.4.5 Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф — со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
2.4.6 Текст в шапке таблицы выравнивается по центру (по горизонтали и по вертикали). Перенос слов в заголовках таблиц допускается.
2.4.7 Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
2.4.8 Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа документа.
2.4.9 Если строки или графы таблицы выходят за формат страницы, ее делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют ее головку и боковик. При делении таблицы на части допускается ее головку или боковик заменять соответственно номером граф и строк. При этом нумеруют арабскими цифрами графы и (или) строки первой части таблицы.
Слово «Таблица» указывают один раз слева над первой частью таблицы, над другими частями пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы (см. на примере таблицы 1).
Если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, не проводят.
Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице, при этом повторяют шапку таблицы, и разделяют части таблицы двойной линией.
2.4.10 Графу «Номер по порядку» в таблицу включать не допускается. Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части, а также при переносе части таблицы на следующую страницу.
Таблица 1 – Рейтинг операционных систем
| Тип операционных систем | Имеют операционные системы, % | Считают лучшей, % |
| MS DOS | 62,4 | 18,8 |
| Windows З.х | 52,8 | 14,0 |
Продолжение таблицы 1
| Тип операционных систем | Имеют операционные системы, % | Считают лучшей, % |
| Windows 95 | 45,4 | 23,1 |
| OS/2 | 14,0 | 12,5 |
| NetWare | 10,2 | 6,8 |
| Windows NT | 10,2 | 13,3 |
| Unix | 7,9 | 5,4 |
При необходимости нумерация показателей, параметров или других данных порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед ними. Перед числовыми значениями величин и обозначением типов, марок и т.п. порядковые номера не проставляют.
2.4.11 При наличии в документе небольшого по объему цифрового материала его нецелесообразно оформлять таблицей, а следует давать текстом, располагая цифровые данные в виде колонок.
Пример:
Предельные отклонения размеров профилей всех номеров:
по высоте, % ±2,5
по ширине полки, % ±1,5
по толщине стенки, % ±0,5
по толщине полки, % ±0,5
Оформление иллюстраций
2.5.1 Количество иллюстраций должно быть достаточным для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его. Расстояние между иллюстрацией и сплошным текстом – 3 интервала.
2.5.2 Иллюстрации, за исключением иллюстраций приложений, нумеруют арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается«Рисунок 1». Допускается нумеровать иллюстрации в пределах раздела по типу «Рисунок 3.2», где первая цифра обозначает номер раздела, а вторая – порядковый номер рисунка. Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например – Рисунок С.3.
При ссылках на иллюстрации следует писать «…в соответствии с рисунком 2» при сквозной нумерации и писать «…в соответствии с рисунком 1.2» при нумерации в пределах раздела.
2.5.3 После номера рисунка через тире с прописной буквы указывается его название. Иллюстрация и ее название выравниваются по центру без учета красной строки, без точки в конце названия. Пояснительные данные (если они имеются) помещают перед названием рисунка (см. рисунок 2).
1 Закладки
2 Полоса прокрутки
Рисунок 2 – Настройка панели инструментов
2.5.4 Если в тексте документа имеется иллюстрация, на которой изображены составные части объекта, то на этой иллюстрации должны быть указаны номера позиций этих составных частей в пределах данной иллюстрации, которые располагают в возрастающем порядке, за исключением повторяющихся позиций. (см. рисунок 2).
Оформление приложений
2.6.1 Материал, дополняющий текст документа, допускается помещать в приложениях. Приложениями могут быть,например, графический материал, таблицы большого формата, описание аппаратуры и приборов, расчеты, описания алгоритмов и программ задач, решаемых на ЭВМ, листинг программы с комментариями и т.д.
Приложение оформляют как продолжение данного документа на последующих его листах или выпускают в виде самостоятельного документа.
2.6.2 Приложения могут быть обязательными и информационными. Информационные приложения могут быть рекомендуемого или справочного характера.
2.6.3 В тексте документа должны быть даны ссылки на имеющиеся приложения. Степень обязательности приложений при ссылках не указывается. Приложения располагаются в порядке ссылок на них в тексте документа.
2.6.4 Каждое приложение начинается с новой страницы с указанием слова «Приложение» и его буквенного обозначения с выравниванием по центру, размер 14, шрифт Times New Roman; под ним в скобках пишут слово «обязательное», «информационное» или «справочное».
Приложение должно иметь заголовок (смотри требования к оформлению заголовков).
2.6.5 Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, Й, О, Ч, Ь, Ы, Ъ. Допускается обозначение приложения буквами латинского алфавита, за исключением букв I и 0. Если в документе одно приложение, оно обозначается «Приложение А».
2.6.6 Приложение, как правило, выполняют на листах формата А4. Допускается оформление приложений на форматах А3, А4´3, А4´4, А2 и А1 по ГОСТ 2.301-68.
2.6.7 Приложения имеют общую с остальной частью документа сквозную нумерацию страниц.
2.6.8 Все приложения должны быть перечислены в содержании с указанием их обозначений и заголовков. Номера страниц приложений в содержании указываются.
2.6.9 Приложения, выпускаемые в виде самостоятельного документа, оформляются по общим правилам. При необходимости такое приложение может иметь «Содержание».
Оформление сносок
2.7.1 Если необходимо пояснить отдельные данные, приведенные в документе, то эти данные следует обозначать надстрочными знаками сноски.
Сноски в тексте располагают с абзацного отступа в конце страницы, на которой они обозначены, и отделяют от текста короткой тонкой горизонтальной линией с левой стороны (толщина линии не более 0,5 пт), а к данным, расположенным в таблице над линией, обозначающей окончание таблицы. В электронном документе сноски создаются автоматически.
2.7.2 Знак сноски ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение, и перед текстом пояснения.
2.7.3 Знак сноски выполняют звездочками * и помещают на уровне верхнего индекса. Применять более пяти звездочек не рекомендуется.
Пример – «….программное обеспечение*…»
Нумерация сносок отдельная для каждой страницы.
Оформление шифра
2.8.1 Шифр указывается на обложке и титульном листе. Шрифт и размер шифра колонтитула, кроме титульного листа, совпадают с основным текстом. Все буквенные обозначения в шифре – прописные.
2.8.2 Присвоение обозначений и оформление документации производится согласно следующей схеме:
ДП XХХXX.YYYY ПЗ
Вид работы
Номер учебной группы
Номер ФИО студента по списку в отделе кадров
Тип документа
Виды работ:
— ДП – дипломный проект;
— ДР – дипломная работа;
— КП – курсовой проект;
— КР – курсовая работа;
— ППН – отчет о практике ППН;
— ППС – отчет о практике ППС;
— ПД – отчет о преддипломной практике;
— СТ – отчет о стажировке.
Типы документа:
— ПЗ – пояснительная записка;
— ОС – отчет студента.
Примеры шифров:
— ДП ТМ031.В456 ПЗ;
— ДР П031.А954 ОС;
— КР П041.В432 ОС;
— ППН А051.У567 ОС;
— ППС П051д.К123 ОС;
— ПД П033д.Ш654 ОС;
— СТ А032д.Р538 ОС.
Кроме того, могут применяться следующие обозначения типов документов:
— 12 – листинг программы;
— 33 – руководство программиста;
— 34 – руководство пользователя;
— 51 – программа и методика испытаний.
Данные обозначения добавляются при оформлении соответствующих документов после обозначения основного типа документа. Примеры:
— ДР П031.А954 ОС 12;
— ДР П031.А954 ОС 33;
— ДР П031.А954 ОС 34;
— ДР П031.А954 ОС 51;
— КР П041.В432 ОС 12;
— КР П041.В432 ОС 33;
— КР П041.В432 ОС 34;
— КР П041.В432 ОС 51;
2.8.3 Кроме того шифр указывается на всех листах текстового документа внизу страницы по центру, кроме обложки, титульного листа и листа задания.
2.8.4 Шифр на титульном листе должен совпадать с шифрами, указываемыми на страницах текстового документа.
Оформление содержания
2.9.1 Содержание формируется автоматическим способом. Шрифт Times New Roman, размер 14, начертание обычное. Не использовать заполнитель. Пункты содержания следует указывать без учета красной строки. Подпункты указываются с отступом.
2.9.2 В содержании нумеруются заголовки разделов и подразделов текста и заголовки общего характера, не имеющие цифрового обозначения: «Введение», «Заключение», «Список использованных источников», «Приложение».
2.9.3 В содержании указывается номер страницы приложения.
