STO_0.5.03 (Документация учебная) стандарт. Стандарт организации

• Название: Стандарт организации
• Дата: 05.03.2023
• Размер: 3.74 Mb.
• Имя файла: STO_0.5.03 (Документация учебная) стандарт.docx
• Тип: Документы; #969854
• страница: 3 из 16

4 Оформление текстовой части документов

4.1 Требования к тексту документа

4.1.1 Текст пояснительной записки при необходимости разделяют на разделы и подразделы. Содержание разделов определяется методическими указаниями.

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

Пример.

1 Устройство буксовых узлов нового поколения - раздел

1.1 Технические требования к колесным парам с подшипником - подраздел

1.1.1 Устройство буксового узла нового поколения - пункт

1.1.1.1 Устройство типового буксового узла - подпункт

1.2 Требования к эксплуатации

1.2.1 Подготовка изделия к зимнему периоду

1.3 Техническое обслуживание подшипника
4.1.3 Внутри пунктов или подпунктов могут быть приведены перечисления. Перед каждой позицией перечисления следует ставить дефис.

Пример.

После ремонтных работ должны быть параметры:

• 
  посадочный диаметр – 165,0 мм;
  
• 
  овальность посадочного диаметра – 0,1 мм;
  
• 
  конусность посадочной поверхности – 0,05 мм.
  

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

Пример.

Производственные участки плановых видов ремонта:

а) подготовительно - разборочный;

б) вагоносборочный;

в) обслуживающие устройства (на территории депо), в том числе:

1) ремонтно – слесарно – механический;

2) вагоносборочный;

г) деревообрабатывающий.

4.1.4 Если раздел или подраздел состоят из одного пункта, он тоже нумеруется.

4.1.5 Каждый раздел текстового документа рекомендуется начинать с но­вого листа (страницы).

4.2 Построение и изложение документа

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

В последующем тексте допускается употреблять сокращенное наименова­ние проекта.

Наименования, приводимые в тексте документа и на иллюстрациях, долж­ны быть одинаковыми.

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

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

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

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

При этом допускается использовать повествовательную форму изложения текста, например «применяют», «указывают» и т.д.

В документах должны применяться научно-технические термины, обозна­чения и определения, установленные соответствующими стандартами, а при их отсутствии — общепринятые в научно-технической литературе.

3. 
   В тексте документа не допускается:
   

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

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

• 
  применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово «минус»);
  
• 
  применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак «Ø»;
  
• 
  применять без числовых значений математические знаки, например, > (больше), < (меньше), = (равно), (больше или равно), (меньше или равно), (не равно), а также знаки № (номер), % (процент);
  
• 
  применять индексы стандартов и других документов без регистрационного номера.
  

4.2.5 Если в документе приводятся поясняющие надписи, наносимые непосредственно на изготовляемое изделие (например на планки, таблички к элементам управления и т.п.), их выделяют шрифтом (без кавычек), например ВКЛ., ОТКЛ., или кавычками – если надпись состоит из цифр и (или) знаков.

Наименование команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например «Сигнал + 27 включено».

4.2.6 Перечень допускаемых сокращений слов для основных надписей, технических требований, таблиц, чертежей и спецификации установлен ГОСТ 2.316 и для слов, применяемых на железнодорожном транспорте (Приложение Т).

4.2.7 В документе следует применять стандартизованные единицы физиче­ских величин, их наименования и обозначения в соответствии с ГОСТ 8.417 (Приложение П).

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

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

Примеры.

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

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

При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32;

(50 А–4С)/(40В+20).

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

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

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

Примеры.

1 От 1 до 5 мм.

2 От 10 до 100 кг.

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

3. 
   От плюс 10 до плюс 40° С.
   

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

Если числа представляют порядковые номера, то они записываются через дефис.

Пример.

Рисунок 1-14

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

При указании числовых значений в процентах следует писать:

«…от 63 % до 67 %» (а не 65±2 %).

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

Все формулы выполняются средствами встроенного редактора формул MS Word.

Пример 1

Сила электрического тока I, А, вычисляется по формуле





где U – напряжение на участке цепи, В;

R – сопротивление участки цепи, Ом.



Пример 2

Активная проводимость первой ветви _, Cм, вычисляется по формуле


где – сила электрического тока в активной ветви, А;

– величина угла;

U – напряжение на активной ветви, В.



Пример 3

Технологическое время на расформирование , мин, вычисляется по формуле



где T_з – технологическое время заезда маневрового локомотива в парк приема к составу, мин;

T_над – технологическое время надвига состава на сортировочную горку, мин;

T_рос– технологическое время роспуска состава с сортировочной горки, мин;

T_ос – технологическое время на осаживание состава на сортировочных путях, мин;

T_оф– технологическое время на окончание формирования состава с сортировочной горка, мин.

2,7+0,68+0,15+2,02+3,72 ≈ 9 мин

Формулы, следующие одна за другой и не разделенные текстом, отделяют запятой.

Пример.




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

4.2.13 Формулы должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках. Одну формулу обозначают - (1). Допускается нумерация формул в пределах разделов, в этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (4.1).

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

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

4.2.14 Порядок изложения в документах математических уравнений такой же, как и формул.

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

Примечания не должны содержать требований.

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

Примеры.

П р и м е ч а н и е - _____________________________________________________________

____________________________________________________________________________________
П и м е ч а н и я

1 ____________________________

2 ____________________________