Изложение текста документа текстовой части вкр, КП, КР

 

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

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

5.5.2 В тексте не допускается:

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

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

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

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

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

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

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

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

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

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

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

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

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

Примеры:

а) провести испытания пяти труб, каждая длиной 5 м;

б) отобрать 15 труб для испытаний на давление.

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

Примеры:

а) от 1 до 5 мм;

б) от 210 до 100 кг;

в) от плюс 10 до минус 40 °С;

г) от плюс 10 до плюс 40 °С.

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

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

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

Приводя допустимые значения отклонений от указанных норм, требований, следует применять словосочетание «не должно быть более (менее)». Например, массовая доля углекислого натрия в технической кальцинированной соде должна быть не менее 99,4 %.

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

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

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

При невозможности выразить числовое значение в виде десятичной дроби его допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А-4С)/(40В+20).

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

5.6.3 Ссылки в тексте на порядковые номера формул дают в скобках, например, «... проведем расчет по формуле (2.4)».

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

Массовый расход аэрационного вытяжного воздуха определяется по формуле

, (3.6)

 

где 3,6 – коэффициент перевода;

Q_аэр – количество теплоты, удаляемое из помещения при помощи аэрации, Дж;

с = 1004,6 Дж/(кг °С) – массовая удельная теплоемкость воздуха;

t_уд – температура удаляемого (внутреннего) воздуха, °С;

t_пр – температура приточного (наружного) воздуха, °С.

Определим массовый расход по формуле (3.6):

 

кг.

 

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

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

 

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

 

5.7.1 Все иллюстрации (фотографии, схемы, графики, диаграммы, чертежи и т. п.) именуются рисунками.

5.7.2 Рисунки, помещаемые в текстовой части, должны соответствовать требованиям государственных стандартов Единой системы конструкторской документации (ЕСКД). Преимущественно цвет изображений – черный на белом фоне. В оформлении всех рисунков следует придерживаться единообразия. Допускается применение цветного оформления.

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

5.7.4 Рисунки приложения обозначают отдельной нумерацией с добавлением перед цифрой обозначение приложения, например, «Рисунок А.3».

5.7.5 Иллюстрации, могут иметь наименование и, при необходимости, пояснительные данные (подрисуночный текст). Подрисуночный текст располагается под рисунком симметрично относительно текста (по центру) кегль № 12, шрифт – не жирный. Слово «Рисунок» и наименование помещают после пояснительных данных и приводят с абзацевого отступа шрифтом основного текста, начиная с прописной (заглавной) буквы, без точки в конце названия, следующим образом: «Рисунок 1.2 - Детали прибора». При многострочном названии каждая последующая строка названия рисунка начинается под буквенной частью предыдущей строки.

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

5.7.6 Рисунок следует располагать после ссылки на него или как можно ближе к ней. При ссылках на иллюстрации следует писать «… в соответствии с рисунком 2» при сквозной нумерации и «… в соответствии с рисунком 1.2» при нумерации в пределах раздела.

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

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

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

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

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

 

Рисунок 3 - Пример оформления графика, отображающего

качественную зависимость

 

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

Рисунок 4 - Пример оформления графика, отображающего

количественную зависимость

 

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

 

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

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

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

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

5.8.3 На все таблицы тестовой части должны быть приведены ссылки, при этом следует писать слово «таблица» с ее номером. Например, «Расчет средней заработной платы за отчетный период приведен в таблице 6.4».

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

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

 

 

Рисунок 5 - Пример формы таблицы

 

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

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

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

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

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

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

 

Таблица…

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

Номинальный диаметр резьбы болта, винта, шпильки	Внутренний диаметр шайбы	Толщина шайбы
легкой	нормальной	тяжелой
а	b	a	b	a	b
2,0	2,1	0,5	0,8	0,5	0,5	-	-
2,5	2,6	0,6	0,8	0,6	0,6	-	-
3,0	3,1	0,8	1,0	0,8	0,8	1,0	1,2

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

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

Номинальный диаметр резьбы болта, винта, шпильки	Внутренний диаметр шайбы	Толщина шайбы
легкой	нормальной	тяжелой
а	b	a	b	a	b
4,0	4,1	1,0	1,2	1,0	1,2	1,2	1,6
…	…	…	…	…	…	…	…
42,0	42,5	-	-	9,0	9,0	-	-

 

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

 

Рисунок 6 – Пример оформления таблицы с продолжением на

следующем листе

 

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

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

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

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например; D - диаметр; H - высота; L - длина. Показатели с одним и тем же буквенным обозначением группируются последовательно, в порядке возрастания индексов, например, L₁, L₂, L₃ и так далее. Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице, при этом повторяют головку таблицы в соответствии с рисунком 7. Части таблицы рекомендуется разделять двойной линией.

 

 

Таблица 5 – Характеристика резин, используемых для виброизоляторов

кресла оператора

Марка резины	Динамический модуль упругости	Марка резины	Динамический модуль упругости

Рисунок 7 – Пример оформления таблиц с небольшим количеством граф

 

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

 

Таблица 4.6 – Электрические характеристики основных режимов работы

Наименование показателя	Значение
в режиме 1	в режиме 2
1 Ток коллектора, А	5, не менее	7, не менее
2 Напряжение на коллекторе, В	-	-
3 Сопротивление нагрузки коллектора, Ом	-	-

Рисунок 8 – Пример оформления таблицы с указанием порядкового

номера в боковине

Примечания и ссылки

 

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

Примечание -

Примечания

1

2

5.9.2 Ссылки в тексте пояснительной записки на использованные источники дают в скобках, выполненных двумя косыми чертами или квадратными скобками порядковым номером по списку источников. Например, «В расчетах использована методика /15/, «... как указано в монографии [13]», «... в работах /11, 12, 15-17/».

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

5.9.4 Ссылаться следует на документ в целом или на его разделы и приложения. Ссылки на подразделы, пункты, подпункты, таблицы, страницы, формулы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц, приложений и иллюстраций самой ПЗ или ТД, например, «...в соответствии с разделом 5», «...по пункту 3», «…согласно 3.1», «...в соответствии с А.9 (приложение А)», «...в соответствии с 4.1.1…», «…по формуле (3.3)…», «...в таблице В.2 (приложение В)…», «... на рисунке 1.2…».

5.10 Особенности оформления программных документов

5.10.1 Программные документы, разрабатываемые в ВКР, КП, КР, должны оформляться в соответствии с требованиями стандартов Единой системы программной документации (ЕСПД) – комплекса государственных стандартов Российской Федерации, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации. В частности, общие требования к программным документам содержатся в ГОСТ 19.105; требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, установлены в ГОСТ 19.502; виды программ и программных документов – в ГОСТ 19.101–77. Обозначение программ и программных документов и основные надписи – соответственно в ГОСТ 19.103 и ГОСТ 19.104.

5.10.2 ПЗ и ТД оформляются в соответствии с ГОСТ 19.106, ГОСТ 19.404.

5.10.3 Правила выполнения схем алгоритмов, программ, данных и систем содержатся в ГОСТ 19.701. Программные документы должны включать:

– текст программы, оформленный по ГОСТ 19.401;

– описание программы, выполненное по ГОСТ 19.402;

– описание применения, приведенное согласно требованиям ГОСТ 19.502;

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

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

5.10.4 Для ВКР, целиком посвященным проектированию информационно-программных комплексов различного назначения, структура и содержание разделов основной части, связанной с формированием технического задания на разработку программного обеспечения (ПО), описанием ПО и его применения, регламентируется методическими указаниями выпускающей кафедры.

 

5.11 Особенности оформления ВКР, разрабатываемых при