Оформление программных документов

 

2.1.1 Структура и содержание всех программных документов должны соответствовать требованиям стандартов Единой системы программной документации.

2.1.2 Страницы каждого программного документа, помимо сквозной нумерации всех страниц ПЗ, проставленной в нижнем правом углу листа, должны иметь собственную нумерацию, размещаемую в середине верхней части листа, под которой располагается обозначение документа, выполненное в соответствии с ГОСТ 19.103-77 “ЕСПД. Обозначение программ и программных документов” и ГОСТ 19.101-77 “ЕСПД. Виды программ и программных документов”.

2.1.3 Все программные документы должны иметь титульную часть, состоящую из листа утверждения (ЛУ) и титульного листа (ТЛ), информационную часть, состоящую из аннотации и содержания, и основную часть (в соответствии с ГОСТ 19.105-78 “ЕСПД. Общие требования к программным документам”). Лист утверждения не входит в общее количество листов документа и выполняется, как и титульный лист, в соответствии с ГОСТ 19.104-78 “ЕСПД. Основные надписи” (приложение В).

2.1.4 Текстовая часть программных документов оформляется в соответствии с ГОСТ 19.106-78 “ЕСПД. Требования к программным документам, выполненным печатным способом”.

Необходимо отметить, что оформление иллюстраций и таблиц в программном документе отличается от их оформления в основной части ПЗ.

Название иллюстрации помещают над ней, поясняющие данные - под иллюстрацией, слово “Рис.” с номером иллюстрации (без знака “№”) - ниже поясняющих данных. Если в разделе только одна иллюстрация, то ее не нумеруют и слово “Рис.” не пишут, а в случае размещения ее на нескольких страницах пишут под каждым фрагментом “Лист 1”, “Лист 2” и т.д. Если на нескольких страницах размещается иллюстрация , имеющая номер, то пишут “Рис. (номер), лист 1”, “Рис. (номер), лист 2” и т.д.

Ссылки в тексте на иллюстрацию делают по типу “. . . показано на рис. 3”. При повторной ссылке на ту же иллюстрацию пишут, например, “. . . см. рис.3”.

Название таблицы размещают симметрично над ней. Слово “Таблица” c ее номером (без знака “№”) печатают над названием в правом углу таблицы.

Если в тексте всего одна таблица, то ее не нумеруют и слово “Таблица” не пишут, а помещают только название.

Таблица не должна иметь ограничительные линии слева, справа и снизу.

 

Пример

Таблица 2

Характеристики информационных потоков

 
 


Параметр Диапазон изменения Интервал опроса Датчик

       
   
 
 

 


1. Давление

2. Температура

 

При переносе части таблицы на другой лист в правом углу листа над продолжением таблицы пишут слова “Продолжение табл.“ и указывают номер таблицы (например, Продолжение табл. 2.3). Заголовок таблицы над ее продолжением не помещают.

При ссылках на таблицы слово “таблица” в тексте пишется полностью, если у таблицы нет номера, и – сокращенно, если номер есть (например, “. . . результаты приведены в табл. 1.2”). В повторных ссылках на таблицы следует писать, например, “. . . данные (см. табл. 1.2)”.

 

 

2.2Оформление графического материала

 

2.2.1 Графический материал должен быть представлен на листах формата А1.

2.2.2 На плакаты могут выноситься чертежи проектируемого объекта, маршруты проектирования, результаты проектирования; структурные, функциональные и принципиальные схемы; блок-схемы алгоритмов и программ; основные уравнения, особенности математических методов; особенности пользовательского интерфейса; характеристики тестовых задач и результаты тестирования; синтаксические диаграммы, функциональные модели (IDEF0), информационные модели в виде диаграмм “сущность-связь”; графики и таблицы сравнительной оценки эффективности и т.д.

2.2.3 Графическое оформление чертежей должно выполняться преимущественно компьютерным способом и соответствовать требованиям стандартов ЕСКД и ЕСПД.

2.2.4 Все чертежи выпускной квалификационной работы в форме дипломного проекта и работы-проекта должны быть подписаны студентом-дипломником, руководителем проекта, а также консультантом кафедры инженерного проектирования.

 

 

2.2.5 Иллюстрации могут выполняться в произвольной форме в виде плакатов на листах формата А1, в виде диапозитивов для демонстрации с помощью мультимедийной техники, в виде моделей, опытных образцов, а также допускается визуализация результатов работы с помощью средств ПЭВМ.

2.2.6 На защите выпускной квалификационной работы каждому члену Государственной аттестационной комиссии (ГАК) должен быть представлен раздаточный материал в виде копий чертежей, плакатов и слайдов на листах формата А4 (7-8 комплектов).