Изложение текста текстового документа (ПЗ)

 

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

Расстояние между строками рукописного документа – 8 мм, текстового документа, выполняемого машинописным способом – двойной интервал пишущей машинки, при наборе в редакторе WORD - полуторный интервал редактора 1,42).

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

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

 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примеры

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

2 Отобрать пятнадцать труб для испытания на давление.

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

Примеры

1 От 1 до 5 мм.

2 От 210 до 100 кг.

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

4 От плюс 10 до плюс 40 ⁰С.

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

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

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

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

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

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

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

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

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

 

Описание формул

 

3.6.1 Формулы записываются шрифтом высотой не менее 2,5 мм на отдельной строке текста симметрично ему. Применение машинописных, машинных и рукописных символов в одной формуле не допускается.

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

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

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

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

Пример - Плотность каждого образца r, (кг/м³), вычисляют по формуле (1.1)

r = m/V, (1.1)

где m - масса образца, кг;

V - объем образца, м³.

 

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

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

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

 

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

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

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

Иллюстрации ПЗ специальностей «Т5ехника и технология» должны быть выполнены в соотвествии с требованиями стандартов ЕСКД и СПДС.

3.7.2 Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование помещают после пояснительных данных и приводят с абзацевого отступа следующим образом: Рисунок 1.2 - Детали прибора.

3.7.3 Рисунок следует располагать после ссылки на него или как можно ближе к ней.

При ссылках на иллюстрации следует писать "… в соответствии с рисунком 2" при сквозной нумерации и "… в соответствии с рисунком 1.2" при нумерации в пределах раздела.

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

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

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

Указанные данные наносят на иллюстрациях согласно ГОСТ 2.109.

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

 

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

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

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

Номер таблицы и ее название располагают на одной строке над таблицей с абзацевого отступа, причем слово "Таблица" пишется слева, например - "Таблица 4.1 - Подсчет объемов работ". В конце названия точка не ставится.

3.8.3 На все таблицы ПЗ должны быть приведены ссылки, при этом следует писать слово "таблица" с ее номером.

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

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

Высота строк под головкой в таблице должна быть не менее 8 мм.

Графу "№ п.п." в таблицу включать не следует, форма таблицы приведена на рисунке 3.

 

 

Таблица -

номер название таблицы

 

Голов- Заголовки граф

ка

Подзаголовки

граф

 

Строки

(горизонталь-

ные ряды)

 

 

Боковик Графы (колонки)

(графа для

заголовков)

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

 

 

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

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

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

 

Таблица…

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

Номинальный диа-метр резьбы болта, винта, шпильки	Внутренний диаметр шайбы	Толщина шайбы
легкой	нормальной	тяжелой
а	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	-	-

 

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

 

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

 

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

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

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

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

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

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

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

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

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например; D - диаметр; H - высота; L - длина.

Показатели с одним и тем же буквенным обозначением группируются последовательно, в порядке возрастания индексов, например: L₁, L₂, L₃ и так далее.

 

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

 

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

 

Примеры

Примечание -

Примечания

1

2

3.9.2 Ссылки в тексте пояснительной записки на использованные источники дают в скобках, выполненных двумя косыми чертами, порядковым номером по списку источников. Например: "В расчетах использована методика /15/".

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

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

 

 

3.10 Правила оформления программных документов

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

Программные документы должны включать:

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

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

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

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

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

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