 |
Требование к программной документации
|
|
|
|
Практическая работа № 5.1
ТЕХНИЧЕСКОЕ ЗАДАНИЕ
Цель работы: ознакомиться с правилами написания технического задания.
ГОСТ 19.201—78. Настоящий стандарт устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Общие положения
1.1. Техническое задание оформляют в соответствии с ГОСТ 19.106—78 на листах формата А4 и АЗ по ГОСТ 2.301—68, как правило, без заполнения полей листа. Номера листов (страниц) проставляют в верхней части листа над текстом.
1.2. Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104—78. Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать.
1.3. Для внесения изменений и дополнений в техническое задание на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Coгласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для задания.
1.4. Техническое задание должно содержать следующие разделы:
• название программы и область применения;
• основание для разработки;
• назначение разработки;
• технические требования к программе или программному изделию;
• технико-экономические показатели;
• стадии и этапы разработки;
• порядок контроля и приемки;
• приложения.
В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделом, вводить новые разделы или объединять отдельные из них.
2. Содержание разделов
|
|
|
2.1 В разделе «Наименование и область применения» указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.
2.2 В разделе «Основание для разработки» должны быть указаны:
• документ (документы), на основании которых ведется разработка;
• организация, утвердившая этот документ, и дата его утверждения;
• наименование и (или) условное обозначение темы разработки.
2.3 В разделе «Назначение разработки» должно быть указано функциональное и эксплуатационное назначение, программы или программного изделия.
2.4 Раздел «Технические требования к программе или программному изделию» должен содержать следующие подразделы:
• требования к функциональным характеристикам;
• требования к надежности;
• условия эксплуатации;
• требования к составу и параметрам технических средств;
• требования к информационной и программной совместимости;
• требования к маркировке и упаковке;
• требования к транспортированию и хранению;
• специальные требования.
2.4.1. В подразделе «Требования к функциональным характеристикам» должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т. п.
2.4.2. В подразделе «Требования к надежности» должны быть указаны требования к обеспечению надежного функционирования (обеспечение устойчивого функционирования, контроль входной и выходной информации, время восстановления после отказа и т. п.).
2.4.3. В подразделе «Условия эксплуатации» должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т. п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
|
|
|
2.4.4. В подразделе «Требования к составу и параметрам технических средств» указывают необходимый состав технических средств с указанием их технических характеристик.
2.4.5. В подразделе «Требования к информационной и программной совместимости» должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования. При необходимости должна обеспечиваться защита информации и программ.
2.4.6. В подразделе «Требования к маркировке и упаковке» в общем случае указывают требования к маркировке программного изделия, варианты и способы упаковки.
2.4.7. В подразделе «Требования к транспортированию и хранению» должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складировании, сроки хранения в различных условиях.
2.1. В разделе «Технико-экономические показатели» должны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
2.2. В разделе «Стадии и этапы разработки» устанавливают необходимые стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и определяют исполнителей.
2.3. В разделе «Порядок контроля и приемки» должны быть указаны виды испытаний и общие требования к приемке работы.
2.4. В приложениях к техническому заданию при необходимости приводят:
• перечень научно-исследовательских и других работ, обосновывающих разработку;
• схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
• другие источники разработки.
Пример технического задания
«Утверждаю»
Профессор кафедры ВС
__________ (Иванов И. И.)
«___»____________2012 г.
Техническое задание
на разработку «Модуля автоматизированной системы оперативно-диспетчерского управления теплоснабжением корпусов Московского института»
Москва, 2012 г.
Введение
Работа выполняется в рамках проекта «Автоматизированная система оперативно-диспетчерского управления электро-, тепло-снабжением корпусов Московского института».
|
|
|
2. Основание для разработки
2.1. Основанием для данной работы служит договор № 1234 от 10 марта 2012 г.
2.2 Наименование работы:
«Модуль автоматизированной системы оперативно-диспетчерского управления теплоснабжением корпусов Московского института».
2.4 Исполнители ОАО «Лаборатория создания программного обеспечения».
2.5 Соисполнители: нет.
Назначение разработки
Создание модуля для контроля и оперативной корректировки состояния основных параметров теплообеспечения корпусов Московского института.
Технические требования
4.1. Требования к функциональным характеристикам.
4.1.1 Состав выполняемых функций.
Разрабатываемое ПО должно обеспечивать:
• сбор и анализ информации о расходовании тепла, горячей и холодной воды по данным теплосчетчиков SA-94 на всех тепловых выводах,
• сбор и анализ информации с устройств управления системами воздушного отопления и кондиционирования типа PT1 и РТ2 (разработки кафедры СММЭ и ТЦ);
• предварительный анализ информации на предмет нахождения параметров в допустимых пределах и сигнализирование при выходе параметров за пределы допуска;
• выдачу рекомендаций по дальнейшей работе;
• отображение текущего состояния по набору параметров — циклически постоянно (режим работы круглосуточный), при сохранении периодичности контроля прочих параметров;
• визуализацию информации по расходу теплоносителя:
— текущую, аналогично показаниям счетчиков;
— с накоплением за прошедшие сутки, неделю, месяц — в виде почасового графика для информации за сутки и неделю;
— суточный расход — для информации за месяц.
Для устройств управления приточной вентиляцией текущая информация должна содержать номер приточной системы и все параметры, выдаваемые на собственный индикатор.
По отдельному запросу осуществляются внутренние настройки.
В конце отчетного периода система должна архивировать данные.
|
|
|
4.1.2 Организация входных и выходных данных.
Исходные данные в систему поступают в виде значений с датчиков, установленных в помещениях института. Эти значения отображаются на компьютере диспетчера. После анализа поступившей информации оператор диспетчерского пункта устанавливает необходимые параметры для устройств, регулирующих отопление и вентиляцию в помещениях. Возможна также автоматическая установка некоторых параметров для устройств регулирования.
Основной режим использования системы — ежедневная работа.
4.2 Требования к надежности.
Для обеспечения надежности необходимо проверять корректность получаемых данных с датчиков.
4.3 Условия эксплуатации и требования к составу и параметрам технических средств.
Для работы системы должен быть выделен ответственный оператор.
Требования к составу и параметрам технических средств уточняются на этапе эскизного проектирования системы.
4.4 Требования к информационной и программной совместимости.
Программа должна работать на платформах Windows 2000/XP/Vista/7.
4.5 Требования к транспортировке и хранению.
Программа поставляется на лазерном носителе информации.
Программная документация поставляется в электронном и печатном виде.
4.6 Специальные требования.
Программное обеспечение должно иметь дружественный интерфейс, рассчитанный на пользователя (в плане компьютерной грамотности) средней квалификации.
Ввиду объемности проекта задачи предполагается решать поэтапно, при этом модули ПО, созданные в разное время, должны предполагать возможность наращивания системы и быть совместимы друг с другом, поэтому документация на принятое эксплуатационное ПО должна содержать полную информацию, необходимую для работы программистов с ним.
Язык программирования — по выбору исполнителя, должен обеспечивать возможность интеграции программного обеспечения с некоторыми видами периферийного оборудования (например, счетчик SA-94 и т.п.)
Требование к программной документации
Основными документами, регламентирующими разработку будущих программ, должны быть документы Единой Системы Программной Документации (ЕСПД): руководство пользователя, руководство администратора, описание применения.
|
|
|
