Рубрикация пояснительной записки
Основная часть ПЗ разбивается на разделы (главы), подразделы (параграфы), пункты и подпункты. Выделенные рубрики (без указания их типов) нумеруют последовательностью арабских цифр, разделенных точками, например "2.1.3." - третий пункт первого параграфа второй главы.
Допускается до 4 вложений, 5-я рубрикация не нумеруется, а встраивается в текст.
"Аналитический обзор", "Научно-технические разделы" и т. д. нумеруются как разделы (главы).
Заголовки структурных элементов ПЗ ("ТЕХНИЧЕСКОЕ ЗАДАНИЕ", "РЕФЕРАТ",..., "СПИСОК ЛИТЕРАТУРЫ", "ПРИЛОЖЕНИЕ",разделы) рекомендуется выполнять прописными буквами, заголовки подразделов (параграфов), пунктов и подпунктов – строчными (кроме первой прописной); все заголовки пишутся с абзацного отступа. В конце заголовка точку не ставят. Подчеркивать заголовки и переносить слова в заголовках не допускается.
Расстояние между заголовками структурных элементов ПЗ и текстом должно быть больше, чем между строками обычного текста.
В содержании (оглавлении) последовательно перечисляют заголовки всех рубрик и приложений и указывают номера страниц, на которых они помещены. Содержание должно включать все заголовки разделов (глав), подразделов (параграфов), пунктов, имеющиеся в ПЗ, кроме разделов “Техническое задание”, “Реферат” и “Содержание”.
Иллюстрации
Количество иллюстраций ПЗ определяется ее содержанием и должно быть достаточным для того, чтобы придать излагаемому тексту ясность и конкретность.
Все иллюстрации именуются рисунками. Рисунки нумеруются арабскими цифрами, номер рисунка проставляется под рисунком с префиксом “Рисунок “. Нумерация рисунков может быть сквозной (в пределах всей ПЗ): Рисунок 1, Рисунок 2, …либо индексационной (в пределах раздела), т. е. номер рисунка состоит из номера раздела и порядкового номера рисунка в разделе, разделенных точкой (например, Рисунок 2.1).
Рисунки должны размещаться сразу после первой ссылки на них в тексте ПЗ. Ссылки на рисунки в тексте выполняются в свободной форме, например, “…на рисунке 2.1…” “…алгоритм (рисунок 2.3) включает…”; при этом слово “рисунок” не сокращается. Размещать рисунки следует так, чтобы их можно было рассматривать без поворота ПЗ. Если это невозможно, то рисунки располагают так, чтобы для их рассматривания надо было повернуть ПЗ по часовой стрелке на 900. Желательно не размещать рисунок непосредственно перед следующим заголовком.
Каждый рисунок должен сопровождаться содержательным названием, которое размещается после его номера через тире, например “Рисунок 1 – Детали прибора”. На все рисунки должны быть ссылки в тексте.
Рисунки могут быть выполнены черными или цветными непосредственно на листах ПЗ или аккуратно вклеены при выполнении их на кальке или миллиметровке.
Таблицы
Цифровой материал, помещаемый в ПЗ, рекомендуется оформлять в виде таблиц. При этом не допускается диагональное деление элементов таблицы, а также включение граф "№ п/п" – номер по порядку и "Единицы измерения". При необходимости эти сведения указывают в заголовках строк. Заголовки граф таблицы выполняют в единственном числе.
Название таблицы следует помещать над таблицей слева, без абзацного отступа в одну строку с ее номером через тире. Как и рисунки, таблицы нумеруются арабскими цифрами последовательно в пределах всей ПЗ или индексационным способом в пределах раздела, т. е. номер таблицы состоит из номера раздела и порядкового номера таблицы в разделе, разделенных точкой. На следующей строке помещают заголовок таблицы. Ссылки на таблицу в тексте выполняются аналогично ссылкам на рисунки.
Ставить кавычки вместо повторяющихся цифр, знаков, математических символов не допускается. Если цифровые или иные данные в таблице отсутствуют, то в соответствующей строчке ставят прочерк.
Таблицы следует размещать так, чтобы их можно было читать без поворота ПЗ. Если это невозможно, таблицы располагают так, чтобы для их чтения надо было повернуть ПЗ по часовой стрелке на 900. Желательно не размещать таблицу непосредственно перед следующим заголовком.
Формулы
Формулы, на которые имеются ссылки в тексте, нумеруются арабскими цифрами последовательно в пределах всей ПЗ либо индексационным способом в пределах раздела, т. е. номер формулы состоит из номера раздела и порядкового номера формулы в разделе, разделенных точкой. Номер формулы в круглых скобках помещают у правого края той же строки.
Расшифровка буквенных обозначений в формуле должна приводиться непосредственно под формулой после слова "где" (без двоеточия).
Список литературы
Список литературы включает все использованные источники в порядке появления ссылок в тексте ПЗ. Данные о литературных источниках в списке литературы приводят в соответствии с требованиями ГОСТ 7.1, согласно которому при описании книг последовательно указывается фамилия и инициалы (инициалы после фамилии) автора (авторов, если их не более трех), название (заглавие) книги, место издания, издательство, год издания, объем в страницах.
Если авторов больше трех, то их инициалы и фамилии (инициалы до фамилии) приводятся после названия книги (статьи) и символа “/”; если их более четырех, то указываются инициалы и фамилии лишь трех из них, после чего пишется "и др.".
Названия городов "Москва" и "Санкт-Петербург" ("Ленинград") приводятся сокращенно соответственно буквами "М." и "СПб." ("Л."). Приводимые данные разделяются специальными знаками, например: Майоров С.А., Новиков Г.И. Принципы организации цифровых машин. - Л.: Машиностроение, 1974. - 432 с.
При описании статей в периодических изданиях приводят фамилии и инициалы авторов статьи, ее заглавие, наименование издания (журнала, сборника), год выпуска, том или номер издания, номера страниц, на которых помещена статья, например: Гринкевич В.А. Принципы структурной организации унифицированной функционально-элементной базы и средств обработки данных на основе БИС // Приборы и системы управления. - 1978. - № 6. - С. 3-7.
Сведения об отчете о НИР должны включать: заглавие отчета (после заглавия в скобках приводят слово "Отчет"), его шифр, инвентарный номер, полное и сокращенное наименования организации, выпустившей отчет, инициалы и фамилию руководителя НИР, город и год выпуска, количество страниц отчета.
Сведения о проектной и другой технической документации (промышленных каталогах, прейскурантах и других подобных документах) должны включать: заглавие, вид документа, организацию, выпустившую документ, город и год выпуска.
Сведения об информации, опубликованной в компьютерной сети или на компакт-диске, должны быть достаточны для того, чтобы читатель мог самостоятельно найти эту информацию. Обычно должно быть указано авторство (фамилии или название фирмы), название информации (если оно отсутствует явно, то следует привести одним предложением характеристику содержания – т. е. придумать название самостоятельно, чтобы читатель мог сделать вывод о необходимости поиска данного первоисточника) и адрес (в компьютерной сети или филиала фирмы).
При ссылке в тексте на источники информации следует приводить порядковый номер по списку литературы, заключенный в квадратные скобки.
Приложения
Приложения оформляются как продолжение ПЗ на последующих ее листах. Каждое приложение начинают с новой страницы с указанием наверху посередине сираницы слова "Приложение" и его обозначения. Приложения обозначаются русскими заглавными буквами в алфавитном порядке. Каждое приложение должно иметь тематический заголовок, который пишется с заглавной буквы по середине следующей строки. Допускается название приложения оформлять отдельной страницей.
В ссылках перед номерами рубрик, а также перед номерами рисунков и таблиц в приложениях пишется буква его обозначения, например: "Рисунок. А.1.2" – второй рисунок первого раздела приложения А.
Приложения должны иметь общую с остальной частью ПЗ сквозную нумерацию страниц.
ВЫПОЛНЕНИЕ ДОКУМЕНТАЦИИ
Состав документации
Разрабатываемый в дипломном проекте продукт должен сопровождаться соответствующей документацией.
В соответствии с ЕСКД (ГОСТ 2.102) все конструкторские документы (КД) делятся на проектные и рабочие. Документы, выполняемые при дипломном проектировании, как правило, относятся к проектным и соответствуют стадиям:
– технического предложения (литера "П"),
– эскизного проекта (литера "Э"),
– технического проекта (литера "Т"),
– опытного ("О") и серийного ("А") образцов.
Номенклатура КД, выполняемых при дипломном проектировании, обычно ограничивается списком, приведенном в таблице 3.1.
В соответствии с ЕСПД (ГОСТ 19.101) все программные документы (ПД) можно разделить на проектные и эксплуатационные. При дипломном проектировании обычно круг ПД ограничен видами, приведенными в таблицах 3.2 и 3.3.
В число обязательных документов комплекта КД, разрабатываемых в соответствии с уровнем дипломного проекта, кроме пояснительной записки входят схемы (электрические) структурные или функциональные разрабатываемых устройств, схемы принципиальные и чертежи общего вида или сборочные чертежи конструктивных модулей (печатных узлов, блоков, панелей). Кроме того, разрабатываются схемы алгоритмов, программ, данных, ресурсов системы, взаимодействия программ (ГОСТ 19.701). Как правило, выполняется не менее двух чертежей и четырех схем.
Таблица 3.1 – Номенклатура конструкторских документов
| Документ | Код документа |
| 1. Пояснительная записка 2. Чертеж общего вида 3. Сборочный чертеж 4. Спецификация 5. Чертеж детали 6. Схема электрическая структурная 7. Схема электрическая принципиальная 8. Схема электрическая функциональная 9. Схема электрическая соединений 10. Схема электрическая подключения 11. Схема электрическая расположения 12. Схема алгоритма (программы) | ПЗ ВО СБ - - Э1 Э3 Э2 Э4 Э5 Э7 А8 |
Таблица 3.2 – Номенклатура проектных программных документов
| Документ | Код документа |
| 1. Пояснительная записка 2. Спецификация 3. Текст программы 4. Описание программы | - |
Таблица 3.3 – Номенклатура эксплуатационных программных документов
| Эксплуатационный документ | Код документа |
| 1. Описание применения 2. Руководство системного программиста 3. Руководство программиста 4. Руководство оператора |
В случае ДПП в число обязательных ПД кроме пояснительной записки входит текст программы (или ее основной части) объемом примерно 15–20 с., описание программы и один из эксплуатационных документов. В случае большого по объему программирования следует составлять спецификацию. Графический материал оформляется при составлении программных документов как рисунки и не имеет специальных шифров или кодов.
Общий объем разрабатываемых КД 6–8 листов. Кроме этого дополнительно выполняется 4–6 демонстрационных плакатов. Окончательный состав КД определяется руководителем и консультантом по выполнению конструкторско-технологической части и оформлению дипломных проектов и работ.
3.2 Общие требования по выполнению документации
Все документы выполняются на листах стандартного формата (ГОСТ 2.301); чертежи и схемы (кроме схем алгоритмов) должны иметь рамку и основную надпись (штамп), выполняемые в соответствии с ГОСТ 2.104. Пример выполнения основной надписи показан на рисунке. 3.1.
Рисунок 3.1 – Основные надписи
Основные надписи располагают в правом нижнем углу конструкторских документов. На листах формата А4 основные надписи располагаются вдоль короткой стороны листа.
Основную надпись на чертежах и схемах выполняют по форме 1 (рисунок 3.1, а) на первом и заглавном листах, на последующих листах – по форме 2а (рисунок 3.1, б). Дополнительные графы основной надписи допускается не выполнять.
В графах основной надписи (номера граф на рисунке 3.1 заключены в скобки) указывают:
в графе 1 — наименование изделия (детали, сборочной единицы и т. д.) и ниже с новой строки наименование документа (кроме спецификации и чертежа детали). Все наименования приводят в именительном падеже единственного числа, начиная с имени существительного, написанного с прописной буквы;
в графе 2 — обозначение документа по ГОСТ 2.201. Первый элемент обозначения - код организации-разработчика КД. Учебные университеты кода не имеют, и занятую им позицию следует заполнять аббревиатурой ЛЭТИ. Второй элемент обозначения – цифровой код классификационной характеристики изделия, устанавливаемый классификатором ЕСКД; эту позицию следует заполнять шестью крестами. В ДП, как правило, изменяется предпоследний элемент – трехразрядный номер КД, присваиваемый бюро стандартизации предприятия (в учебных КД – порядковый номер в ДП), и последний элемент – код вида документа по ГОСТ 2.102;
в графе 3 — обозначение материала детали; в разработках, выполненных автоматизированным способом (например, в системе PCAD), целесообразно указывать спецификацию соответствующего файла;
в графе 4 — литера документа – литера, присвоенная документации в соответствии с условленной в ТЗ стадией разработки: "П" – техническое предложение, "Э" – эскизный проект, "Т" – технический проект, "О" – опытный образец, "А" – серийный образец;
графы 5 и 6 – масса и масштаб – заполняются, только когда имеют смысл;
в графе 7 – порядковый номер листа (документа на нескольких листах);
в графе 8 – общее количество листов документа (графу можно заполнять только на первом листе);
в графе 9 – сокращенное наименование организации; поскольку ЛЭТИ записывается в графе 2, то в ДП здесь целесообразно указывать номер группы.
Документы, выполненные на ватмане и используемые в докладе при защите проекта (работы), должны быть продублированы в пояснительной записке. При дублировании допускается изменять формат и количество листов документа, сохраняя основное его содержание. Пояснительная записка или отчет должны давать полное представление об объеме проделанной автором работы и ее результатах без обращения к другим документам.
Текстовые документы выполняются чернилами, тушью или пастой (все одинаково) черного или синего цвета. Чертежи и схемы – можно карандашом. Топологические чертежи фрагментов БИС целесообразно выполнять цветными. При выполнении плакатов можно использовать цветную тушь (фломастер).
Во всех документах должны быть использованы стандартные обозначения основных физических величин (ГОСТ 1494) и единиц их измерения (ГОСТ 8.417). Нестандартные, введенные автором обозначения, должны быть расшифрованы.