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

ОБЩИЕ ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ТЕКСТОВЫХ ДОКУМЕНТОВ

Киров 2004

1 РАЗРАБОТАН и ВНЕСЕН секцией курсового и дипломного проектирования методического совета Вятского государственного университета

2 ПРИНЯТ методическим советом Вятского государственного университета «06» февраля 2004 года, протокол № 2.

3 Приказом ректора Вятского государственного университета

от «17» марта 2004 года № 56 введен в действие в качестве стандарта университета с «01» апреля 2004 года взамен СТП ВятГТУ 101-2000.

Редактор Е.Г. Козвонина

ЛР № 020519 от 20.06.97 г.

Подписано в печать ___.__.2004 г. Усл. печ. л. 1, 5

Бумага книжно-журнальная. Печать матричная.

Заказ № __ Тираж 200 Бесплатно.

610000, г. Киров, ул. Московская, 36.

Оформление обложки, изготовление – ПРИП

Ó Вятский государственный университет, 2004

Права на данное издание принадлежат

Вятскому государственному университету

СТАНДАРТ ВЯТСКОГО ГОСУДАРСТВЕННОГО УНИВЕРСИТЕТА

ОБЩИЕ ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ТЕКСТОВЫХ ДОКУМЕНТОВ

Дата введения 01-01-2004

1 Область применения

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

2 Общие положения

2.1 Подлинники текстовых документов выполняются в соответствии с ГОСТ 2.105-95 одним из следующих способов:

- рукописным — с высотой букв и цифр не менее 2, 0 мм. Цифры и буквы пишутся разборчиво черными или темно-синими чернилами или пастой;

- машинописным с учетом требований ГОСТ 13.1.002. Шрифт пишущей машинки должен быть четким, высотой не менее 2, 0 мм;

- с применением печатающих и графических устройств компьютерного вывода высотой не менее 2, 0 мм (ГОСТ 2.004), (в текстовом редакторе Word размер шрифта не менее 12 для текстовых документов, выполняемых студентами, а для методических указаний, учебных пособий, тезисов докладов, курсов лекций рекомендуется 14);

- на магнитных носителях данных (ГОСТ 28388).

2.2 Копии текстовых документов выполняются одним из способов:

- типографским — в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом;

- ксерокопированием — при этом рекомендуется размножать документы способом двустороннего копирования;

- светокопированием;

- микрофильмированием;

- на магнитных носителях данных.

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

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

Повреждения листов текстовых документов, помарки и следы не полностью удаленного прежнего текста (рисунков) не допускаются. После внесения исправлений документ должен удовлетворять требованиям, предъявляемым к документам для микрофильмирования, установленным ГОСТ 13.1.002.

3 Построение документа

3.1 Текст документа при необходимости делится на разделы и подразделы. Разделы могут делиться на пункты или на подразделы и пункты. Разделы, подразделы, пункты и подпункты должны иметь порядковые номера, обозначенные арабскими цифрами и записанные с абзацного отступа. Разделы нумеруются порядковыми номерами в пределах всего документа, за исключением приложений, например: 1..., 2... и т.д. Номер подраздела должен включать номер раздела, например: 1.1..., 1.2... и т.д. Номер пункта должен включать номер раздела и подраздела, например: 2.1.1..., 2.1.2... и т.д.

Пункты при необходимости могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1, 4.2.1.2 и т. д.

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

Пример.

а) ____________________________________________________________________________________

____________________________________________________________;

б) ___________________________________:

1) __________________________________________________________________________________

________________________________________________________________________________;

2) __________________________________________________________________________________

______________________________________;

в) ____________________________________________________________________________________

_______________________________________________________________.

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

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

При оформлении заголовков следует соблюдать следующие требования к их размещению:

- расстояние между заголовком (сверху и снизу) и текстом, выполненным машинописным способом – 3…4 интервала печатной машинки (интервал в MS Word 9…18 пт), рукописным – не менее 15 мм;

- расстояние между заголовком раздела или подраздела и текстом, выполненным на печатной машинке – 3…4 интервала (интервал в MS Word 9…18 пт), рукописным – не менее 15 мм;

- расстояние между заголовком пункта и текстом, выполненными на печатной машинке – 2 интервала (интервал в MS Word 6…12 пт), рукописным – не менее 8 мм;

- заголовок подпункта от текста не отделяется.

3.2 В конце текстового документа приводится список литературы, которая использована при его составлении. Выполнение списка и ссылки на него в тексте — по ГОСТ 7.32.

Список литературы имеет заглавие «Библиографический список», является последним приложением и включается в содержание документа. Это информационное приложение. Список источников приводится в последовательности упоминания в тексте.

Ссылки на использованную литературу даются с использованием знаков /.../ или […], которые должны быть одинаковыми по всему тексту. Ссылаться следует на документ в целом или его разделы и приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций данного документа.

Примеры оформления ссылок: /13/, /18, приложение В/, /7, раздел 2/.

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

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

4 Изложение текста документа

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

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

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

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

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

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

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

в) применять сокращения слов, кроме установленных:

1) правилами русской орфографии;

2) соответствующими государственными стандартами;

3) в соответствующем разделе документа;

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

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

- применять математический знак минус “—“ перед отрицательными значениями величин (следует писать слово " минус");

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

- применять без числовых значений математические знаки: > (больше),

- < (меньше), = (равно), > (больше или равно), < (меньше или равно),

- ¹ (не равно), а также знаки № (номер) и % (процент);

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

4.5 Перечень допускаемых сокращений слов установлен в ГОСТ 2.316.

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

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

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

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

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

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

Примеры.

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

2. Отобрать 15 труб для испытаний на давление.

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

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

Примеры.

1 От 1 до 5 мм.

2 От 10 до 100 кг.

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

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

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

например, 1, 50; 1, 75; 2, 00.

4.12 Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать 1/4"; 1/2".

При невозможности выразить числовое значение в виде десятичной дроби допускается записывать его в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А—4С)/(40В+20).

5 Нумерация и оформление формул

5.1 Все приведенные в текстовом документе формулы должны быть пронумерованы. Нумерация формул производится арабскими цифрами, которые записываются в круглых скобках справа от формулы без отступа от правого края контура текста страницы. Нумерация может быть либо сквозной в пределах всего документа, например: (1), (2), (3) и т.д., либо в пределах раздела, в этом случае номер формулы должен содержать номер раздела и порядковый номер формулы внутри раздела, например: (1.1), (1.2) и т.д. Если в документе только одна формула, то она обозначается (1). Формулы приложений нумеруются в пределах каждого приложения и должны содержать обозначение приложения и порядковый номер формулы внутри приложения, например: (А.3) - третья формула приложения А. Ссылки в тексте на формулы даются в скобках, например: "... в формуле (5)...", "... в формуле (3.1)...".

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

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

Максимальная податливость гладкого вала W_max, мм/Н, вычисляется по формуле

, (5.1)

где l – длина вала, мм;

A – коэффициент, зависящий от способа установки вала при обработке

на станке;

E – модуль упругости, Па;

I – осевой момент инерции вала при изгибе, мм⁴.

Формулы, следующие одна за другой (в том числе расчетные) и не разделенные текстом, отделяются запятой, например:

A = a / b, (5.2)

B = c + k. (5.3)

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

Формула - это составная часть предложения; предложение не может начинаться с формулы или состоять только из формул.

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

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

s_и = М_и /W, (5.4)

s_и = 0, 64× 10³ /16× 10³ × 10^-9 = 40× 10⁶ Па = 40 МПа.

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

6 Последовательность расчетов

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

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

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

7 Оформление примечаний

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

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

Примеры.

Примечание — В данной главе приведены тезисы основных положений теории, а иллюстрации и примеры даны в приложении.

Примечания:

1 В данной главе приведены тезисы основных положений теории, а иллюстрации и примеры даны в приложении.

2 Кроме указанных опытов в университете, проведены исследования на опытном производстве.

8 Нумерация и оформление иллюстраций

8.1 Количество иллюстраций (рисунков, схем, диаграмм и пр.) должно быть достаточным для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту (после первой ссылки на них в тексте, возможно ближе к месту ссылки), так и в его конце. При необходимости иллюстрации могут быть вынесены в приложение. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД.

8.2 Иллюстрации, за исключением иллюстраций приложений, нумеруются арабскими цифрами сквозной нумерацией по всему тексту документа либо в пределах раздела. В этом случае номер рисунка должен содержать номер раздела и порядковый номер рисунка внутри раздела, разделенные точкой, например: " Рисунок 1.1", " Рисунок 1.2" и т.д. Если в текстовом документе только один рисунок, то он обозначается " Рисунок 1". Обозначение и наименование рисунка центрируется.

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

Например, «Рисунок А.3 – Компоновка заточного станка».

8.3 На все иллюстрации в тексте должны быть ссылки. При ссылках на иллюстрации следует писать: "... в соответствии с рисунком 2" при сквозной нумерации и "... в соответствии с рисунком 1.2" при нумерации в пределах раздела.

8.4 Если в тексте документа имеется иллюстрация с изображением составных частей изделия, то на этой иллюстрации должны быть указаны номера позиций этих составных частей в пределах данной иллюстрации. Эти номера позиций располагаются в возрастающем порядке, за исключением повторяющихся позиций. Ссылка на позицию рисунка: "... рисунок 1.4, поз.8...".

При ссылке в тексте на отдельные элементы деталей (отверстия, пазы, канавки, буртики и др.) они обозначаются прописными буквами русского алфавита, которые наносятся на иллюстрациях в соответствии с ГОСТ 2.109-73.

8.5 Качество иллюстраций должно обеспечивать их четкое воспроизведение. Рисунки следует выполнять только черной пастой или тушью, чтобы обеспечить их четкое воспроизведение при копировании, сканировании, микрофильмировании и т.п. Фотографии размером меньше формата А4 наклеиваются на стандартные листы без поворота или с поворотом на 90⁰ против часовой стрелки.

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