Техническая документация

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

Термины и определения должны быть едиными и соответствовать установленным стандартами, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов [из п. 2.2.1 ГОСТ 19.106-78]

Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений [из п. 2.2.2 ГОСТ 19.106-78]

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

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

ТО=устройство=список - указывает носители данных, на которые осуществляется...

АВС3091 СИНТАКСИЧЕСКАЯ ОШИБКА

ПРИЧИНА. Указанный в сообщении...

ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется...

ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить...

Необходимые пояснения к тексту документа могут оформляться сносками.

Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство²⁾...» или «бумага⁵⁾...».

Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведенной в левой части страницы [из п. 2.2.4 ГОСТ 19.106-78]

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

Вновь разработанные документы рекомендуется записывать в разделах, подразделах ведомости в порядке возрастания:

• классификационной характеристики в обозначении;
• порядкового регистрационного номера в одной классификационной характеристике;
• номеров частей документов.

Заимствованные документы рекомендуется записывать в ведомости в конце каждого раздела, подраздела [из п. 3.1 ГОСТ 24.301-80]

Требования к построению и другие общие требования к заполнению граф должны соответствовать разд. 3 ГОСТ 2.105 [из п. 3.2 ГОСТ 24.301-80]

Ведомость технического проекта, ведомость рабочей документации, ведомость проекта выполняют в соответствии с разд. 4 ГОСТ 2.106 [из п. 3.3 ГОСТ 24.301-80]

Опись составляют при необходимости брошюрования документов в книгу, альбом, папку. Опись является первым документом книги, альбома, папки. Опись эксплуатационных документов выполняют в соответствии с разд. 3 ГОСТ 2.601. Прочие описи выполняют в соответствии с разд. 2 ГОСТ 2.105 [из п. 3.4 ГОСТ 24.301-80]

Изложение текста документа должно соответствовать требованиям разд. 2 ГОСТ 2.105 [из п. 2.2.1 ГОСТ 24.301-80]

Переносить части заголовка или части обозначения на другую строку не допускается.

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

Формулы следует нумеровать только при наличии ссылок на них.

Специальные знаки, формулы, буквы редко применяемых алфавитов допускается записывать от руки чернилами или тушью черного цвета [из п. 2.2.2 ГОСТ 24.301-80]

Знаки N, §, %, +, - и т.д. следует применять только при числовых значениях. В тексте эти знаки следует писать словами [из п. 2.2.3 ГОСТ 24.301-80]

Римские цифры следует употреблять только для обозначения сорта (категории) изделия, кварталов года, полугодия. В остальных случаях применяют арабские цифры [из п. 2.2.4 ГОСТ 24.301-80]

Цифровые обозначения дат и количественных числительных не должны иметь падежных окончаний. Если в документах приведен самостоятельный перечень символов и числовых коэффициентов, включенных в формулы, значения их под каждой формулой не приводят [из п. 2.2.5 ГОСТ 24.301-80]

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

Наименования единиц счета и измерений физических величин, употребляемые в тексте без числовых значений, следует записывать без сокращений (например: длина приведена в миллиметрах) [из п. 2.2.6 ГОСТ 24.301-80]

Пояснения к основному тексту, таблицам допускается оформлять сносками. Правила оформления сносок к таблицам - по ГОСТ 1.5.

Сноски к тексту обозначают подстрочными знаками звездочкой или цифрой со скобкой, например: комплекс^*, машина². В одном документе следует применять единую систему обозначения сносок. Если сноска относится к отдельному слову, знак сноски помещают непосредственно у этого слова, если к предложению, то в конце предложения. Текст сноски располагают в конце листа и отделяют от текста линией длиной 30 ... 40 мм, проведенной в левой части листа. Текст сноски выполняют машинописным способом через один интервал [из п. 2.2.7 ГОСТ 24.301-80]

Примечания к тексту, таблице, графическому материалу выполняют по ГОСТ 1.5.

Примечания к таблицам, расположенным вдоль длинной стороны формата, помещают вдоль длинной стороны. В случае, если текст примечания переносится на следующий лист, то его допускается выполнять вдоль короткой стороны. Текст примечаний выполняют машинописным способом через один интервал [из п. 2.2.8 ГОСТ 24.301-80]

Текст реферата не должен содержать интерпретацию содержания документа, критические замечания и точку зрения автора реферата (кроме положений, указанных в 5.1.7), а также информацию, которой нет в исходном документе [из п. 5.2.1 ГОСТ 7.9-95]

Текст реферата должен отличаться лаконичностью, четкостью, убедительностью формулировок, отсутствием второстепенной информации [из п. 5.2.2 ГОСТ 7.9-95]

Текст реферата начинают фразой, в которой сформулирована главная тема документа. Сведения, содержащиеся в заглавии и библиографическом описании, не должны повторяться в тексте реферата. Следует избегать лишних вводных фраз (например, «автор статьи рассматривает...»). Исторические справки, если они не составляют основное содержание документа, описание ранее опубликованных работ и общеизвестные положения, в реферате не приводятся [из п. 5.2.3 ГОСТ 7.9-95]

В тексте реферата следует употреблять синтаксические конструкции, свойственные языку научных и технических документов, избегать сложных грамматических конструкций [из п. 5.2.4 ГОСТ 7.9-95]

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

Следует избегать употребления малораспространенных терминов или разъяснять их при первом упоминании в тексте.

Необходимо соблюдать единство терминологии в пределах реферата [из п. 5.2.5 ГОСТ 7.9-95]

В тексте реферата следует применять значимые слова из текста исходного документа для обеспечения автоматизированного поиска [из п. 5.2.6 ГОСТ 7.9-95]

Сокращения и условные обозначения, кроме общеупотребительных в научных и технических текстах, применяют в исключительных случаях или дают их определения при первом употреблении [из п. 5.2.7 ГОСТ 7.9-95]

Единицы физических величин следует приводить в международной системе СИ по ГОСТ 8.417. Допускается приводить в круглых скобках рядом с величиной в системе СИ значение величины в системе единиц, использованной в исходном документе [из п. 5.2.8 ГОСТ 7.9-95]

Имена собственные (фамилии, наименования организаций, изделий и др.) приводят на языке первоисточника. Допускается транскрипция (транслитерация) собственных имен или перевод их на язык реферата с добавлением в скобках при первом упоминании собственного имени в оригинальном написании [из п. 5.2.9 ГОСТ 7.9-95]

Географические названия следует приводить в соответствии с последним изданием «Атласа мира». При отсутствии данного географического названия в «Атласе мира» его приводят в той же форме, что и в исходном документе [из п. 5.2.10 ГОСТ 7.9-95]

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

Формулы, приводимые неоднократно, могут иметь порядковую нумерацию, причем нумерация формул в реферате может не совпадать с нумерацией формул в оригинале [из п. 5.2.11 ГОСТ 7.9-95]

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

Рекомендуемый средний объем текста реферата 850 печатных знаков.

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

В экспресс-информации допускается публикация расширенных рефератов в соответствии с ГОСТ 7.23 [из п. 5.2.12 ГОСТ 7.9-95]