Головка

Нормативные ссылки

Область распространения стандарта предприятия

СТАНДАРТ ПРЕДПРИЯТИЯ

Текстовые документы. СТП ЯГСХА 1-00

Требования к оформлению

Приказом ректора Ярославской государственной сельскохозяйственной академии от “___” _______ 2004 г. № ___срок действия установлен с “__” ______ 2004 г.

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

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

ГОСТ 2.004-88 ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ.

ГОСТ 2.104-68 ЕСКД. Основные надписи

ГОСТ 2.105-95 ЕСКД Общие требования к текстовым документам

ГОСТ 2.106-68 ЕСКД. Текстовые документы

ГОСТ 2.304-81 ЕСКД Шрифты чертежные

ГОСТ 2.231-84 ЕСКД Обозначения буквенные

ГОСТ 2.503 –90 ЕСКД Правила внесения изменений

ГОСТ Р 6.30-97 Унифицированная система организационно-распорядительной документации. Требования к оформлению документов

СТП ЯГСХА 1– 00

ГОСТ 7.32-91 Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления

ГОСТ 8.417-81 ГСИ. Единицы физических величин

ГОСТ 21.1101-92 СПДС. Основные требования к рабочей документации

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

К текстовым учебным документам, выполняемым в академии, относятся:

- пояснительная записка к дипломным проектам (работам);

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

- обзорные рефераты;

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

- отчеты о лабораторных работах;

- расчетно-графические работы (задания).

Текстовые учебные документы являются иллюстрированными текстовыми документами, содержащими, в основном, сплошной текст, и должны быть оформлены в соответствии с ГОСТ 2.105 и ГОСТ 2.106 и настоящего стандарта предприятия.

Научно-техническая, методическая и учебная литература оформляется по СТП ЯГСХА 1-00 в той части, которая не противоречит требованиям издательств.

3.1 Обозначение текстовых документов

Всем текстовым документам должно быть присвоено обозначение, которое указывается в графе 2 основной надписи, оформленной в соответствии с требованиями ГОСТ 2.303 (см. приложение А).

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

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

СТП ЯГСХА 1– 00

ХХ ХХ ХХХ ХХ ХХ

Шифр проекта (работы)[1]

Год выпуска

Регистрационный номер проекта (работы)

на кафедре[2]

Шифр документа (ПЗ)

Обозначение раздела

Рисунок 3.1 – Обозначение текстовых документов

3.2 Текстовая часть пояснительной записки

3.2.1 Пояснительная записка к проекту или работе выполняется рукописным способом черной тушью или пастой (черной или фиолетовой) с высотой букв и цифр не менее 5 мм или печатается на пишущей машинке качественным шрифтом через 2 интервала (для текстового редактора ПЭВМ Word 2000 – через 1,5 интервала) на одной стороне листа белой бумаги формата А4 (210 х 297). Лента только черного цвета. Число строк на листе не более 30 (включая пропущенные строки).

3.2.2 Отдельные слова, условные знаки, формулы вписываются в печатный текст средствами текстовых редакторов ПЭВМ или рукописным способом черной тушью (пастой).

3.2.3 Каждый лист пояснительной записки оформляется рамкой (простым карандашом, черной тушью, черной пастой), отстоящей на 20 мм от левой стороны листа и на 5 мм от трех остальных сторон. Допускается использование бланков для текстовых документов, изготовленных ксерокопированием или типографским способом по формам 5 и 5а в соответствии с ГОСТ 2.106. Расстояние от линий рамки до границ текста: в начале строк и в конце строк не менее 3 мм; от верхней или нижней строки текста до верхней или нижней линий рамки – не менее 10 мм.

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

СТП ЯГСХА 1– 00

Номер страницы для варианта оформления без основной надписи по форме 2а (ГОСТ 2.104) проставляется вверху (симметрично тексту). Точка и другие знаки рядом с номером страницы не ставятся.

Абзацы в тексте начинаются отступом 15 … 17 мм (пять знаков).

3.2.5 Текст пояснительной записки при необходимости разделяют на разделы, подразделы и пункты.

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

Каждый подраздел имеет порядковый номер в пределах каждого раздела и заголовок, выполненный строчными буквами с первой прописной. Номер подраздела состоит из номера раздела и порядкового номера подраздела, разделенных точкой. В конце номера подраздела точка не ставится. Например, “2.3 Расчет вала”.

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

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

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

Расстояние между заголовком и текстом при выполнении документа машинописным способом должно быть равно 3 … 4 интервалам, при выполнении рукописным способом – 15 мм. Расстояние между заголовками раздела и подраздела – 2 интервала.

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

а) ________________;

б) ________________;

в) ________________.

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

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

СТП ЯГСХА 1– 00

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

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

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

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

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

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

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

- использовать в тексте математический знак “ – ” перед отрицательными значениями величин. В этом случае следует писать слово “минус”;

- употреблять математические знаки без цифр, например; “≤” (меньше или равно), “≥” больше или равно), “≠” (не равно), а также знаки “N°” (номер), “%” (процент);применять индексы стандартов (ГОСТ ОСТ, СТП и т.д.) без регистрационного номера.

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

3.2.9 В тексте числа с единицами измерения следует писать цифрами, а без единиц измерения – словами, например: “Зазор не более 2 мм”, “Нагрузку увеличить в два раза”.

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

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

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

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

При невозможности выразить числовое значение в виде десятичной дроби,

СТП ЯГСХА 1– 00

допускается записывать в виде простой дроби в одну строчку через косую черту, например: 5/17; 3/32 и т.д.

3.3 Содержание

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

Заголовок “Содержание” выполняют с первой прописной буквы, располагая его в начале страницы симметрично тексту.

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

3.4 Формулы

3.4.1 Формулы следует выделять из текста свободными строками. Выше и ниже каждой формулы должно быть оставлено не менее одной свободной строки. Если формула не умещается в одну строку, она должна быть перенесена после знака равенства “ = ” или после знаков плюс “ + ”, минус “ - ”, умножения “ х ”, деления “: ”.

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

σ = М ^. 10³ / W, (3.1)

где σ - напряжение, МПа;

М – максимальный изгибающий момент, Н · м;

W – осевой момент сопротивления, мм³.

СТП ЯГСХА 1– 00

Ссылки в тексте на номер формулы дают с скобках, например: “ … в формуле (3.1)”, “по формуле (6.2)”.

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

“Подставляя значения максимального изгибающего момента М = 25 Н · м, вычисленное по формуле (3.4), и осевого момента W=250 мм³ [8], получим

25·10³

σ = = 100 МП а´´.

3.4.3 Формулы, следующие одна за другой и не разделенные текстом, разделяются запятой.

3.4.4 Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например: (Б.1).

3.5 Иллюстрации

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

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

3.5.3 Расположение иллюстраций должно быть таким, чтобы их можно было рассматривать без поворота страницы или с поворотом по часовой стрелке на 90º.

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

СТП ЯГСХА 1– 00

нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например: Рисунок Б.3.

При ссылках на иллюстрации следует писать “… в соответствии с рисунком 1.2” или “… (рисунок 1.2)”. Ссылки на ранее упомянутые

иллюстрации дают с сокращенным словом “смотри”, например, “… (см. рисунок 1.2)”.

Иллюстрации при необходимости могут иметь наименование и пояснительные данные. Слово “Рисунок” и наименование помещают после пояснительных данных.

3.6 Таблицы

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

3.6.1 Форма таблицы в соответствии с рисунком 3.2 в общем случае должна иметь вертикальные графы (колонки) с заголовками и подзаголовками и горизонтальные строки (ряды) с соответствующими наименованиями.

Количество граф и строк, а также их размеры зависят от содержания таблицы. Высота строк должна быть не менее 8 мм.

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

Таблица _________ - __________________________

номер название таблицы

Боковик (граф Графы (колонки)

для заголовков)

Рисунок

СТП ЯГСХА 1– 00

Продолжение таблицы _________

номер

Рисунок

3.6.2 Таблицы нумеруют арабскими цифрами (без знака №) в пределах раздела. Номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой, например: Таблица 1.2. Слово “Таблица” с номером таблицы помещают над левым верхним углом таблицы перед тематическим заголовком (если он есть). Тематический заголовок таблицы выполняют строчными буквами с первой прописной.

3.6.3 Если таблицы приводятся в приложениях, то нумерация производится в каждом из них, начиная с номера 1, с добавлением обозначения приложения перед номером, например: Таблица А.1.

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

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

3.6.6 Слов “Таблица” указывают один раз, над другими частями таблицы пишут слова “Продолжение таблицы …” с указанием номера (обозначения) таблицы (рисунок 3.2). Тематический заголовок помещают только над первой частью таблицы.

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

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

СТП ЯГСХА 1– 00

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

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

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

3.6.10 Числовые значения величин в каждой графе должны иметь одинаковое количество десятичных знаков.

3.6.11 Сноски к данным располагают в конце таблицы над линией, обозначающей конец таблицы.

3.6.12 На все таблицы документа должны быть ссылки в тексте документа. При ссылке следует писать слово “таблица” с указанием ее номера.

3.7 Приложения

3.7.1 Материал, дополняющий текст документа, рекомендуется помещать в приложениях на листах формата А4. Допускается приложение оформлять на листах формата А3, А4х3, А4х4, А2, А1. Приложения оформляются как продолжение данного документа на последующих его листах.

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

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

3.7.4 Приложения обозначают прописными буквами русского алфавита, начиная с А, за исключением букв Е, З, Й, О, Ч, Ь, Ы, Ъ. После слова “Приложение” следует буква, обозначающая его последовательность.

Если в документе одно приложение, оно обозначается «Приложение А».

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

СТП ЯГСХА 1– 00

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

3.7.7 В тесте документа на все приложения должны быть даны ссылки. Степень обязательности приложений при ссылках не указывается. Приложения располагают в порядке ссылок на них в тесте документа, за исключением приложения “Библиография”, которое располагают последним.

3.8 Библиографическое описание литературных источников

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

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

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

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

1. Анурьев В.И. Справочник конструктора –машиностроителя. Изд. 8-е в 3-х т.т. – М.: Машиностроение, 1999 -

2. Дунаев П.Ф., Леликов О.П. Конструирование узлов и деталей машин. – 7-е изд., испр. – М.: Высш.шк., 2001. – 447 с.: ил.

3. Материаловедение и технология металлов: Учеб. для студентов машиностроит. спец. вузов / Г.П. Фетисов, М.Г. Карпман, В.М. Матюнин и др.; Под ред. Г.П. Фетисова. – М.: Высш. шк., 2002. – 638 с.: ил.

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

- Ашихмин И.П., Костин Г.Н., Сысуев В.А. Исследование реактора-смесителя технологической линии ЛИС-1 // Механизация процессов в животноводстве и кормопроизводстве: Межвуз. Сб. науч. тр. / Пермский с.-х. ин-т. – Пермь, 1983, - с. 10-19. Библиогр.: с.167 (24 назв.);

- Лурье А.В., Стяжкин В.И. Анализ рабочего процесса вязальных аппаратов льноуборочных машин // Механизация и электрификация сел. хоз-ва. – 1985. - №12. С.16-18;

СТП ЯГСХА 1– 00

- Лопарев А.А. Под номером двадцать девять: Новинка минских тракторостроителей на кировской земле // Кировск. Правда. – 1986. – 26 янв.

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

При указании места издания допускается сокращения: М. – Москва; СПб – Санкт-Петербург (Л – Ленинград). Названия других городов пишутся полностью.

Список использованной литературы составляют в алфавитном порядке. При использовании иностранной литературы последнюю помещают за отечественной. Стандарты и нормы в список литературы не включают. Ссылку на литературный источник в тексте осуществляют указанием ее порядкового номера, заключенного в квадратные скобки, например, “[4]”.

3.9 Структура пояснительной записки

Пояснительная записка дипломного проекта должна иметь:

- титульный лист;

- задание;

- ведомость;

- аннотацию;

- содержание (оглавление);

- основную часть (введение, разделы, подразделы, заключение);

- приложения;

- список литературы.

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

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

3.9.2 Задание на дипломный проект (работу) выдается ведущей кафедрой, заполняется и подписывается руководителем, заведующим кафедрой и студентом.

3.9.3 Ведомость дипломного проекта содержит перечень документов, предусмотренных ГОСТ 2.102 и вошедших в дипломный проект. Ведомость составляется по формам, приведенным в приложении И.

3.9.4 Аннотация – краткое изложение дипломного проекта. В аннотации необходимо указать цель и существо основных разработок, указать количество листов пояснительной записки, количество приложений и иллюстраций к ней, таблиц, количество листов графической части проекта, не вошедших в пояснительную записку. Объем текста аннотации 0,5 … 1,0 страниц.

3.9.5 Содержание пояснительной записки включает:

СТП ЯГСХА 1– 00

- заголовки разделов и подразделов;

- приложения;

-список использованной литературы.

3.9.6 Основная часть пояснительной записки состоит из разделов (глав),подразделов и пунктов.

3.9.7 Основная часть должна содержать:

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

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

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

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

3.9.8 Заключение должно содержать окончательные выводы по результатам выполненной работы, оценку технико-экономической эффективности, научную, практическую, социальную ценность результатов работы.

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

3.9.10 В список литературы включают только те литературные источники и документы, которые использованы при проектировании.

[1] ДП – дипломный проект; КП – курсовой проект; КР – курсовая работа и т.д.

[2] Регистрационный номер проекта состоит из индекса кафедры и порядкового номера регистрации в пределах одного года.

Дата добавления: 2015-03-29