Основные требования к оформлению текстового материала
МЕТОДИЧЕСКОЕ ПОСОБИЕ
Общие требования к построению, изложению,
Содержанию и оформлению текстовых документов
Общие требования к построению, изложению, содержанию и оформлению текстовых документов: методическое пособие разработано для студентов и преподавателей «Орского технического техникума им. А.И.Стеценко» и предназначено для использования в учебном процессе.
Методическое пособие разработано в соответствии с требованиями ГОСТ Р 1.5-92, ГОСТ 2.105-95, ГОСТ 2.106-96 и других нормативно-технических документов, относящихся к разработке, выполнению и оформлению текстовых документов.
Автор: преподаватель 1 категории общепрофессиональных и специальных дисциплин
Михайлюк Римма Анатольевна
Область применения
Данное методическое пособие разработано в соответствии с нормами государственных стандартов и предназначено для выполнения и оформления текстовых документов, выполняемых студентами и преподавателями «Орского технического техникума им. А.И.Стеценко» и является для них обязательным.
Пособие предназначено для студентов всех специальностей ГАОУ СПО «ОТТ им. А.И.Стеценко» и всех форм обучения. Указания, включенные с пособие, могут служить руководством при составлении пояснительных записок к курсовым, дипломным проектам (работам), лабораторным и практическим работам, рефератам, а также работам предметно-цикловых комиссий.
Общие положения
2.1 Руководящий технический материал разработан с учетом государственных стандартов единой системы конструкторской документации – ЕСКД, единой системы технологической документации – ЕСТД, единой системы программной документации – ЕСПД.
В соответствии с ГОСТ Р 1.0-92 настоящий документ относится к виду стандарта на технические требования и устанавливает требования к качеству и оформлению текстовых документов.
Структура, содержание и изложение настоящего документа выполнено в соответствии с требованиями ГОСТ Р 1.5-92, оформление по ГОСТ Р 1.4-93.
К РТМ 01.2010 предусмотрен лист регистрации изменений в соответствии с ГОСТ 21.101-97.
2.2 Нормативные ссылки
В настоящем пособии использованы ссылки на следующие стандарты:
ГОСТ 2.004-88 ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ
ГОТС 2.105-95 Общие требования к текстовым документам
ГОСТ 2.106-96 Текстовые документы
ГОСТ 2.109-73 Основные требования к чертежам
ГОСТ 2.304-81 Шрифты чертежные
ГОСТ 2.321-84 Обозначения буквенные
ГОСТ 2. 503-90 Правила внесения изменений
ГОСТ 6.38-90 Система организационно-распорядительной документации. Требования к оформлению документов
ГОСТ 7.32-91 Система стандартов по информации, библиотечному и издательскому делу. Структура и правила оформления текстовых документов. Издание официальное
ГОСТ 21.1101-92 СПДС Основные требования к рабочей документации
РТМ 36.18.32.2-92 Правила оформления текстовых документов в проектной и проектно-конструкторской документации
Основные требования к оформлению текстового материала
3.1 Общие требования
3.1.1 Общие требования к оформлению текстовых материалов разработаны на основании ГОСТ 2.105-95.
3.1.2 Текстовый материал (в дальнейшем документ) подразделяется на документы содержащие:
- сплошной текст (пояснительные записки, инструкции, расчеты, пособия, т. п.);
- текст, разбитый на графы (спецификации, ведомости, таблицы и т.п.).
3.1.3 Текстовые документы выполняют на листах формата А4 (210х297 мм) по ГОСТ 2.301-68. Текст выполняют одним из следующих способов:
- рукописным – чертежным шрифтом (ГОСТ 2.304) с высотой букв и цифр не менее 2,5мм. Цифры и буквы необходимо писать четко черной тушью или пастой на одной стороне листа белой бумаги;
- с применением печатающих и графических устройств вывода ЭВМ с лентой только черного цвета (ГОСТ 2.004).
3.1.4 При работе на ПК текст оформляется в редакторе Word for Windows версии не ниже 6,0 с соблюдением требований ГОСТ7.32:
- тип шрифта – Times New Roman кеглем не менее 12, обычным, строчным, без выделения и применения курсива, с выравниванием по ширине;
- абзацный отступ должен быть одинаковым и равен по всему тексту 1,27 см;
- строки разделяются полуторным интервалом;
- поля страницы: верхнее и нижнее - 20мм, левое – 30мм, правое – 10мм;
- полужирный шрифт не применять.
3.2 Текстовый материал оформляется в виде пояснительной записки.
3.2.1 Пояснительная записка является основным текстовым документом
к проектам согласно ГОСТ 2.106-96. В соответствии с ГОСТ 2.105-95 и
должна состоять из следующих частей:
титульная часть:
- обложка;
- титульный лист;
информационная часть:
- аннотация (не входит в общее количество листов документа);
- задание на проектирование (не входит в общее количество листов документа);
- перечень замечаний нормоконтролера (не входит в общее количество листов документа и предназначен только для дипломных работ);
- лист содержания;
основная часть:
- пояснительно – расчетный материал в объеме, предусмотренном
заданием на проектирование (с рисунками, таблицами, графиками и т.п.);
- приложения;
- список используемой литературы;
регистрационная часть:
- лист регистрации изменений (при необходимости), (не входит в общее количество листов документа).
3.3 Требования к оформлению обложки и титульного листа.
3.3.1 Обложка является первым листом пояснительной записки, оформляется на листе бумаги формата А4 с рамкой, по форме установленной ГОСТ 2.301-68 согласно приложения А.1, А.2.
Титульный лист, является вторым листом пояснительной записки оформляется на листе бумаги формата А4 с рамкой, по форме установленной ГОСТ 2.301-68 согласно приложения Б.
3.3.2 Обложка и титульный лист оформляются с использованием компьютера, принтера (струйного или лазерного) с использованием современного текстового редактора.
На обложке в строке «Обозначение работы» указываются следующие данные:
1- шифр документа (КП - курсовой проект, КР - курсовая работа, ДП - дипломный проект, ДР - дипломная работа);
2 - код специальности;
3 - личный шифр студента (по номеру зачетной книжки);
4 - год выполнения;
5 - номер сборочной единицы или схемы
6 – обозначение кода документа (чертежа) ГОСТ 2.102-68
Пример
КП. 190631.01.2013.00 ПЗ
1 2 3 4 5 6
Допускается расширение обозначения документов проектов введением дополнительных позиций в зависимости от специфики проектов, например, вариант, номер детали и т.п.
3.3.3 Перенос слов, сокращения (кроме установленных стандартом) и аббревиатуры на титульном листе не допускаются. Подписи и даты подписания выполняют только черным цветом. Элементы даты приводят арабскими цифрами в одной строке в последовательности: день месяца, месяц, год (например, 10.02. 2013).
3.4 Требования к оформлению аннотации
3.4.1 Аннотация (как составная часть документа) является обязательным структурным элементом текстовых материалов: методических пособий и указаний, курсовых проектов (работ) дипломных проектов (работ), выпускных квалификационных работ, отчетов по преддипломной практике, отчетов по учебно-исследовательской работе и т. п. Аннотация печатается отдельным листом, помещается после титульного листа и не входит в общее количество листов документа.Общий объем аннотации должен составлять 500-1000 знаков.
3.4.2 Аннотация должна содержать:
- сведения о количестве страниц документа (включая приложения);
- сведения о количестве иллюстраций, таблиц, графиков, диаграмм,
схем, приложений;
- сведения о количестве использованных источников;
- сведения о графической части (при наличии) – количество чертежей
(формат листов), плакатов
3.4.3 В текстовой части аннотации должны быть отражены наиболее существенные характерные черты выполненной работы: объект разработки или исследования, цель работы, методы исследования, полученные результаты, область применения, экономическая эффективность или значимость работы. Пример выполнения листа аннотации представлен приложением В.
3.5 Требования к оформлению задания на проектирование
3.5.1 Задание на проектирование оформляется на специальном бланке
и подписывается должностными лицами в соответствии с процедурой
установленной учебным заведением (колледжем). Образцы листов заданий
на проектирование представлены приложениями Г.1,Г.2.
3.5.2 Задание на проектирование подшивается за титульным листом и в общую нумерацию листов проекта не включается (ГОСТ 2.105-95).
3.6 Требования к оформлению листа нормоконтролера
3.6.1 Лист нормоконтролера заполняется только для дипломных проектов и подшивается после задания на проектирование, и в общую нумерацию листов проекта не включается (ГОСТ 2.105-95).
Бланк листа нормоконтролера представлен приложением Д.
3.7 Требования к оформлению содержания пояснительной записки.
3.7.1 Информационная и основная часть пояснительной записки настоящего документа выполняется на листах формата А4. В зависимости от назначения документа он оформляется на листах формата А4, снабженных рамкой и рамкой с основной надписью (для текстовых документов, форма 2, 2а). Форма основных надписей для текстовых документов представлена в приложении И.
3.7.1 Содержание пояснительной записки включает введение, наименование всех разделов, подразделов, пунктов (если они имеют наименования), заключение, список используемых источников, приложения (при наличии).
3.7.2 Строки содержания заканчиваются указанием номеров страниц, на которых расположено начало соответствующей части документа. Лист «Содержание» нумеруется третьем листом текстового документа по счету.
3.7.3 Содержание курсовых, дипломных и т.п. проектов помещают на листе с основной надписью по ГОСТ 2.104-68 форма 2, а при необходимости на последующих листах с основной надписью по ГОСТ 2.104-68 форма 2а, (варианты форм основной надписи представлены в приложении К).
Порядок заполнения основной надписи определен ГОСТ 2.104-68, применяемой на графических и иллюстрационных материалах проектов. Для заполнения граф основной надписи применять шрифт чертежный ГОСТ 2.304-81тип А без наклона, высота шрифта для граф: 1 – h 7; 2 – h10; 9 – h5; 4,7,8, с 10 по18 – h3,5, черной пастой от руки или шрифтом Times New Roman с подбором размера(высоты) шрифта.
Страницы содержания нумеруются справа внизу в основной надписи. Пример выполнения листа содержания приведен в приложении Е.
Слово «Содержание» записывают в виде заголовка, симметрично тексту, с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы. Содержание включают в общее количество листов текстового документа.
3.8 Требования к оформлению содержания «Введения»
3.8.1 Введение должно отражать оценку современного состояния решаемой задачи, актуальность, цель работы (проекта), задачи, объект и предмет исследования, сведения об ожидаемом результате, практическая направленность.
Пример выполнения листа «Введение» представлен приложением Ж.
3.9 Требования к оформлению списка литературы
3.9.1 В конце текстового документа приводится список литературы, которая была использована при его составлении.
Литература записывается и нумеруется в порядке ее упоминания в тексте. Допускается располагать сведения об источниках в алфавитном порядке, по частоте использовании, по значимости для данной работы.
В списке литературы приводятся фамилия и инициалы автора, название книги, издательство, место издания и год издания. Для статей указывается фамилия и инициалы автора, название статьи, название журнала или сборника, год издания, том и номер страницы.
Ссылки на литературные источники приводятся в тексте в наклонных
скобках. При цитировании текста из источника указывается номер источника и номер страницы в нем.
Пример:
1 «При сварке термически упрочняемых соединений неизбежно
разупрочнение /4/…»
2 «…с повышением толщины разупрочнение сварного соединения
Снижается благодаря появлению контактного упрочнения /4, с. 94/».
Выполнение списка и ссылки на него в тексте должны соответствовать
Стандартам ГОСТ 7.1-84, ГОСТ 7.32-91, пример выполнения списка
литературы приведен в приложении И.
3.10 Требования к программному обеспечению
3.10.1 Программные документы оформляются в соответствии с требованиями ГОСТ 19.701-90 и другими стандартами ЕСПД на соответствующие документы:
ГОСТ 19.005-85, ГОСТ 19.101-77, ГОСТ 19.102-77,
ГОСТ 19.103-77, ГОСТ 19.104-77, ГОСТ 19.202-78,
ГОСТ 19.401-78, ГОСТ 19.402-78, ГОСТ 19.404-78.
3.10.2 Виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения установлены ГОСТ 19.001-77. Описание применения, требования к содержанию и оформлению даны в ГОСТ 19.502-78, руководство программиста установлено ГОСТ 19.504-79.
3.10.3 В листе задания на курсовые и дипломные проекты в разделе «Приложения» необходимо указать данные о текстовом редакторе и прилагаемом электронном носителе, например:
- электронный носитель: компакт-диск типа CD-R, 52х, 700МВ/80мин.
Текстовый редактор – Word for Windows версия 6,0, редактор формул Equation Editor 3.0 из состава Microsoft Word.