Изложение текста документа
Текст документа должен быть кратким, четким и не допускать различных толкований.
Оформление документа должно быть выдержано в одном стиле. Чрезмерное увлечение различными шрифтами ухудшает наглядность документа и делает его менее удобным для чтения. Выделение единых по смыслу и логическому назначению элементов в рамках одного документа всегда следует обозначать одинаково. Основной текст документа должен содержать один шрифт.
При изложении обязательных требований в тексте должны применяться слова «должен», «следует», «необходимо» и производные от них. При изложении других положений следует применять слова — «могут быть», «как правило», «при необходимости», «может быть», «в случае» и т.д. При этом допускается использовать повествовательную форму изложения текста, например, «применяют», «указывают» и т.п.
В документах должны применяться установленные соответствующими нормативными документами, стандартами, а при их отсутствии - общепринятые термины, обозначения и определения.
Если в документе принята специфическая терминология, то в конце его (перед списком литературы) должен быть приведен перечень принятых терминов с соответствующими разъяснениями. Перечень включают в содержание документа.
В тексте документа не допускается:
- применять обороты разговорной речи, техницизмы, профессионализмы;
- применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;
- применять произвольные словообразования;
- сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц и в расшифровках буквенных обозначений, входящих в формулы и рисунки;
- применять сокращения слов, кроме установленных правилами русской орфографии, пунктуации, а также соответствующими государственными стандартами.
В тексте документа, за исключением формул, таблиц и рисунков, не допускается:
- применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово «минус»);
- применять математические знаки без цифр, например < (меньше), > (больше), ^ (не равно), ³ (больше или равно), а также знаки № (номер), % (процент);
- применять индексы стандартов (ГОСТ и т.п.) без регистрационного номера.
Примеры
| Правильно |
| При инфляции равной 18 % |
| 5, 6и7 |
| 50, 60 и 70 % |
| № 2, 4, 5 |
| Приложение А, вариант 1 раздел 1 |
Если в документе приводятся поясняющие надписи, наносимые непосредственно на изготавливаемое изделие (например, на планки, таблички к элементам управления к т.п.), то их выделяют шрифтом (без кавычек), например, ВКЛ., ОТКЛ., или кавычками - если надпись состоит из цифр и (или) знаков.
Наименование команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например, «Сигнал + 27 включено».
Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень принятых сокращений, который помещают в конце документа перед перечнем терминов.
Условные буквенные обозначения, изображения и знаки должны соответствовать принятым в действующем законодательстве и государственных стандартах. В тексте документа перед обозначением параметра дают его пояснение, например: «...если запасы и затраты 3 меньше суммы плановых источников их формирования Ипл...».
При необходимости применения условных обозначений, изображений или знаков, не установленных действующими стандартами, их следует пояснять в тексте или в перечне обозначений.
В документе следует применять стандартизированные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417. наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физических величин не допускается.
Числовые значения величин в тексте должны указываться со степенью точности, которая необходима для обеспечения требуемых свойств, при этом в ряду величин осуществляется выравнивание числа знаков после запятой.
Округление числовых значений величин до первого, второго, третьего и т.д. десятичного знака для различных типоразмеров, марок и т.п. изделий одного наименования должно быть одинаковым. Округление величин, выраженных в денежном измерителе, рекомендуется до второго десятичного знака.
Дробные числа приводят в виде десятичных дробей, за исключением размеров в дюймах, которые записывают по типу ½², ¼².
При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, делая пробел между символами и знаками арифметических действий, например, 5 / 32; (50А - 4С) / (40В + 20).
В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти - словами.
Примеры
1 Провести испытания пяти труб, каждая длиной 5 м.
2 Отобрать 15 труб для испытаний на давление.
3 Зазор - не более 2 мм.
4 Катушку пропитать два раза.
Единица физической величины одного и того же параметра в пределах одного документа должна быть постоянной. Если в тексте документа приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например: 1,50; 1,75; 2,00 м.
Если в тексте документа приводят диапазон числовых значений физической величины, выраженных в одной и той же единице физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона. Интервалы значений величин в тексте записывают со словами «от» и «до».
Например: «...толщина слоя должна быть от 0,5 до 2 мм», - или через тире, например: «таблицы 10 - 15», «пп.7 - 12». Пределы размеров указывают от меньших к большим. Примеры
1 От 1 до 5 мм.
2 От 10 до 100 кг.
3 От плюс 10 до минус 40 °С.
Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы), кроме единиц физических величин, помещаемых в таблицах, выполненных машинописным способом.
Приводя наибольшие или наименьшие значения величин, следует применять словосочетание «должно быть не более (не менее)».
Приводя допустимые значения отклонений от указанных норм, требований следует применять словосочетание «не должно быть более (менее)».
Например, массовая доля углекислого натрия в технической кальцинированной соде должна быть не менее 99,4 %.
В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами. Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под формулой. Пояснения каждого символа дают с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка расшифровки должна начинаться со слова «где» без двоеточия после него.
Все формулы, за исключением формул, помещенных в приложении, нумеруют арабскими цифрами. Одну формулу обозначают - (1).
Допускается нумерация формул в пределах раздела. Номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой. Номер указывают с правой стороны листа на уровне формулы в круглых скобках, например:
Факторами первого уровня являются изменение суммы использования материальных ресурсов и эффективности их использования ВП:
ВП = МЗ · МО, (2.1)
где МЗ - затраты материальных ресурсов на производство продукции; МО - материалоотдача.
Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.
Страница не может начинаться с формулы, ей должна предшествовать хотя бы одна строка текста.
Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (В. 1).
Ссылки в тексте на номер формулы дают в скобках, например: «В формуле (3.1), из уравнения (8.2) находим ...».
В формулах символы следует писать единообразно по всему тексту буквами только латинского или только русского алфавита.
Основным знаком умножения является точка на средней линии. Знак умножения в виде косого креста допускается применять между числовыми сомножителями при переносе формулы с одной строки на другую на знаке умножения.
Порядок изложения в документе математических уравнений такой же, как и формул.
В примечаниях к тексту и таблицам указывают только справочные или поясняющие данные.
Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания, и печатать с прописной буквы с абзаца. Если имеется одно примечание, то его не нумеруют и после слова «Примечание» ставят тире и примечание печатается тоже с прописной буквы.
Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы.
Примеры
Примечание - После слова «Примечание» двоеточие не ставится.
Примечания
1 Примечания приводят в документах, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала.
2 Примечания не должны содержать требований.
В тестовых документах допускаются ссылки на нормативные документы, стандарты, технические условия и др. Ссылаться следует на документ в целом или на его разделы и приложения.
При ссылках на стандарты и технические условия указывают наименование документа. При ссылке на раздел или приложение указывают его номер и наименование, при повторных ссылках - только номер.
Ссылки на темы, разделы, пункты указывают порядковым номером темы или номером и заголовком, например, «... в п. 3.2». Примеры
1 ... как об этом говорилось в разделе 18.
2 ... как указывалось в части 2, статье 6.
3 ... об этом было сказано при анализе общей функции (глава 3, подраздел 1).
4 ...более подробно можно прочитать в книге Э.А. Уткина «Банковский маркетинг». С. 102-119.
5 Э.А. Уткин в книге «Банковский маркетинг» ( М.: ИНФРА-М, 1994. С. 55) указал...
6 Основные средства организации и автоматизации описал В.Ф. Ламекин (Ламекин В.Ф. Оргтехника. Ростов н/Д: Феникс, 1997).
Ссылку в тексте заключают в квадратные скобки, если указывают порядковый номер источника в списке использованной литературы. Первое число обозначает номер источника в общем списке, второй - страницу, с которой заимствован материал. Числа разделяют запятой, например, [5, 37].
Ссылка может быть оформлена в виде подстрочной сноски.
Ссылки обязательны при использовании в тексте цитат, числовых данных, формул и т.д., заимствованных у других авторов.