21. Общие требования к выполнению текстовых документов

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

1) титульный лист;

2) содержание;

3) техническое задания на проектирование;

4) анализ технического задания ;

5) анализ схемы электрической принципиальной и описание принципа работы узла;

6) выбор элементной базы узла. Основные габаритные размеры, цоколевка, варианты установки и разметки выбранной элементной базы;

7) обоснование типа печатной платы, класса точности, метода изготовления и материала печатной платы;

8) определение размеров печатной платы, диаметров монтажных и крепежных отверстий, контактных площадок;

9) варианты компоновки узла;

10) проверочные расчеты;

11) заключение;

12) список используемой литературы;

13) приложения (перечень элементов, спецификация, эскизы и т.д.)

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

Рассмотрим основные положения данного стандарта.

Расположение текста и его выполнение. Записка выполняется на листах форматов А4, заполняемых с одной или двух сторон. Расстояние от рамки до границ текста в начале и в конце строк должно быть не менее 3 мм, вверху и внизу – не менее 10 мм. Абзацный отступ равен пяти пробелам (15 – 17 мм).

Исправления в документ вносятся путем подчистки неточности или закрашиванием белой краской с последующим нанесением на том же месте исправленного текста.

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

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

Заголовки должны четко и кратко отражать содержание нижеследующего текста.

Расстояние между заголовком и текстом – 15 мм, между заголовками раздела и подраздела – 8 мм (при рукописном исполнении)

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

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

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

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

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

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

• использовать личные местоимения (например, вместо «… я разработал 3 варианта» следует записать: Было разработано 3 варианта);

• применять произвольные сокращения слов (типа т.о., м.б.). Допускается использовать сокращения, общепринятые в русском языке (и т.д., и т.п., др.) и в ГОСТ 2.316-68 в оговоренных в данном стандарте случаях (т.е. в основных надписях, технических требованиях, спецификациях);

• сокращать обозначения единиц физических величин, если они употребляются без цифр (кроме случаев использования их в таблицах и формулах);

• применять без числовых значений математические знаки ( ,  , =,  ,  ,  ), а также знаки №, %,  ;

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

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

Округление числовых значений величин для различных типоразмеров, марок и т.п. изделий одного наименование должно быть одинаковым. Например, толщина печатной платы выбирается из ряда 0,8; 1,0; 0,5; 2,0 мм. Размерность указывается в конце перечисления. Дробные числа должны приводиться в виде десятичных дробей (кроме размеров в дюймах).

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

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

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

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

Пример. Диаметры монтажных отверстий вычисляются по формуле:

d_o = d_в +d_но + r , (1)

где d_в – диаметр вывода элемента;

d_но – нижнее предельное отклонение диаметра отверстия;

r – гарантированный монтажный зазор.

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

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

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

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

Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «рисунок» и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 – Детали прибора. Пример оформления иллюстрации представлен на рисунке 5.2

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

Приложения обозначают заглавными буквами русского алфавита, начиная с буквы А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ.

1

2 1 - рабочий слой; 2 – основа

Рисунок 9.2 – Строение магнитной ленты

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

Нумерация формул, рисунков, таблиц, приводимых в приложениях должна выполняться с обозначением приложения, например, рисунок В.5; Таблица А.7.1 (текст приложения может разбиваться на разделы, подразделы, пункты, подпункты).

Приложения, выпускаемые в виде самостоятельного документа, оформляют по общим правилам – первый лист с основной надписью по форме 2, последующие листы – по форме 2а по ГОСТ 2.104 .

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

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

На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.

Таблица 1 – Эксплуатационные параметры элементов

Марка элемента	Диапазон вибраций, Гц	Т, о С
		нижняя	верхняя
С2-23	1 - 5000	-60	155
Д 814	10 - 600	-55	100
КТ815	10 - 600	-40	100
К142	1 - 600	-45	80

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

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

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

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

8 мм.

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

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

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

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

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

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

Таблица ХХ – Маркировочные композиции и их применение

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

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