1. Основные элементы текстового документа

   1. Общие положения

Документ должен быть выполнен на листах формата А4 с одной стороны, одним из следующих способов:

1. с использованием компьютера:

   1. шрифт Times New Roman, межстрочный интервал одинарный, шрифт 14, допускается использовать 12 размер шрифта.

2. рукописным:

   1. чертежным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм. Цифры и буквы необходимо писать четко черной тушью.

Текст документа следует выполнять, соблюдая размеры полей:

3. правое – от 10 до 15 мм;

4. левое – от 25 до 30 мм;

5. нижнее и верхнее – от 20 до 25 мм.

Абзацный отступ по тексту должен быть равным от 15 до 17 мм.

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

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

Документ должен быть сшит (переплетен) и иметь обложку.

В тематическом реферате (ТР), лабораторной работе (ЛР), курсовой работе (КР), курсовом проекте (КП) обложку рекомендуется выполнять из плотной бумаги, совмещая ее с титульным листом.

Если документ выполнен с использованием ПЭВМ, то обязательно включать к бумажной копии документа ее электронный вариант.

2. Основной текст

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

В зависимости от объема и сложности материала пояснительной записки число рубрик может быть разное, но обычно ограничиваются тремя рубриками – разделами, подразделами и пунктами. Более мелкое дробление, как правило, не практикуется.

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

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

В пояснительной записке должно быть соблюдено единство терминологии. Не следует применять устаревшие термины (даже если они встречаются в литературе), а нужно использовать лишь те, которые установлены современными стандартами и другими нормативно-техническими документами. Например, нельзя вместо термина «продолжительный режим» использовать «длительный режим», вместо «демпферный контур» – «успокоительный контур» и т.д. Обозначения серий или типов электрических машин, электрических аппаратов и другого электрооборудования должны строго соответствовать обозначениям серий и типов, установленным заводами-изготовителями и указанным в соответствующих технических условиях или каталогах.

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

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

В пояснительной записке недопустимы выражения типа: «Далее рассмотрим…». Не следует писать об элементарных вещах, которые обязательно должны быть выполнены и не требуют пояснений (например, о построении простейших графиков нагрузок). Все слова пояснительной записки должны быть написаны полностью без сокращений. Недопустимы произвольные сокращения слов, например, «тр-р» вместо «трансформатор», «п/ст» или «п-ст» вместо «подстанция». Сокращают лишь названия организаций и учреждений, а также термины, как принято в технической литературе: КПД, ЭДС, КЗ, ВНИИЭ и т.д. Обязательно сокращение следующих поясняющих слов и выражений: то есть – т.е.; и так далее – и т.д.; и тому подобное – и т.п.; и другие – и др.; и прочие – и пр.; смотри – см. Выражения «и другие», «и тому подобные», «и прочие» не сокращаются, если они находятся внутри предложения.

Сокращению подлежат часто употребляемые в пояснительной записке названия нормативно-технических документов или характерных технических терминов. С этой целью при первом упоминании названия какого-либо нормативно-технического документа или технического термина, состоящего из нескольких слов, его пишут полностью, не пропуская ни одного слова, а затем в круглых скобках указывают соответствующее сокращенное обозначение. В качестве последнего обычно используют аббревиатуру в виде записанных слитно прописных (заглавных) букв, являющихся начальными буквами разных слов названий или терминов, например: правила устройства электроустановок (ПУЭ); открытое распределительное устройство (ОРУ).

Не допускается сокращение таких слов и словосочетаний как «так называемый», «так как», «например», «около», «уравнение», «формула».

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

В пояснительной записке должны использоваться общепринятые математические символы и обозначения различных величин, а при наличии соответствующих стандартизованных обозначений применять только их. При этом следует иметь в виду, что все буквы латинского алфавита в обозначениях физических величин печатают с наклоном, а русские и греческие буквы – без наклона. Без наклона букв печатают знаки тригонометрических функций, логарифмов и т.д., например: U_ном, ΔP, cos (ωt+α), dΨ/dt.

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

При отсутствии нужных индексов в стандартах или рекомендациях допускается их самостоятельная разработка. Такой индекс должен быть кратким. Если предлагаемый индекс состоит из нескольких русских слов, то записываются только одна или две первых буквы соответствующего слова и после каждой буквы или двух букв, замыкающих слово, ставят точку (или оставляют пробел). Точка после русской буквы не требуется в нескольких случаях: если после нее следует буква латинского или греческого алфавита; если вместо следующей буквы используется ноль; если русская буква является последней в индексе, например: I_{ТЕР.НОРМ}, I_П0, I_Пτ, i_КД.

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

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

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

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

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

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

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

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

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

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

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

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

3. применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно),  (больше или равно),  (меньше или равно),  (не равно), а также знаки № (номер), % (процент);

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

Стиль написания символов должен быть одинаковым по всему документу (например, кавычки). Нежелательно использование в тексте буквы «ё».

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

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

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

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

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

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

Однозначные числа (состоящие из одного разряда, например 5, 9), не имеющие после себя единиц физических величин и используемые в косвенных падежах, рекомендуется писать в буквенной, а не в цифровой форме, например: одного, двух и т.д. Крупные круглые числа – тысяча, миллион, миллиард и т.д. – рекомендуется писать в буквенно-цифровой форме, т.е. в виде сочетания цифр с сокращенными обозначениями без точек, например: тысяч (тыс), миллионов (млн) и т.д., т.е.: 28 тыс; 30 млн и т.д.

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

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

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

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

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

11. от 1 до 5 мм;

12. от 10 до 100 кг;

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

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

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

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

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

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

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

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