Общие требования к оформлению иллюстраций
Для пояснения текста и большей наглядности материала в пояснительной записке следует использовать иллюстрации: рисунки, фотоснимки, схемы, чертежи, диаграммы, документы, полученные с применением печатающих и графических устройств и т.п. Иллюстрации могут быть черно-белыми и цветными. Иллюстрации размером меньше формата А4 должны быть наклеены на стандартные листы белой бумаги.
Необходимо подчеркнуть, что пояснительная записка обязательно должна содержать весь тот материал, который выносится на листы графической документации, предназначенные для защиты проекта. Иллюстрации следует располагать непосредственно после текста, в котором они упоминаются впервые, или на следующей странице, или выносить в приложение.
Все иллюстрации в тексте пояснительной записки называются рисунками и нумеруются в пределах каждого раздела по типу: Рисунок 2.1 (первый рисунок второго раздела). Иллюстрации каждого приложения обозначают отдельной нумерацией (сквозной по приложению): арабскими цифрами с добавлением перед цифрой обозначения приложения, например, «рисунок А.3» третий рисунок приложения А.
На все иллюстрации должны быть даны ссылки в тексте. При ссылках на иллюстрации следует писать “... в соответствии с рисунком 2” при сквозной нумерации по документу и “... в соответствии с рисунком 1.2” при нумерации в пределах раздела. Ссылки на ранее упомянутые иллюстрации даются с сокращенным словом "смотри", например, "см. рисунок 2.1".
Рисунки выполняются непосредственно на листах пояснительной записки либо на листах кальки, чертежной или миллиметровой бумаги формата А4 (А3). Чертежи и схемы, оформленные рамкой и основной надписью, должны складываться "гармоникой" к формату А4 с присвоением им порядковых номеров (листов текста и рисунков).
На рисунках должна быть только та информация, которая помогает при чтении текста уяснить суть излагаемого вопроса. Рисунки помещаются так, чтобы их можно было рассматривать без поворота пояснительной записки (либо с поворотом пояснительной записки на 90° по часовой стрелке).
Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово “Рисунок” и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 — Функциональная схема прибора.
Слово “рисунок” и его наименование располагают посередине строки. Наименование рисунка, поясняющие сведения и номер выполняется тем же способом, каким выполнен текст записки. В приложении И в качестве примера приведён фрагмент текста с рисунком.
Оформление диаграмм
Для наглядного представления функциональных зависимостей двух или более переменных величин рекомендуется использовать иллюстрации диаграммы различных типов (ГОСТ 2.319): в прямоугольных и полярных координатах, столбиковые, секторные, шкалы которых могут быть равномерными, полу- или логарифмическими.
Широко применяются диаграммы в прямоугольных координатах, на которых ярко выражена кривая, отображающая общую зависимость функции от аргумента. Основные правила выполнения диаграмм установлены в рекомендациях Р 50-77-88 "ЕСКД. Правила выполнения диаграмм".
Оси координат. Значения величин, связанных изображаемой функциональной зависимостью, указываются на осях координат в виде шкал. Качественное изображение зависимостей выполняется без шкал, при этом оси координат заканчиваются стрелками, указывающими направление возрастания значений величин. В прямоугольной системе координат независимая переменная откладывается по оси абсцисс.
Положительные значения величин, как правило, откладываются вверх и вправо от точки начала отсчета. В полярной системе координат начало отсчета углов должно находиться на горизонтальной или вертикальной оси, положительное направление углов соответствует направлению вращения против часовой стрелки.
При выполнении диаграмм в пространственной прямоугольной системе координат функциональные зависимости изображаются в аксонометрической проекции по ГОСТ 2.317 "ЕСКД. Аксонометрические проекции".
Масштабы, шкалы и координатная сетка. Значения величин откладываются на осях координат в линейном или нелинейном (например, логарифмическом) масштабах изображения. Масштаб изображения для каждого направления координат может быть разным. В качестве шкалы используется координатная ось или линия координатной сетки, которая ограничивает поле диаграммы. При этом координатные оси разделяются на графические интервалы одним из способов: координатной сеткой, делительными штрихами или сочетанием сетки и штрихов.
Рядом с делениями сетки или делительными штрихами, соответствующими началу и концу шкалы, должны быть указаны значения величин. Нуль следует указывать один раз у точки пересечения шкал, если он является началом отсчета шкал. Числа у шкал размещаются вне поля диаграммы и располагаются горизонтально. При необходимости допускается наносить их у шкал внутри поля диаграммы. Частота нанесения числовых значений выбирается с учетом удобства пользования диаграммой.
Линии и точки. Диаграммы выполняются линиями по ГОСТ 2.303. Оси координат, оси шкал, ограничивающие поле диаграммы, выполняются сплошными основными линиями, линии координатной сетки и делительные штрихи - тонкой линией. При изображении на диаграмме нескольких зависимостей применяются линии различной толщины и различных типов. Пересечение надписей и линий не допускается.
Следует обратить особое внимание на то, что точки, полученные расчетным путем или экспериментально, обозначаются графически кружком, крестиком и т.п. и поясняются в тексте.
Обозначение величин и нанесение единиц измерения. Переменные величины указываются наименованием или символом и размещаются у середины шкалы с ее внешней стороны, а при сочетании символа с единицей измерения надпись размещается в конце шкалы после последнего числа в виде дроби (символ/ед. измерения) либо в виде: символ, единица измерения. Единицы измерения величин приводятся в Международной системе (СИ).
Приложения
Приложение оформляют как продолжение пояснительной записки на последующих его листах или выпускают в виде самостоятельного документа.
В тексте документа на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте документа, за исключением справочного приложения “Библиография”, которое располагают последним. Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова “Приложение”, его обозначения и степени.
Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 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. Входные и выходные данные.
Руководство программиста. В этом документе составление информационной части (аннотации, содержания) является обязательным. Документ должен содержать в своей основной части следующие разделы:
1. Назначение и условия применения программы (назначения и функции, выполняемые программой, условия, необходимые для функционирования программы: объем оперативной памяти, требования к составу и параметрам периферийных устройств, к программному обеспечению).
2. Характеристики программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы).
3. Обращение к программе (описание процедур вызова программы).
4. Входные и выходные данные (описание организации входной и выходной информации).
5. Сообщения (тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям).