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

Программные документы, разработанные в дипломных (курсовых) проектах (работах) различных проблемных областей, должны оформляться в соответствии с требованиями стандартов Единой системы программной документации (ЕСПД).

4.2 Программные документы должны включать:

- текст программы, оформленной согласно ГОСТ 19.401-78;

- описание программы, выполненное по ГОСТ 19.402-78;

- описание применения согласно ГОСТ 19.502-78.

Программный документ «Текст программы» содержит аннотацию и собственно текст программы. В текст программы необходимо включать комментарии, отображающие функциональное назначение программного средства, его структуру и т.п.

Программный документ «Описание программы» состоит из аннотации и основной части. Последняя должна содержать следующие разделы.

Общие сведения - полное наименование программного средства; программное обеспечение, необходимое для его функционирования; языки программирования, на которых написано программное средство.

Функциональное назначение - классы решаемых задач и (или) назначение программного средства и сведения о функциональных ограничениях на применение.

Описание логической структуры - алгоритм программного средства; используемые методы; структура программного средства с описанием функций составных частей и связи между ними; связи программного средства с другими программами. Описание логической структуры выполняют с учетом текста программного средства на исходном языке.

Используемые технические средства - типы ЭВМ и устройств, которые используются при работе программного средства.

Вызов и загрузка - способ вызова программного средства с соответствующего носителя данных; входные точки в программное средство. Допускается указывать адреса загрузки, сведения об используемой оперативной памяти, объем программного средства.

Входные данные - характер, организация и предварительная подготовка входных данных; формат, описание и способ кодирования входных данных.

Выходные данные - характер и организация выходных данных; формат, описание и способ кодирования выходных данных.

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

Программный документ «Описание применения» состоит из аннотации и основной части.

Основная часть должна содержать следующие разделы: назначение программы -назначение программного средства, его возможности; основные характеристики; ограничения, накладываемые на область применения.

Условия применения - условия, необходимые для выполнения программного средства (требования к необходимым для данного программного средства техническим средствам, а также требования к другим входящим в него программам, операционным системам и системам программирования; общие характеристики входной и выходной информации; требования и условия организационного и технологического характера и т.п.

Описание задачи - определение (формулирование) задачи и методы ее решения.

Входные и выходные данные - сведения о входных и выходных данных.

В зависимости от особенностей программного средства допускается вводить дополнительные разделы или объединять отдельные разделы. Например, можно ввести следующие разделы:

Введение - состояние вопроса; литературные источники со ссылками; актуальность решаемой задачи; сравнение с аналогичными программными разработками и т.п.

Общие сведения - обозначение и полное наименование программного средства; используемая (тип) ЭВМ; язык программирования; сведения об используемой операционной системе и системе программирования; носители данных и т.п.

Пример оформления титульного листа дипломной работы (проекта)

МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РЕСПУБЛИКИ САХА (ЯКУТИЯ)

ГОСУДАРСТВЕННОЕ АВТОНОМНОЕ ПРОФЕССИОНАЛЬНОЕ

ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ РЕСПУБЛИКИ САХА (ЯКУТИЯ)

«РЕГИОНАЛЬНЫЙ ТЕХНИЧЕСКИЙ КОЛЛЕДЖ В Г. МИРНОМ»

специальность 18.02.09

«Переработка нефти и газа»

группа ПНиГ-17/9

ДИПЛОМНЫЙ ПРОЕКТ

(пояснительная записка)

Тема работы: «Установка замедленного коксования»

Студент:

^{(подпись) (Фамилия, Имя, Отчество)}

Руководитель работы:

^{(подпись) (Фамилия, Имя, Отчество)}

Мирный 2020

Приложение 2

СОДЕРЖАНИЕ

ВВЕДЕНИЕ	5
1 Установка замедленного коксования	8
1.1 Выбор метода производства	9
1.1.1 Типы установок коксования	13
1.1.2 Кубовый метод коксования	17
1.1.3 Термоконтактный метод коксования	19
1.2 Физико-химические основы процесса	23
1.3 Технологические схемы и режим работы коксования	25
1.3.1 Установка замедленного коксования	27
2 Расчет основного вспомогательного аппаратов установки замедленного коксования	32
2.1 Расчет коксовой камеры	33
2.1.1 Материальный баланс	34
2.1.2 Расчет теплового баланса	38
2.1.3 Конструктивный расчет	42
2.1.4 Механический расчет	46
2.2 Расчет теплообменника	49
4 Охрана труда	62
ЗАКЛЮЧЕНИЕ	68
СПИСОК ИСПОЛЬЗУЕМЫХ ИСТОЧНИКОВ	70

Приложение 3

Пример оформления задания

Пример оформления задания на дипломную работу(проект)

МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РЕСПУБЛИКИ САХА (ЯКУТИЯ)

ГОСУДАРСТВЕННОЕ АВТОНОМНОЕ ПРОФЕССИОНАЛЬНОЕ

ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ РЕСПУБЛИКИ САХА (ЯКУТИЯ)

«РЕГИОНАЛЬНЫЙ ТЕХНИЧЕСКИЙ КОЛЛЕДЖ В Г. МИРНОМ»

ЗАДАНИЕ

на дипломную работу (проект)

Студенту________________________________________________________группа___________

1.Тема работы: ___________________________________________________________________ ________________________________________________________________________________________________________________________________________

2.Сроки сдачи студентом законченной работы________________________
3. Руководитель работы___________________________________________

(фамилия, имя, отчество полностью, место работы, должность)

______________________________________________________________________________________________________________________________________________________________________

4.Исходные данные к работе:___________________________________ ____________________________________________________________________________________________________________________________________________________________________________________________________________

Содержание дипломной работы (проекта) (с расшифровкой задания по каждой части) ________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

Задание выдал___________________________________________________

_{(фамилия, имя, отчество полностью, место работы, должность)}

____________________________________________________________________________________________________________________________________________

Дата выдачи: «_____»__________________20____г.

					РТК.О.18.02.09 01 ПНиГ-17/9 ПЗ

Изм.	Лист	№ докум	Подпись	Дата
Разраб		Иванов И.И.			Установка замедленного коксования	Литера		Лист	Листов
Пров		Петров П.П.					y
						ГАПОУ РС (Я) «МРТК»
Н. Контр.		-
Утв		Сидорова М.И.

Приложение 4

Образец листа A4 с рамкой и большим штампом ГОСТ 2.301-68

СОДЕРЖАНИЕ

ВВЕДЕНИЕ	5
1 Установка замедленного коксования	8
1.1 Выбор метода производства	9
1.1.1 Типы установок коксования	13
1.1.2 Кубовый метод коксования	17
1.1.3 Термоконтактный метод коксования	19
1.2 Физико-химические основы процесса	23
1.3 Технологические схемы и режим работы коксования	25
1.3.1 Установка замедленного коксования	27
2 Расчет основного вспомогательного аппаратов установки замедленного коксования	32
2.1 Расчет коксовой камеры	33
2.1.1 Материальный баланс	34
2.1.2 Расчет теплового баланса	38
2.1.3 Конструктивный расчет	42
2.1.4 Механический расчет	46
2.2 Расчет теплообменника	49
4 Охрана труда	62
ЗАКЛЮЧЕНИЕ	68
СПИСОК ИСПОЛЬЗУЕМЫХ ИСТОЧНИКОВ	70