Стандарты по документированию.
Требования к страницам в документе
Страницы текста отчета,иллюстрации и таблицы должны соответствовать формату А4 по ГОСТ 9327.
Текст отчета следует печатать, соблюдая следующие размеры полей: правое - 10 мм, верхнее - 20 мм, левое и нижнее - 20 мм.
Страницы отчета следует нумеровать арабскими цифрами, соблюдая сквозную нумерацию по всему тексту отчета. Номер страницы проставляют в центре нижней части листа без точки. Титульный лист включают в общую нумерацию страниц отчета. Номер страницы на титульном листе не проставляют. Нумерация страниц отчета и приложений, входящих в состав отчета, должна быть сквозная.
Требования к шрифтам.
Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, теоремах, применяя шрифты разной гарнитуры. Цвет шрифта должен быть черным, высота букв, цифр и других знаков - не менее 1,8 мм (кегль не менее 12).
Если в тексте документа приводят диапазон числовых значений физической величины, выраженных в одной и той же единице физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона.
Примеры
1 От 1 до 5 мм.
2 От 10 до 100 кг.
3 От плюс 10 до минус 40°С.
От плюс 10 до плюс 40°С.
Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы), кроме единиц физических величин, помещаемых в таблицах, выполненных машинописным способом.
Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать 1/4 "; 1/2 " (но не ,
).
При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А-4C)/(40В+20).
В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами. Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под формулой. Пояснения каждого символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова "где" без двоеточия после него.
Пример - Плотность каждого образца , кг/м
, вычисляют по формуле
, (1)
где - масса образца, кг;
- объем образца, м
.
Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.
Переносить формулы на следующую строку допускается только на знаках выполняемых операций, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак " ".
В документах, издаваемых нетипографским способом, формулы могут быть выполнены машинописным, машинным способами или чертежным шрифтом высотой не менее 2,5 мм. Применение машинописных и рукописных символов в одной формуле не допускается.
Требования к оформлению абзацев.
Текст документа при необходимости разделяют на разделы и подразделы.
При большом объеме документа допускается разделять его на части, а части, в случае необходимости, на книги. Каждую часть и книгу комплектуют отдельно. Всем частям дают наименования и присваивают обозначение документа.
Разделы должны иметь порядковые номера в пределах всего документа (часть, книги), обозначенные арабскими цифрами без точки и записанные с абзацевого отступа. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела точки не ставится. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов.
Если документ не имеет подразделов, то нумерация пунктов в нем должна быть в пределах каждого раздела, и номер пункта должен состоять из номеров раздела и пункта, разделенных точкой. В конце номера пункта точка не ставится, например:
Если раздел или подраздел состоит из одного пункта, он также нумеруется.
Если текст документа подразделяется только на пункты, они нумеруются порядковыми номерами в пределах документа.
Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1, 4.2.1.2, 4.2.1.3 и т.д.
Внутри пунктов или подпунктов могут быть приведены перечисления.
Перед каждой позицией перечисления следует ставить дефис или при необходимости ссылки в тексте документа на одно из перечислений, строчную букву русского или латинского алфавитов, после которой ставится скобка. Для дальнейшей, детализации перечислений необходимо использовать арабские цифры, после которых, ставится скобка, а запись производится с абзацного отступа, как показано в примере.
Пример
а) ____________________
б) ____________________
1) ________________
2) ________________
в) ____________________
Каждый пункт, подпункт и перечисление записывают с абзацного отступа.