Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998




Скачать 129.99 Kb.
НазваниеМетодические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998
Дата публикации16.01.2014
Размер129.99 Kb.
ТипМетодические указания
exam-ans.ru > Право > Методические указания


Министерство образования Украины

Донбасская государственная машиностроительная академия

МЕТОДИЧЕСКИЕ УКАЗАНИЯ

по оформлению текстовой документации

для студентов всех специальностей

Краматорск, ДГМА 1998

Министерство образования Украины

Донбасская государственная машиностроительная академия

МЕТОДИЧЕСКИЕ УКАЗАНИЯ

по оформлению текстовой документации

для студентов всех специальностей

Утверждено

на заседании кафедры

Технологии машиностроения
Протокол №; 22 от 17.02.98 г.

Краматорск, ДГМА 1998
УДК

Методические указания по оформлению текстовой документации

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


Составители: С.В. Ковалевский, проф.

И.П. Катасонов, доц.

А.Г. Косенко, доц.

Ответственный

за выпуск С.В. Ковалевский, проф.


Методические указания разработаны на основании Государственного стандарта Украины ДСТУ 3008-95 (Документация. Отчеты в сфере науки и техники) и межгосударственного стандарта ГОСТ 2.105-95 (ЕСКД. Общие требования к текстовым документам).
1.Структура пояснительной записки.
Структура пояснительной записки должна отвечать требованиям методических указаний к курсовым и дипломным проектам, разработанных кафедрами академии, а также методическими указаниями по составлению отчетов по практике.

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

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

  • бланк задания;

  • реферат;

  • содержание;

  • введение;

  • основная часть, разделенная на разделы, подразделы, пункты, подпункты;

  • выводы;

  • перечень ссылок;

  • приложения.



2.Требования к структурным элементам пояснительной записки
2.1.Бланки заданий на курсовое проектирование разрабатываются каждой кафедрой академии применительно к тематике и содержанию дисциплины, по которой выполняется курсовой проект.

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

2.3.Реферат должен содержать:

  • сведения об объеме записки, количестве иллюстраций, таблиц, приложений, количестве источников по перечню ссылок;

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

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


2.4.Содержание включает: введение; последовательно перечисленные наименования всех разделов, подразделов, пунктов и подпунктов (если имеют заголовки) проекта; выводы; перечень ссылок; наименования приложений и номера страниц, на которых имеется начало каждого приложения.
2.5.Во введении кратко излагают:

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

  • актуальность данной работы для народного хозяйства Украины в условиях рыночной экономики;

  • цель работы и область применения разработанного объекта.

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

При изложении данной части проекта особое внимание уделяют новизне в работе; положительному эффекту, достигнутому в результате новизны, а также вопросам экономической эффективности, надежности, безопасности, экологии, ресурсосбережения. Принципиально важным является инженерное обоснование каждого принимаемого в проекте решения. В пояснительной записке обязательны ссылки на таблицы, рисунки, приложения и графическую часть проекта. Например, лист ДП 093125.001, где 93125 - номер зачетной книжки, 001 - номер листа.
Выводы помещают непосредственно после изложения основной части записки на новой странице.

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

Текст выводов может быть разделен на пункты.

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

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

В приложения могут быть включены:

  • спецификации к чертежам;

  • дополнительные иллюстрации или таблицы;

  • описания компьютерных программ, разработанных в процессе выполнения;

  • маршрутные и операционные технологические процессы механической обработки и сборки;

  • протоколы испытаний разработок по НИРСу, включенных в выполняемый курсовой или дипломный проекты.

Приложения должны иметь названия.
3.Правила оформления пояснительной записки
3.1.Общие требования
3.1.1.Записка оформляется на листах формата А4 (210х297).

3.1.2.Записка выполняется “от руки” или машинном способе (при помощи печатающих графических устройств вывода ЭВМ) на одной стороне листа белой бумаги с соблюдением требований ДСТУ-3008-95.

При машинном способе записку выполняют из расчета не более 40 строк на странице при условии равномерного ее заполнения и высотой букв и цифр не менее 1,8 мм.

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

Тексты на листах записки:

  • рефератов, отчетов по лабораторным работам, НИРС, практике должны оформляться с полями: правое - 10 мм, остальные - 20 мм; номера страниц проставляются в правом верхнем углу;

  • конструкторско-технологической документации, включая пояснительные записки к курсовому и дипломному проектированию оформляются в рамках: левое поле - 20 мм, остальные по 5 мм; внизу штамп 15 мм с указанием номера листа в правом нижнем углу в графе размерами 7х10 (лист) 8х10 (номер листа).


3.1.3.Ошибки и графические неточности допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том листе или между строками исправленного изображения от руки.
3.1.4.Структурные элементы пояснительной записки “СОДЕРЖАНИЕ”, “РЕФЕРАТ”, “ВВЕДЕНИЕ”, “ВЫВОДЫ”, “ПЕРЕЧЕНЬ ССЫЛОК” не нумеруются.
3.1.5.Разделы и подразделы должны иметь заголовки. Пункты и подпункты могут иметь заголовки.

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

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

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

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

3.1.10.Расстояние между заголовком и последующим или предыдущим текстом должно быть: - при машинном способе - не менее двух строк.

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

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

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

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

3.3.2.Разделы записки должны иметь порядковую нумерацию и обозначаться арабскими цифрами без точки, например 1,2,3 и т.д.

3.3.3.Подразделы должны иметь порядковую нумерацию в пределах каждого раздела. Номер подраздела состоит из номера раздела и порядкового номера подраздела, разделенных точкой. После номера подраздела точку не ставят, например, 1.1, 1.2 и т.д.

3.3.4.Пункты должны иметь порядковую нумерацию в пределах каждого раздела или подраздела. Номер пункта состоит из номера раздела и порядкового номера пункта, или из номера раздела, порядкового номера подраздела и порядкового номера пункта, разделенных точкой. После номера пункта точку не ставят, например, 1.1, 1.2 или 1.1.1, 1.1.2 и т.д. Если текст подразделяют только на пункты, их следует нумеровать, за исключением приложений, порядковыми номерами.

3.3.5.Номер подпункта состоит из номера раздела, порядкового номера подраздела, порядкового номера пункта и порядкового номера подпункта, разделенных точкой, например, 1.1.1.1, 1.1.1.2, 1.1.1.3 и т.д. Если раздел, не имея подразделов, делится на пункты и далее - на подпункты, номер подпункта состоит из номера раздела, порядкового номера пункта и порядкового номера подпункта, разделенных точкой, например, 1.1.3, 1.2.1 и т.д. После номера подпункта точку не ставят.

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

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

3.4.3.Иллюстрации могут иметь название, которое помещают под иллюстрацией. При необходимости под иллюстрацией помещают поясняющие данные (подрисуночный текст). Иллюстрация обозначается словом "Рисунок ___", которое вместе с названием иллюстрации помещают после поясняющих данных, например, "Рисунок 3.1 - Схема размещения".

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

3.4.5.Если иллюстрация не умещается на одной странице, можно переносить ее на другие страницы, при этом название иллюстрации помещают на первой странице, поясняющие данные - на каждой странице, и под указывают "Рисунок ___", лист ___".

3.4.6.Иллюстрации, при необходимости, могут быть перечислены в содержании с указанием их номеров, наименовании и номеров страниц, на которых они расположены.
3.5.Таблицы
7.6.1 Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 1.
Таблица _________-_____________________________________

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

Заголовки

граф

Головка Подзаголовки граф



Строки



Боковик графы (колонки)
Рисунок 1


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

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

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

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

3.5.6.Слово "Таблица ___" указывают один раз слева над первой частью таблицы, над другими частями пишут: "Продолжение таблицы ___" с указанием номера таблицы.

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

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

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

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

3.7.2.Формулы и уравнения в записке (за исключением формул и

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

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

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

п D n

V= -----------

1000

где D - диаметр обрабатываемого отверстия, мм;

n - частота вращения детали, мин -1.
3.7.4.Переносить формулы или уравнения на следующую строку допускается только на знаках выполняемых операций, причем знак операции в начале следующей строки повторяют. При переносе формулы или уравнения на знаке операции умножения применяют знак "х".
3.8.Ссылки
3.8.1.Ссылки в тексте отчета на источники следует указывать порядковым номером по перечню ссылок, выделенным двумя квадратными скобками, например  6  0"... в работах [1-17]...".

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

При ссылках следует писать: "... в разделе 4 "... на рисунке 1.3 ...", "... в таблице 3.2 ...", "... по формуле (3.1) ...", "... в уравнениях (1.23) - (1.25) ...", "... в приложении Б ...".
3.9.Приложения
3.9.1.Приложения оформляются как продолжение записки, располагая их в порядке появления ссылок на них в тексте записки.

3.9.2.Приложение должно начинаться с новой страницы и иметь заголовок, написанный (напечатанный) вверху. Посередине строки над заголовком должно быть слово “Приложение А”.

3.9.3.Основной текст записки отделяется от приложения титульным листом со словом “ПРИЛОЖЕНИЯ”.

3.9.4.Приложения обозначают прописными буквами: А,Б В Г и т.д. украинского алфавита.

3.9.5.В приложении помещают спецификации к чертежам графической части проекта и другие материалы.

Спецификацию составляют на отдельных листах по формам 1 и 1а ГОСТ 2.106-68.

Методические указания

по оформлению текстовых документов

для студентов всех специальностей
Составители:

Сергей Вадимович Ковалевский

Иван Петрович Катасонов

Анатолий Григорьевич Косенко

Редактор Нелли Александровна Хахина


Добавить документ в свой блог или на сайт

Похожие:

Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998 iconМетодические указания для студентов всех специальностей структура и правила оформления текстовых
Методические указания для студентов всех специальностей. Структура и правила оформления текстовых документов /Сост. В. М. Гах. Краматорск:...

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

Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998 iconМетодические указания для практических работ Красноярск
Методические указания предназначены для студентов экономических специальностей, изучающих курсы «Документирование управленческой...

Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998 iconМетодические указания по выполнению контрольных работ с переходом...
Методические указания, задания и темы контрольных работ для студентов 3 5 курсов всех специальностей «Финансы и кредит», «Маркетинг»,...

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

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

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

Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998 iconМетодические указания и задания по выполнению контрольных работ для...
Страхование : методические указания по выполнению контрольных работ для студентов 3 – 5-го курсов заочной формы обучения всех специальностей...

Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998 iconМетодические рекомендации по оформлению письменных работ для студентов всех специальностей Тверь
Федеральное государственное бюджетное образовательное учреждение высшего профессионального образования

Методические указания по оформлению текстовой документации для студентов всех специальностей Краматорск, дгма 1998 iconКонтрольная работа по курсу: «Высшая математика» Для студентов3 курса всех специальностей
Методические указания, программа и контрольные работы по курсу «Высшая математика» для студентов 3 курса всех специальностей факультета...

Вы можете разместить ссылку на наш сайт:
Школьные материалы


При копировании материала укажите ссылку © 2015
контакты
exam-ans.ru
<..на главную