 |
Требования к оформлению текстовых документов
|
|
|
|
Методические рекомендации
По выполнению и оформлению
Курсовых и дипломных проектов
Курган 2013
Правила оформления расчетно-пояснительной записки
Пояснительная записка (ПЗ) является конструкторским документом и должна соответствовать требованиям Единой системы конструкторской документации (ЕСКД).
Структура ПЗ должна соответствовать ГОСТ 2.106-96 «Единая система конструкторской документации. Текстовые документы» оформление по ГОСТ 2.105-95 «Единая система конструкторской документации. Общие требования к текстовым документам».
Первой страницей считается титульный лист, второй — лист задания. Эти страницы выполняются на особых формах. Остальной текст оформляется по обычной форме, пример приведён а приложении Б
Структура пояснительной записки
ПЗ к курсовому и дипломному проекту должна состоять из следующих разделов:
- титульный лист;
- содержание;
- введение;
- основная часть;
- заключение;
- список использованных источников;
- приложения.
Титульный лист является первой страницей ПЗ к проекту и служит источником информации, необходимой для обработки и поиска документа. На титульном листе приводятся следующие сведения:
- наименование образовательного учреждения;
- наименование работы;
- фамилия и инициалы исполнителя, руководителя курсового (дипломного) проекта;
- место и дата составления ПЗ.
Подписи и даты подписания должны быть выполнены только черными чернилами или тушью. Дата оформляется арабскими цифрами в следующей последовательности: день месяца, месяц, год. День месяца и месяц оформляются двумя парами арабских цифр, разделенными точкой; год – четырьмя арабскими цифрами. Например: 05.04.2013г.
|
|
|
Должности, учёные степени, учёные звания руководителей (если печатается в несколько строк, то печатать через 1 межстрочный интервал), затем оставляют свободное поле для личных подписей и помещают фамилии и инициалы лиц, подписавших проект, в одной строке с подписями проставляют даты подписания.
Если на титульном листе не размещаются все необходимые подписи, то их переносят на дополнительную страницу титульного листа. В верхнем углу дополнительной страницы справа указывают «Продолжение титульного листа», а в конце первой страницы справа указывают «Продолжение на следующем листе».
Пример оформление титульного листа приведен в приложении А.
Содержание помещают в пояснительной записке на первом (не титульном) листе и при необходимости, на последующих листах. Содержание включает введение, наименование всех разделов, подразделов, пунктов (если они имеют наименование), заключение, список использованных источников и наименование приложений с указанием номеров страниц, с которых начинаются эти элементы пояснительной записки. Пример оформления приводится в приложении В
Слово «Содержание» записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы.
Введение должно содержать оценку современного состояния разработки аналогов данного проекта, сведения о планируемом научно-техническом уровне разработки, о патентных исследованиях и выводы из них. Во введении должны быть приведены цели и задачи разработки проекта и приводится перечисление всех документов, на основании которых разработан проект. Рекомендуемый объем введения: для курсового проекта 1,5-2 листа, для дипломного проекта 2-3 листа.
Заключение должно содержать:
- краткие выводы по результатам проектирования в целом или отдельных его этапов;
|
|
|
- оценку полноты решений поставленных задач;
- разработку рекомендаций и исходных данных по конкретному использованию результатов разработки. Рекомендуемый объем заключения: для курсового проекта 1,5-2 листа, для дипломного проекта 2-3 листа.
Список использованных источников, которые были использованы при его составлении, приводится в конце текстового документа и включается в содержание документа. Выполнение списка и ссылки на него в тексте регламентированы ГОСТ 7.32-2001 и ГОСТ 7.1 – 2003.
Приложения
Приложениями могут быть графический материал, таблицы большого формата, расчеты, описания алгоритмов и программ задач, решаемых на ЭВМ и т.д.
При необходимости в приложения следует включать вспомогательный материал, необходимый для полноты работы:
- материалы дополняющие проект;
- таблицы вспомогательных цифровых данных;
- формулы и расчеты;
- иллюстрации вспомогательного характера.
Требования к оформлению текстовых документов
Подлинники текстовых документов выполняют одним из следующих способов:
- машинописным – шрифт должен быть четким, высотой не менее 2,5 мм только черного цвета;
- с применением печатающих и графических устройств вывода ЭВМ (ГОСТ 2.004).
Шрифт - Times New Roman. Размер шрифта – кегль 14 (не менее 12) с одинарным или полуторным интервалом.
Вписывать в текстовые документы, изготовленные машинописным способом, отдельные слова, формулы, условные знаки (рукописным способом), а так же выполнять иллюстрации черными чернилами, пастой или тушью.
Расстояние от рамки формы (по ГОСТ 2.104) до границ текста в начале строк – не менее 5 мм и в конце строк – не менее 3 мм. Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм.
При выполнении работы без рамки по ГОСТ 2.104 необходимо соблюдать следующие размеры полей: правое – не менее 10 мм, верхнее и нижнее – не менее 20 мм, левое – не менее 30 мм.
Абзацы в тексте начинают отступом, равным 1,25 см.
Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графики) машинописным способом или черными чернилами, пастой или тушью рукописным способом.
|
|
|
Вне зависимости от способа выполнения ПЗ качество напечатанного текста и оформления иллюстраций, таблиц, распечаток с ПЭВМ должно удовлетворять требованию их четкого воспроизведения
При выполнении ПЗ необходимо соблюдать равномерную плотность, контрастность и четкость изображения по всей ПЗ. Должны быть четкие, не расплывшиеся линии, буквы, цифры и знаки.
Повреждение листов текстовых документов, помарки и следы не полностью удаленного прежнего текста (графика) не допускается.
Текст должен быть написан грамотно, с соблюдением всех требований русского языка. Язык пояснительной записки должен быть сжатым и точным, свойственным научно-техническим документам. Не следует злоупотреблять описаниями устройств или программного обеспечения, известными из литературы. Достаточно коротко перечислить их существенные особенности и дать библиографическую ссылку. Не должны использоваться жаргонные технические выражения.
Сокращение русских слов и словосочетаний в ПЗ – по ГОСТ 7.12 и ГОСТ 2.316. Допускаемые сокращения приведены в приложении Г.
Построение документа
Текст документа (основной части ПЗ) при необходимости разделяют на разделы, подразделы и пункты.
Нумерация разделов производится арабскими цифрами. Разделы состоят из подразделов. Номер подраздела включает номер раздела и порядковый номер подраздела в разделе, разделенные точкой (например, «2.5» — пятый подраздел второго раздела). Не допускается выделение единственного подраздела в разделе.
Подразделы состоят из пунктов. Номер пункта включает номер раздела, порядковый номер подраздела в разделе и порядковый номер пункта в подразделе, разделенные точками (например, «2.5.3» — третий пункт пятого подраздела второго раздела). Пункты, как правило, названий не имеют. В конце номеров разделов, подразделов и пунктов точка не ставится, например:
«2.2 Разработка структуры базы данных».
Внутри пунктов или подпунктов могут быть приведены перечисления. Содержащиеся в тексте перечисления требований, указаний, положений, оформляются в виде ненумерованных (маркированных) или нумерованных списков.
|
|
|
Отдельные позиции в ненумерованных списках помечаются только знаком дефиса «—». Круглые или квадратные маркеры недопустимы. После номера позиции в нумерованных списках ставится скобка.
Каждая позиция списка записывается с абзацного отступа (отступ маркера — 1,25 см).
При необходимости ссылки в тексте документа на одно из перечислений, перед каждой позицией следует ставить строчную букву, после которой ставится скобка.
Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа. Например,
а) …………….
б) …………….
1) …….
2) …….
в) …………….
Разделы и подразделы должны иметь заголовки. Заголовки следует печатать с прописной буквы (допустимо использование жирного начертания шрифта) и начинать с абзацного отступа. В конце заголовка точка не ставится. Если заголовок состоит из двух предложений, их разделяют точкой. Переносы слов в заголовках не допускаются. Подчеркивание заголовков не допускается.
Между заголовком раздела и текстом (как выше, так и ниже его) должен быть отступ.
Недопустимо, когда заголовок находится в нижней части листа, а текст раздела, подраздела или пункта начинается на следующем листе.
Каждый раздел записки начинается с новой страницы (к разделам приравниваются: введение, заключение, список литературы, приложения).
Каждый подраздел, пункт и перечисления записываются с нового абзаца.
Иллюстрации
Иллюстрации выполняются по центру страницы, и под каждой иллюстрацией снизу ставится слово «Рисунок» и его порядковый номер. Следует обратить внимание на то, что после слова «Рисунок» символ точка не ставится.
Количество рисунков — иллюстраций (схем, эскизов, графиков, чертежей) в пояснительной записке определяется ее содержанием и должно обеспечивать ясность, конкретность и полноту изложения текста.
Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в его конце. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД.
Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией по всей пояснительной записке. Если рисунок один, то он обозначается «Рисунок 1».
Рисунки могут иметь наименования, а при необходимости, также и пояснительные данные (обозначения кривых, условия их получения и т. п.). Если требуется подрисуночная подпись, то она записывается с заглавной буквы, номер и название рисунка разделяются тире. Слово «Рисунок», номер и наименование рисунка помещают посередине строки под рисунком после пояснительных данных. Например, «Рисунок 2 — Логическая схема базы данных».
|
|
|
При ссылках на рисунки следует писать «... в соответствии с рисунком 2» или «см. рисунок 1».
Таблицы
Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Таблицу следует располагать непосредственно после текста, в котором она упоминается впервые, либо на следующей странице. Оформление таблиц в ПЗ по ГОСТ 2.105.
Нумерация таблиц аналогична нумерации рисунков. Номер и название таблицы разделяются через тире. Слово «Таблица», номер и наименование таблицы помещают в одну строку над таблицей слева, без абзацного отступа.
Например, «Таблица 1— Характеристика языков веб-программирования». Основные элементы таблицы приведены на рисунке 1.
Рисунок 1 ‒ Построение таблицы
Для заголовков, подзаголовков и текста таблицы рекомендуется применять шрифт размером 12 пунктов (допускается при необходимости – менее на 1...2 пункта).
Заголовки граф и строк таблицы следует писать с прописной буквы в единственном числе, а подзаголовки граф — со строчной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков точки не ставятся. Заголовки граф, как правило, записывают параллельно строкам таблицы, но допускается и перпендикулярное их расположение.
Таблицы слева, справа и снизу, как правило, ограничивают линиями. Горизонтальные и вертикальные линии, разграничивающие элементы таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей. Головка таблицы должна быть отделена линией от остальной части таблицы. Допускается помещать таблицу вдоль длинной стороны листа.
В заголовках граф таблицы (при необходимости — в подзаголовках) должны быть указаны размерности или единицы физических величин. Значения всех величин приводят в международной системе единиц (СИ) в соответствии с ГОСТ 8.417- 2002. Допускается дополнительно указывать их значения в других системах единиц (в скобках). Например, «мощность, кВт (л.с.)». Основные и дополнительные единицы измерения физических величин приведены в приложении Д.
Если стоки или графы таблицы не умещаются на странице, таблицу делят на части, помещая одну часть под другой или рядом, при этом в каждой части повторяют ее головку и боковик.
При переносе части таблицы на другой лист (страницу) слово «Таблица» с указанием номера и названия таблицы пишут один раз слева над первой частью таблицы; над другими частями справа пишут "Продолжение таблицы" с указанием номера таблицы, например: «Продолжение таблицы 1.2». Следует отметить, что перенос таблицы в основном тексте нежелателен, поскольку затрудняет ее восприятие.
При переносе таблицы в приложениях в правом верхнем углу страницы указывают, например, «Приложение А» и ниже «Продолжение таблицы 2».
Графу "№ п.п." в таблицу включать не следует. При необходимости нумерации показателей, параметров или других данных порядковые номера указывают в боковике таблицы перед их наименованием.
Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте работы имеются ссылки на них, при делении таблицы на части, при переносе части таблицы на следующую страницу.
Если цифровые данные в графах таблицы выражены в различных единицах, то их указывают в заголовке каждой графы. Если все параметры, размещенные в таблице, выражены в одной и той же единице, сокращенное обозначение единицы помещают над таблицей. Например: Таблица 2.3 - Основные фонды, млн. руб. Если данные в какой-либо строке не приводят, то в ней ставят прочерк.
При ссылках на таблицу следует писать «... в соответствии с таблицей 2» или «см. таблицу 1».
Прочие требования к оформлению таблиц — по ГОСТ 2.105. Пример оформления таблиц приведен в приложении Е.
Формулы
Уравнения и формулы следует выделять из текста в отдельную строку, отделяя от остального текста одной свободной строкой выше и ниже.
Формулы, используемые в тексте, могут вписываться с помощью редактора формул при таких геометрических параметрах, чтобы они были удобочитаемы, но в то же время не очень крупными. Следует учитывать, что формула — это равноправный член предложения и при ее написании надо соблюдать правило пунктуации (точка после формулы, если ею завершается предложение, или запятая).
В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами. Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под формулой. Пояснение каждого символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова «где» без двоеточия после него.
Пример — Плотность каждого образца ρ, кг/см³, вычисляют по формуле:
ρ = 
, (1)
где m — масса образца, кг;
V — объем образца, м³.
Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.
Переносить формулы на следующую строку допускается только на знаках выполняемых операций, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак «×».
Если необходимо привести результаты расчетов по формуле, то они записываются обычным текстом без нумерации.
Формулы, за исключением формул, помещаемых в приложении, должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках.
Ссылки в тексте на порядковые номера формул дают в скобках, например, …в формуле (1).
Примечания
Примечания к тексту и таблицам, в которых указывают справочные и поясняющие данные, пишут с прописной буквы с абзаца. Одно примечание не нумеруют. Например:
Примечание ‒ …………..
Если примечаний несколько, то их нумеруют последовательно арабскими цифрами. Например:
Примечания
1............
2............
|
|
|
