Расчетно-пояснительная записка.
Правила оформления.
Оформление расчетно-пояснительной записки осуществляется в соответствии с ГОСТ 7.32-2001 ЕСКД.
Записка должна быть представлена на электронном носителе и в печатной форме на одной стороне белой бумаги формата А4.
Основные правила.
1.1 Пояснительная записка (далее - ПЗ) оформляется в текстовом редакторе и предоставляется на проверку в формате .doc (MS Office 2003).
1.2 Перед сдачей на проверку следует самостоятельно проверить ПЗ на соответствие приведенным правилам в редакторе Microsoft Office Word или Open Office Writer.
1.3 Ориентация страниц: книжная.
1.4 Поля документа:
· Верхнее – не менее 2 см;
· Нижнее – не менее 2 см;
· Левое – не менее 3,5 см;
· Правое – не менее 1 см.
1.5 Соблюдение полей обязательно при размещении любых иллюстраций, таблиц, формул и их подписей.
1.6 Каждый новый раздел начинается с новой страницы.
1.7 Разрывы текста внутри раздела не допускаются (не должно быть «лишних» пробелов и пустых абзацев, за исключением оговоренных ситуаций).
1.8 Горизонтальное выравнивание:
· Основной текст выравнивается по ширине;
· Все заголовки и подписи к рисункам выравниваются по центру;
· Иллюстрации, таблицы и формулы выравнивают по центру страницы.
1.9 После заголовка раздела или подраздела должен идти текст. Текст раздела не может начинаться с формулы, рисунка, таблицы и т.д.
1.10 Сокращения слов, кроме разрешенных ГОСТ 2.316-2008 ЕСКД и общепринятых (например, ТУ, ТЗ, ОЗУ, ПЗУ, АЛУ и др.) не допускаются. При необходимости сокращенного обозначения сигналов или шин следует привести описок сокращений.
Параметры шрифта.
2.1 Используемый шрифт – Times New Roman.
2.2 Размеры шрифта:
· Для основного текста ПЗ – 14;
· Заголовки первого уровня – 16 полужирный (bold);
· Заголовки второго и ниже уровней – 14 полужирный (bold);
· Подписи к рисункам и таблицам – 10;
· Номера страниц - 12.
2.3 Отступ первой строки абзаца – 1,25 см.
2.4 Интервал между строками – 1,5.
2.5 Интервалы перед и после абзацев – 0 пт.
2.6 Тип и размер шрифта внутри рисунков может быть любым. Для листингов рекомендуется использовать шрифт Courier New, размер 10.
2.7 Размер шрифта в таблицах и междустрочный интервал можно уменьшать.
Заголовки.
3.1 Заголовки подразделов разделяют от предыдущего текста (или заголовка раздела) пустой строкой.
3.2 Заголовки разделов и подразделов пишут с абзаца строчными буквами (кроме первой прописной).
3.3 Абзацного отступа у заголовков быть не должно.
3.4 Точку в конце заголовка не ставят.
3.5 Использование подчеркиваний в заголовке не допускается.
3.6 Заголовок должен содержать текст на русском языке. Он не должен состоять только из аббревиатур и иностранных слов/терминов. Например, нельзя писать название заголовка «1.1 P-CAD». Следует писать «1.1 Система автоматизированного проектирования P-CAD».
3.7 Рекомендуется использование мягкого переноса строки (Shift+Enter) в случае, если длина заголовка такова, что он не умещается в одной строке и первая строка гораздо длиннее второй.
Нумерация
4.1 Пояснительная записка компонуется следующим образом:
Титульный лист
Задание на дипломный проект
Содержание
Введение
1. Название раздела
…
X-1. Раздел информационной безопасности
Х. Экономический раздел
Заключение
Список литературы
Приложение А
…
Таким образом, нумеруются только содержательные разделы диплома после введения и до заключения.
4.2 Страницы пояснительной записки нумеруют арабскими цифрами, начиная с третьей страницы (после задания на дипломный проект, вне зависимости от объема задания). Третья страница – начало содержания.
4.3 Номер страницы проставляют в центре нижней части листа по центру, без точки.
4.4 Все заголовки должны иметь номер (раздела или подраздела).
4.5 Все рисунки, таблицы и формулы нумеруются в пределах раздела (номер подраздела не учитывается).
Иллюстрации.
5.1 Иллюстрации (чертежи, графики, схемы, распечатки листингов, диаграммы, фотоснимки) следует располагать в пояснительной записке непосредственно после текста, в котором они упоминаются впервые, или на следующей странице.
5.2 Исходные коды программ оформляются как рисунки, внутри которых не учитываются правила оформления основного текста ПЗ.
5.3 Крупные листинги (более чем на 2 страницы) переносят в приложения.
5.4 Не допускается оставлять пустое место в конце страницы в случае, если рисунок не умещается. Необходимо продолжать текст, а рисунок в таком случае переносится на следующую страницу.
5.5 На все иллюстрации должны быть даны ссылки в тексте.
5.6 Чертежи, графики, диаграммы, схемы, иллюстрации, помещаемые в отчете, должны соответствовать требованиям государственных стандартов Единой системы конструкторской документации (ЕСКД).
5.7 Иллюстрации, за исключением иллюстрации приложений, следует нумеровать арабскими цифрами сквозной нумерацией в пределах раздела. Номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например:
Рисунок 1.1.
5.8 Иллюстрации должны иметь наименование (подрисуночный текст). Слово “Рисунок” и наименование располагают следующим образом:
Рисунок 1.1 — Детали прибора.
5.9 Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например, Рисунок А.3.
5.10 При ссылках на иллюстрации следует писать “... в соответствии с рисунком 1.2”.
5.11 Перед рисунком и после подписи должна быть одна пустая строка.
5.12 Слово «рисунок» сокращать нельзя.
5.13 Иллюстрации располагаются в тексте так, чтобы их можно было читать без поворота записки или с поворотом по часовой стрелке на 90°.
5.14 В случае вертикального расположения рисунка подпись также располагается вертикально, номер страницы остается на месте – внизу страницы.
Таблицы.
6.1 Каждая таблица должна иметь заголовок, который помещается над текстом самой таблицы по центру, а над таблицей справа - надпись «Таблица» с указанием ее номера.
6.2 Номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой.
6.3 Заголовок и слово «Таблица» начинаются с заглавной буквы.
6.4 Перед заголовком таблицы и после нее вставляется пустая строка.
6.5 Заголовки полей таблицы выравнивают по центру.
6.6 Таблицу с большим количеством строк допускается переносить на другой лист.
6.7 При переносе таблицы на другой лист заголовок помещают только над ее первой частью. Над всеми остальными частями справа помещается надпись «Таблица» с указанием ее номера и в круглых скобках пишется слово «продолжение».
6.8 При переносе таблицы под строкой заголовков полей указываются их номера (1, 2, …). На других страницах вместо заголовков указываются номера полей.
6.9 Таблицу с большим количеством граф допускается делить на части и помещать одну часть под другой в пределах одной страницы.
6.10 Пример оформления таблицы приведен в приложении 3.
Формулы.
7.1 Нумерацию формул проводят последовательно в пределах раздела арабскими цифрами.
7.2 Использование формул (расчеты) можно не нумеровать. В таком случае оформлять как основной текст ПЗ.
7.3 Номер формулы должен состоять из номера раздела и порядкового номера формулы, разделенных точкой.
7.4 Номер расчетной формулы, на которую есть ссылка в тексте, помещается в круглых скобках у правого поля страницы на строке самой формулы.
7.5 Выше и ниже каждой формулы или уравнения должна быть оставлена одна свободная строка.
7.6 Если уравнение не умещается в одну строку, то оно должно быть перенесено после знака равенства (=) или после знаков плюс (+), минус (-), или других математических знаков, причем знак в начале следующей строки повторяют.
7.7 При переносе формулы на знаке, символизирующем операцию умножения, применяют знак “Х”.
7.8 Пояснение значений символов и числовых коэффициентов следует приводить непосредственно под формулой в той же последовательности, в которой они даны в формуле.
7.9 Пояснения оформляются как основной текст ПЗ.
7.10 Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (В.1).
7.11 Ссылки в тексте на порядковые номера формул дают в скобках. Пример: "... в формуле (1)".
Список литературы.
8.1 Ссылка на литературный источник в тексте оформляется в виде его порядкового номера по библиографическому списку, выделенного квадратными скобками. Например: «[5]» (книга, статья и т.д., имеющая порядковый номер 5 в «Списке литературы»).
8.2 Список литературы формируется в порядке появления ссылок на источники в тексте. Работы и нумеруется арабскими цифрами с точкой, например,
1. Никонов О.И. Методическое указание ..
8.3 Примеры библиографического описания литературных источников (ГОСТ 7.1—84) приведены в приложении.
Содержание.
9.1 Содержание включает наименование всех разделов и подразделов с указанием номеров страниц, на которых размещается начало материала разделов (подразделов, пунктов).
9.2 В «Содержание» включают также все приложения (если они имеются) с указанием их номеров и заголовков.
9.3 Номера страниц указываются у правого поля страницы. Между пунктом содержания и его номером ставятся точки. Пример оформления содержания приведен в приложении к данным правилам.
Приложения.
10.1 Приложения располагают в порядке ссылок на них в тексте документа.
10.2 Заголовки приложений оформляют как заголовки разделов.
10.3 Заголовок приложения состоит из слова «Приложение» и заглавной буквы русского алфавита, обозначающей его очередность, начиная с А, за исключением букв Ё, 3, Й, 0, Ч, Ь, Ы, Ъ.
10.4 После порядковой буквы в заголовке через точку указывается название приложения без точки в конце. Например:
Приложение А. Листинг исходного кода программы
10.5 В случае полного использования букв русского алфавита допускается обозначать приложения арабскими цифрами.
10.6 Если в документе одно приложение, оно обозначается “Приложение А”.
10.7 Текст приложения может иметь форматирование, отличное от форматирования основного текста ПЗ (например, для листингов рекомендуется использовать шрифт Courier New, размер – 10, междустрочный интервал – 1).
Расчетно-пояснительная записка должна быть переплетена в твердую папку. Первой страницей записки является титульный лист (прил. 1). Вслед за титульным листом помещается задание на дипломный проект (прил. 2).
Во введении должна быть приведена оценка современного уровня того вида аппаратных и программных средств, которые могут быть использованы для решения поставленной задачи; показана актуальность и необходимость новой разработки и экономический выигрыш, который может быть получен. Именно в этом разделе дипломник должен показать, как и насколько конкретная разработка отвечает задачам развития вычислительной техники. Объем введения — не более 10 страниц.
В первой главе конкретизируется техническое задание на дипломный проект, уточняются эксплуатационные характеристики и различные требования. Рассматриваются аналогичные системы, если они есть, с определением их недостатков и указанием необходимости данной разработки, определяются направления разработки.
Последующие разделы содержат материалы, посвященные необходимости выбора средств реализации проекта, структурные функциональные, логические и принципиальные схемы и алгоритмы, описывающие функционирование системы и взаимодействие ее элементов.
При необходимости должны быть приведены расчеты, подтверждающие правильность функционирования устройства (синтез и анализ схем, выбор синхронизации, временные расчеты, подтверждающие соответствие спроектированного устройства требованиям технического задания); конструктивные расчеты (компоновка устройства, размещение элементов, расчет теплового режима, паразитных электромагнитных связей, оценка надежности и др.).
В этих разделах приводятся результаты моделирования, использования САПР, пакетов прикладных программ.
В общем случае данный материал, должен составлять не менее половины объема расчетно-пояснительной записки. Разумеется, сюда относятся расчеты всех разделов.
В заключении делаются краткие выводы по результатам проектирования с указанием соответствия технических характеристик спроектированного устройства заданным в техническом задании. Объем заключения — не более 2—3 страниц.
Графическая часть проекта
На защите проекта дипломник делает доклад по слайдам презентации, которые являются иллюстративной частью дипломного проекта. Таких слайдов должно быть не менее десяти.
Слайды дублируют частично или полностью графический материал, приведенный в пояснительной записке: структурные, функциональные и принципиальные электрические схемы, временные диаграммы, блок-схемы алгоритмов и т.п.
Это требование должно является обязательным, так как содержание расчетно-пояснительной записки должно быть завершенным и понятным и без демонстрационных слайдов.
Содержание демонстрационных слайдов и их последовательность при защите проекта должны соответствовать порядку изложения материала, помогать докладчику в представлении своей работы, а комиссии в ее объективной оценке.
Графическая часть проекта является технической и эксплуатационной документацией. Она по своему формату, условным обозначениям, шрифтам и масштабам должна соответствовать требованиям ГОСТ, ЕСКД и ЕСПД.
Чертежи могут выполняться карандашом, черной тушью или на плоттере, но при этом все чертежи дипломного проекта должны выполняться однотипно: или карандашом, илитушью или на плоттере.
При оформлении структурных, функциональных и принципиальных схем следует уделить особое внимание выбору масштаба изображения и добиться, с одной стороны, хорошей заполняемости листа, а с другой стороны - удовлетворительной читаемости схемы. В случае необходимости два или четыре листа формата А1 могут составлять один чертеж.
В проектах, ориентированных на разработку аппаратно-программного комплекса изделия, состав графического материала может быть видоизменен по согласованию с руководителем проекта за счет введения структурных схем программного обеспечения, реализуемых программами алгоритмов, результатов моделирования и тестирования программ.
В иллюстративном материале по конструкторской части проекта следует показать разрабатываемую конструкцию устройства (электрическую принципиальную схему устройства с перечнем элементов, разводку печатных плат, сборочный чертеж, общий вид, компоновку из отдельных блоков). При работе над конструкцией устройства следует уделить внимание и эргономическим вопросам, а также вопросам контроля и наладки устройства.
Все сборочные чертежи должны иметь спецификации, выполненные на отдельных листах формат А4 согласно ГОСТ 2.106-96. Листы спецификации должны быть подшиты в конце расчетно-пояснительной записки.
На листах должны быть подписи студента, консультантов и руководителя с указанием дат.