1320

Министерство путей сообщения Российской Федерации Департамент кадров и учебных заведений

Самарская государственная академия путей сообщения

Кафедра «Инженерная графика»

Оформление учебных текстовых документов

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

Составители: Антипов В.А.

Береснев В.Л.

Самара 2003

УДК 744

Оформление учебных текстовых документов: Методические указания для студентов СамГАПС всех специальностей.- Самара: СамГАПС,

2003. – 22с.

Утверждены на заседании кафедры «Инженерная графика», протокол № 8 от 24.04.03.

Печатается по решению редакционно-издательского совета акаде-

мии.

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

.

Составители:

Антипов Владимир Александрович Береснев Владимир Леонидович

Рецензенты:

Мулюкин Олег Петрович (СамГАПС) д.т.н., профессор кафедры «Инженерная графика»

Редактор: И.А.Шимина

Подписано в печать 30.12.2003. Формат 60х84 1/16. Бумага писчая. Печать оперативная. Усл. п. л. 1,4. Тираж 200 экз. Заказ №221.

Самарская государственная академия путей сообщения,2003

2

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

1.1Учебным процессом предусмотрено выполнение следующих видов текстовых документов:

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

2)пояснительной записки к курсовому и дипломному проектам;

3)домашнего задания;

4)отчета по учебно-исследовательской работе;

5)реферата (как самостоятельного документа).

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

2 Общие требования

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

-рукописным. Разборчивым почерком, перьевой или шариковой ручкой, черным или фиолетовым цветом, расстояние между строчками 6 … 8 мм;

-машинописным. Шрифт пишущей машинки должен быть четким, высотой не менее 2,5 мм, лента только черного цвета (полужирная), строчки - через полтора интервала;

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

Размеры полей: левое – не менее 30 мм, правое – не менее 10 мм, верхнее – не менее 15 мм, нижнее – не менее 20 мм.

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

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

2.4Структурными элементами документа являются:

1)титульный лист;

2)задание;

3)реферат;

4)содержание;

5)введение;

6)основная часть;

7)заключение;

8)список использованных источников;

9)приложения (при наличии).

3

3 Титульный лист

3.1 Титульный лист оформляется на типографском бланке, выдается кафедрой и служит обложкой документа. При отсутствии бланка титульный лист выполнять чертежным шрифтом по ГОСТ 2.304 одним цветом на листе формата А4 с рамкой.

3.2 Пример оформления титульного листа приведен в Приложении А.

4 Задание на курсовую или дипломную работу

4.1Задание оформляется на типографском бланке и выдается кафедрой. При отсутствии бланка допускается оформлять задание рукописным способом на листах формата А4.

4.2Пример оформления приведен в Приложении Б.

5 Реферат (как составная часть документа)

5.1 Реферат является структурным элементом следующих докумен-

тов:

1)дипломного проекта (работы);

2)курсового проекта (работы);

3)отчета по учебно-исследовательской работе.

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

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

2)сведения о графической части проекта (работы) – количество листов, формат листов;

3)перечень ключевых слов;

4)текст реферата.

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

5.4В тексте реферата должна быть отражена сущность выполненной работы (объект разработки или исследования, цель работы, методы исследования, полученные результаты, область применения, экономический эффект или значимость работы).

5.5Пример оформления реферата приведен в Приложении В.

6 Содержание

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

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

6.3Слово «Содержание» помещают в виде заголовка (в центре, симметрично тексту) с прописной буквы. Наименования, включенные в со-

4

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

7 Введение

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

8 Основная часть

8.1Содержание основной части документа определяет кафедра, выдавшая учебное задание.

8.2Основную часть излагают в виде текста или сочетания текста, иллюстраций и таблиц.

8.3Текст основной части документа (при необходимости) разделяют на разделы и подразделы.

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

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

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

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

а) _ _ _ _ _

в) _ _ _ _ _

1)_ _ _ _ _

2)_ _ _ _ _

8.5Разделы и подразделы должны иметь заголовки. Пункты, как правило, заголовков не имеют.

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

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

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

5

8.7 Оформление иллюстраций.

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

8.7.2Иллюстрации следует нумеровать арабскими цифрами сквозной нумерации. Если рисунок один, то он обозначается «Рисунок 1».

8.7.3Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: Рисунок А.3.

8.7.4Допускается нумеровать иллюстрации в пределах раздела. Например: Рисунок 1.1.

8.7.5Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом:

Рисунок 1 – Пример оформления рисунка

8.8 Построение таблиц 8.8.1 Размеры таблиц выбирают произвольно, в зависимости от из-

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

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

6

Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы в пределах данного раздела, разделенных точкой. Например: «Таблица

2.1».

8.8.2Слово «Таблица» пишут слева над таблицей, указывают порядковый номер, ставят тире и затем указывают название. Заголовки и подзаголовки таблиц начинают с прописных букв. В конце заголовков и подзаголовков таблиц знаки препинания не ставят. Например: «Таблица 3 – Значение коэффициента γf».

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

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

8.8.4Пример построения таблиц приведен на иллюстрации:

Таблица 5.4 – Подсчет нагрузок на ферму покрытия одноэтажного промышленного здания

8.9 Оформление формул 8.9.1 В формулах в качестве символов следует применять обозначе-

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

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

γ=1,7 - коэффициент, учитывающий неупругие деформации бетона растянутой зоны;

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

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

– (1).

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

8.9.3Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенные точкой. Например: формула (3.1).

8.9.4Ссылки в тексте на порядковые номера формул дают в скобках. Например: … в формуле (1).

8.10 Ссылки.

8.10.1Ссылки на источники указывают порядковыми номерами по списку источников, выделенными в тексте двумя косыми чертами.

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

8.10.3Разрешается давать ссылки на стандарты (кроме стандартов предприятий), конструкторские документы и другие (например, органы государственного надзора). Ссылка делается на весь документ в целом или на его разделы и приложения.

8

9 Заключение

9.1 Заключение содержит краткие выводы и оценку полученных результатов.

10 Список использованных источников

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

Перечень литературы пишут через два интервала.

11 Приложение

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

11.2Приложения оформляют как продолжение документа на последующих его листах. В тексте документа на все приложения должны быть даны ссылки.

11.3Каждое приложение следует начинать с новой страницы с указанием наверху по середине страницы слова «Приложение». Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность. Если в документе одно приложение, оно обозначается «Приложение А».

11.4Приложения, как правило, выполняют на листах формата А4. Допускается также использовать листы формата А3, А4х4, А2 и А1 по ГОСТ 2.301.

11.5Текст каждого приложения, при необходимости, может быть разделен на разделы, подразделы, пункты, подпункты, которые нумеруют

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

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

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

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

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

Допускается использовать повествовательную форму изложения текста, например: «применяют», «указывают» и т.д.

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

9

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

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

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

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

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

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

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

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

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

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

-применять знак «Ø»; -применять без числовых значений математические знаки, например:

>(больше), < (меньше), = (равно), ≥ (больше или равно), ≤ (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент);

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

12.4Наименование команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например: «Сигнал +27 включено».

12.5Перечень допускаемых сокращений слов установлен ГОСТ 2.316 и приведен в приложении Е. Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень принятых сокращений, который помещают в конце документа перед перечнем терминов.

12.6Условные буквенные обозначения, изображения или знаки должны соответствовать принятым в действующем законодательстве и государственных стандартах. В тексте документа, перед обозначением параметра дают его пояснение, например: «Начальный модуль упругости бетона Еb». При необходимости применения условных обозначений, изображений или знаков, не установленных соответствующими стандартами, их следует пояснять в тексте или в перечне обозначений.

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

10