В тексте документа на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте документа. Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова приложение и его обозначения.
После слова приложение следует буква, обозначающая его последовательность. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Е, 3, Й, 0, Ч, Ь, Ы, Ъ. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и O. В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами. Если в документе одно приложение, то оно обозначается одним словом приложение.
Приложение должно иметь содержательный заголовок, который записывают над текстом приложения симметрично относительно текста с прописной буквы отдельной строкой. Ссылка на каждое приложение обязательно должна присутствовать в тексте пояснительной записки, а в содержании указывают все приложения. Заголовок приложения выносится в содержание.
При ссылке на приложение в тексте пояснительной записки пишут слово приложение полностью строчными буквами и указывают его обозначение, например: «… в приложении А приведен расчет характеристик фильтра».
При большом объеме приложение выпускается в виде отдельного тома с самостоятельной нумерацией страниц и оформляется по правилам, принятым для данного типа документа, например программной документации.
Спецификацию составляют на каждый сборочный чертеж согласно
ГОСТ 2.108. Спецификацию выполняют на отдельных листах формата А4 и размещают в конце пояснительной записки как приложение. При малом
объеме спецификации допускается ее совмещение со сборочным чертежом.
Спецификация является видом конструкторского документа, который определяет состав сборочной единицы, комплекса, комплекта и, к примеру, содержит перечень элементов принципиальной электрической схемы.
Перечень представляет собой таблицу, в которой должны быть перечислены все элементы, входящие в состав изделия и изображенные на схеме, с указанием (по стандарту) их наименований, обозначений и характеристик параметров.
Связь элементов, указанных в спецификации, с элементами принципиальной схемы осуществляется через их буквенно-цифровые обозначения. Запись элементов в спецификации производится группами в алфавитном порядке позиционных обозначений (ГОСТ 2.710).
Однотипные элементы, имеющие последовательные порядковые номера, допускается записывать в одну строку с указанием в соответствующей графе их количества. Основные правила оформления спецификации устанавливаются в ГОСТ 2.108 и ГОСТ 2.109. Примеры оформления спецификаций можно найти в работах [1-3].
Программные документы, разработанные в дипломных проектах, оформляют в соответствии с требованиями стандартов Единой системы программной документации (ЕСПД). К программным документам относятся документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программ:
· текст программы (запись программы с необходимыми комментариями) согласно ГОСТ 19.401;
· описание программы (сведения о логической структуре и функционировании программы) согласно ГОСТ 19.402;
· описание применения программы (сведения о назначении, области применения программы, используемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств) согласно ГОСТ 19.502;
· руководство программиста согласно ГОСТ 19.504.
Программный документ состоит из трех условных частей: титульной, информационной, основной. Каждая часть может быть представлена на различных типах носителей, в частности на дискетах. При этом в перечне документов дипломного проекта необходимо указать наименование программного документа, его объем и тип носителя. Ниже приводится краткое содержание программных документов в соответствии с требованиями ЕСПД.
Текст программы является обязательным для программы-компонента, выполняющей законченную функцию и применяемой самостоятельно, и необязательным для программы–комплекса (ГОСТ 19.101).
Основная часть составляется из текстов одного или нескольких разделов. Каждый из разделов реализуется одним из типов символической записи на исходном языке, куда необходимо включать комментарии, отражающие функциональное назначение.
Описание программы должно состоять из следующих разделов.
1. Общие сведения (назначение и наименование программы, программное обеспечение, необходимое для функционирования программы, языки программирования).
2. Функциональное назначение (классы решаемых задач и сведения о функциональных ограничениях на применение).
3. Описание логической структуры (алгоритм программы, используемые методы, структура программы с описанием функций составных частей и связи между ними, связи с другими программами).
4. Используемые технические устройства (типы ЭВМ и устройств, которые необходимы для работы программы).
5. Вызов и загрузка (способ вызова программы с носителя данных, входные точки в программу).
6. Входные данные (характер, организация и предварительная подготовка входных данных, формат, описание и способ их кодирования).
7. Выходные данные (характер и организация выходных данных, описание и способ их кодирования).
Описание применения программы включает следующие разделы.
1. Назначение программы (назначение, возможности программы, ее основные характеристики, ограничения на область применения).
2. Условия применения (требования к необходимым техническим средствам и другим программам, общие характеристики входной и выходной информации).
3. Описание задачи и методы ее решения.
4. Входные и выходные данные.
Руководство программиста согласно ГОСТ 19.504 должно содержать следующие разделы.
1. Назначение и условия применения программы (назначения и функции, выполняемые программой, условия, необходимые для функционирования программы: объем оперативной памяти, требования к составу и параметрам периферийных устройств, к программному обеспечению).
2. Характеристики программы (временные характеристики, режим работы, средства контроля правильности выполнения программы).
3. Обращение к программе (описание процедур вызова программы).
4. Входные и выходные данные (описание организации входной и выходной информации).
5. Сообщения (тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям).
2.3 Оформление графических документов проекта
К графическим документам дипломного проекта относятся чертежи, схемы, таблицы, графики, диаграммы, формулы, предназначенные для использования в качестве наглядных пособий для защиты дипломного проекта.
Содержание графической части дипломного проекта зависит от темы проекта и четко определяется заданием на дипломное проектирование. Необходимо подчеркнуть, что на листы графической документации дипломного проекта выносится только тот материал, который содержится в пояснительной записке. Исключение может составлять полная принципиальная схема. При этом в тексте пояснительной записки обязательно должны содержаться принципиальные электрические схемы рассчитываемых каскадов. Нумерация элементов принципиальной схемы в пояснительной записке должна совпадать с нумерацией элементов на соответствующем листе.
Общие правила выполнения чертежей регламентируются стандартами третьей группы ЕСКД (ГОСТ 2.301 – ГОСТ 3.317). Все чертежи выполняются в масштабах по ГОСТ 2.302 на листах ватмана форматов А1 или А0 (допускается А2) карандашом, или черной тушью, или с применением печатающих устройств (плоттеров и принтеров).
Схемы выполняют в соответствии с ГОСТ 2.701. Схемы в зависимости от видов элементов и связей, входящих в состав изделия, подразделяют на виды, а в зависимости от основного назначения – на типы. Существуют следующие типы схем:
· структурная схема — схема, определяющая основные функциональные части изделия, разрабатывается для общего ознакомления с изделием;
· функциональная схема — схема, разъясняющая определенные процессы, которые протекают в отдельных цепях установки;
· принципиальная схема — схема, определяющая полный состав элементов и связей между ними и дающая представление о принципах работы устройства;
· схема соединений (монтажная) — схема, показывающая соединения составляющих частей установки и определяющая провода, жгуты проводов, кабелей, которыми осуществляются соединения;
· схема подключения — схема, показывающая внешнее подключение установки к внешним цепям при ее эксплуатации;
· общая схема — схема, определяющая составные части комплекса и соединения их между собой на месте эксплуатации;
· схема расположения — схема, определяющая относительное расположение составных частей устройства, а при необходимости расположение проводов, жгутов, кабелей и т. п.
Виды схем обозначают буквами: электрическая (Э), гидравлическая (Г), пневматическая (П), кинематическая (К), вакуумная (В), энергетическая (Р).
Тип схемы обозначают арабскими цифрами: структурная (1), функциональная (2), принципиальная (3), соединения (4), подключения (5), общая (6), расположения (7), объединенная (0).