Содержание и оформление работы должны отвечать следующим шести требованиям:
1. Общим требованиям к программным документам.
Общие требования к оформлению программных документов устанавливает ГОСТ 19.105-78.
Программный документ может подаваться на различных типах носителей данных и состоять из следующих условных частей:
Титульная часть состоит из листа утверждения и титульного листа согласно ГОСТ 19.104-78.
Информационная часть состоит из аннотации и содержания. В аннотации указывают сведения о назначении документа и сжатое изложение его основной части.
Содержание содержит перечень записей о структурных элементах основной части документа, в каждую из которых входят:
– обозначения структурного элемента (номер раздела, подраздела);
– наименование структурного элемента;
– адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.д.).
Правила обозначения структурных элементов основной части документа и их адресации устанавливают стандарты ЕСПД для каждого типа носителя. Состав и структуру основной части программного документа устанавливают правила ЕСПД на соответствующие документы. О каждом изменении программного документа делают запись согласно ГОСТ 19.603-78.
Техническое задание
2. Требованиям к описанию языка.
Требования к содержанию и оформлению программного документа по описанию языка (программирование, управление заданием, организация вычислительного процесса) устанавливает ГОСТ 19.506-79. При этом учитываются положения ГОСТ 19.105-78 «Общие требования к программным документам». Составление информационной части (аннотации и содержания) является обязательным.
Описание языка должно содержать следующие разделы.
1. Общие сведения. Указывают назначение и дают описание общих характеристик языка, его возможностей, основных сфер использования и т.д.
2. Элементы языка. Дают описание синтаксиса и семантики базовых и составляющих элементов языка.
3. Способы структурирования программы. Указывают способы вызова процедуры, передачи управления и другие элементы структурирования программы.
4. Средства обмена данными. Указывают описание Языковых средств обмена данными (например, средства ввода-вывода, внутреннего обмена данными и т.д.).
5. Встроенные элементы. Дают описание встроенных в язык элементов (например, функции, классы и т.д.) и правила их использования.
6. Средства отладки программ. Указывают описание наличных средств отладки программ, семантику этих средств, рекомендации относительно их использования.
3. Требованиям к тексту и описанию программы.
Структуру и оформление текста программы устанавливают в соответствии с ГОСТ 19.105-78 «Общие требования к программным документам». Составление информационной части (аннотации и содержания) является обязательным.
Основная часть документа должна состоять из текстов, одного или нескольких разделов, которым дают наименование. Каждый из этих разделов реализуется одним из типов символической записи, например:
Классификация программного обеспечения
– символические записи исходными или промежуточными языками;
– символическое представление машинных кодов и т.д.
В символическую запись разделов рекомендуется включать комментарии, которые могут отображать, например, функциональное ‘назначение, структуру (ГОСТ 19.401-78).
Описание программы должно содержать следующие разделы (ГОСТ 19.402-78):
1. Общие сведения. Указывают обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; язык программирования, которым написана программа.
2. Функциональное назначение. Указывают классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях программы.
3. Описание логической структуры. Указывают алгоритм программы, использованные методы, структуру программы с описанием функций составляющих частей и связи между ними. Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
4. Использованные технические средства. Перечисляют типы ЭВМ и устройства, используемые для работы программы.
5. Вызов и загрузка. Указывают способ вызова программы с соответствующего носителя данных, входные точки программы. Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
6. Входные данные. Указывают характер, организацию и предварительную подготовку входных данных, а также формат и способ кодирования входных данных.
7. Выходные данные. Указывают характер и организацию выходных данных, а также формат и способ кодирования выходных данных.
4. Требования к пособию системного программиста.
Требования к содержанию и оформлению программного документа «Пособие системного программиста» устанавливает ГОСТ 19.563-79. При этом учитываются положения ГОСТ 19.105-78 «Общие требования к программным документам». Составление информационной части (аннотации и содержания) является обязательным.
Пособие системного программиста должно содержать следующие разделы.
1. Общие сведения о программе. Указывают назначение и функции программы и сведения о технических и программных средствах, которые обеспечивают выполнение этой программы.
2. Структура программы. Указывают сведения о структуре программы, ее составные части и связи между ними и другими программами.
3. Настройка программы. Указывают описание действий по настройке программы на условия конкретного использования (настройка на состав технических средств, выбор функций и др.).
4. Проверка программы. Указывают описание способов проверки, позволяющие оценить работоспособность программы (контрольные примеры, методы прогона, результаты).
5. Сообщения системному программисту. Указывают тексты сообщений, выдаваемых в ходе выполнения настройки и т.п.
В приложениях к пособию можно указывать вспомогательные материалы (примеры, иллюстрации, таблицы, графики и т.д.).
5. Требования к пособию программиста.
Пособие программиста должно содержать следующие разделы.
1. Назначение и условия использования программы. Указывают назначение и функции, которые должна выполнять программа, и условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, программного обеспечения и т.д.).
2. Характеристика программы. Описывают основные характеристики и особенности программы (временные характеристики, режим работы, средств контроля и т.д.).
3. Обращение к программе. Указывают описание процедур вызова программы (способы передачи управления и параметров данных и т.д.).
4. Входные и выходные данные. Представляют описание организации используемой входной и выходной информации.
5. Сообщения. Указывают пакеты сообщений, выдаваемые программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо выполнять по этим сообщениям.
В приложениях можно указывать вспомогательные материалы (примеры, иллюстрации, таблицы, графики и т.д.).
6. Требования к ТЗ.
Порядок построения и оформления ТЗ на разработку программы или программного изделия устанавливает ГОСТ 19.201-78.
Техническое задание содержит следующие разделы.
1. Вступление. Указывают наименование, сжато характеризуют сферу использования программы (изделия) и объекта.
2. Основания для разработки.
В этом разделе указывают:
– документ, на основании которого выполняется разработка;
– организации, утвердившие этот документ;
– наименование и (или) условное обозначение цели разработки.
3. Назначение разработки. Указывают функциональное и эксплуатационное назначение программы (изделия).
4. Требования к программе или программному изделию.
Этот раздел состоит из следующих подразделов:
– требования к функциональным характеристикам и надежности;
– требования к составу и параметрам технических средств, их информационной и программной совместимости;
– условия эксплуатации, специальные требования.
5. Требования к программной документации. Указывают предварительный состав программной документации и, в случае необходимости, специальные требования к ней.
6. Технико-экономические показатели.
В этом разделе указывают:
– ориентировочную экономическую эффективность;
– предусмотренную потребность на год;
– экономические преимущества в сравнении с лучшими образцами (аналогами).
8. Порядок контроля и приемки. Указывают виды испытаний и общие требования к приемке работ.
В приложениях к ТЗ в случае необходимости указывают:
– перечень научно-исследовательских и других источников и работ, обосновывающих разработку;
– схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы в разработке.
Источник: ronl.org
Требования к программной документации
Цель работы:ознакомиться с правилами написания технического задания.
Подготовка к лабораторной работе
Ознакомиться с лекционным материалом по теме «Модели ЖЦ ПО. Этапы ЖЦ в соответствии с ГОСТ 19.102-77. Постановка задачи» учебной дисциплины «Разработка и стандартизация ПС и ИТ».
1.Изучить соответствующие разделы в изданиях [1 — 3].
Теоретическая часть. Разработка технического задания
Техническое задание представляет собой документ, в котором сформулированы основные цели разработки, требования к программному продукту, определены сроки и этапы разработки и регламентирован процесс приемо-сдаточных испытаний. В разработке технического задания участвуют как представители заказчика, так и представители исполнителя. В основе этого документа лежат исходные требования заказчика, анализ передовых достижений техники, результаты выполнения научно-исследовательских работ, предпроектных исследований, научного прогнозирования и т. п.
Порядок разработки технического задания
Разработка технического задания выполняется в следующей последовательности. Прежде всего, устанавливают набор выполняемых функций, а также перечень и характеристики исходных данных. Затем определяют перечень результатов, их характеристики и способы представления.
Далее уточняют среду функционирования программного обеспечения: конкретную комплектацию и параметры технических средств, версию используемой операционной системы и, возможно, версии и параметры другого установленного программного обеспечения, с которым предстоит взаимодействовать будущему программному продукту.
В случаях, когда разрабатываемое программное обеспечение собирает и хранит некоторую информацию или включается в управление каким-либо техническим процессом, необходимо также четко регламентировать действия программы в случае сбоев оборудования и энергоснабжения.
1. Общие положения
1.1. Техническое задание оформляют в соответствии с ГОСТ 19.106—78 на листах формата А4 и A3 по ГОСТ 2.301—68, как правило, без заполнения полей листа. Номера листов (страниц) проставляют в верхней части листа над текстом.
1.3. Для внесения изменений и дополнений в техническое задние на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для технического задания.
1.4. Техническое задание должно содержать следующие разделы:
•наименование и область применения;
•основание для разработки;
•технические требования к программе или программному изделию;
•стадии и этапы разработки;
•порядок контроля и приемки;
2. Содержание разделов
2.1.Введение должно включать краткую характеристику области применения программы или программного продукта, а также объекта (например, системы), в котором предполагается их использовать. Основное назначение введения — продемонстрировать актуальность данной разработки и показать, какое место эта разработка занимает в ряду подобных.
2.2.В разделе «Наименование и область применения» указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.
2.3.В разделе «Основание для разработки» должны быть указаны:
• документ (документы), на основании которых ведется разработка. Таким документом может служить план, приказ, договор и т. п.;
• организация, утвердившая этот документ, и дата его утверждения;
• наименование и (или) условное обозначение темы разработки.
2.4. В разделе «Назначение разработки» должно быть указано функциональное и эксплуатационное назначение программы или программного изделия.
2.5. Раздел «Технические требования к программе или программному изделию» должен содержать следующие подразделы:
•требования к функциональным характеристикам;
•требования к надежности;
•требования к составу и параметрам технических средств;
•требования к информационной и программной совместимости;
•требования к маркировке и упаковке;
•требования к транспортированию и хранению;
2.5.1.В подразделе «Требования к функциональным характеристикам» должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т. п.
2.5.2.В подразделе «Требования к надежности» должны быть указаны требования к обеспечению надежного функционирования (обеспечение устойчивого функционирования, контроль входной и выходной информации, время восстановления после отказа и т. п.).
2.5.3.В подразделе «Условия эксплуатации» должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т. п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
2.5.4.В подразделе «Требования к составу и параметрам технических средств» указывают необходимый состав технических средств с указанием их технических характеристик.
2.5.5.В подразделе «Требования к информационной и программной совместимости о должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования. При необходимости должна обеспечиваться защита информации и программ.
2.5.6.В подразделе «Требования к маркировке и упаковке» в общем случае указывают требования к маркировке программного изделия, варианты и способы упаковки.
2.5.7.В подразделе «Требования к транспортированию и хранению» должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.
2.5.8. В разделе «Технико-экономические показатели» должны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
2.7.В разделе «Порядок контроля и приемки» должны быть указаны виды испытаний и общие требования к приемке работы.
2.8.В приложениях к техническому заданию при необходимости приводят:
•перечень научно-исследовательских и других работ, обосновывающих разработку;
•схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
•другие источники разработки.
В случаях, если какие-либо требования, предусмотренные техническим заданием, заказчик не предъявляет, следует в соответствующем месте указать «Требования не предъявляются».
Примеры разработки технического задания приведены в приложениях Б и В.
Порядок выполнения работы
1.Разработать техническое задание на программный продукт согласно своему варианту (см. варианты в приложении А)
2.Оформить работу в соответствии с ГОСТ 19.106-78. При оформлении использовать MS Office.
3.Сдать и защитить работу.
Защита отчета по лабораторной работе
Отчет по лабораторной работе должен быть оформлен на основании СТП и состоять из следующих структурных элементов:
1. титульный лист;
2. текстовая часть;
3. приложение: разработанное технического задания на программный продукт.
Текстовая часть отчета должна включать пункты:
Зашита отчета по практической работе заключается в предъявлении преподавателю полученных результат и демонстрации полученных навыков в ответах на вопросы преподавателя.
Контрольные вопросы
1.Дайте понятие модели жизненного цикла ПО.
2.Приведите этапы разработки программного обеспечения.
3. Что включает в себя постановка задачи и предпроектные исследования?
4. Перечислите функциональные и эксплуатационные требования к программному продукту.
5. Перечислите правила разработки технического задания.
6. Назовите основные разделы технического задания.
1. Бедрина С.Л., Разработка и стандартизация программного обеспечения. – Владивосток: Издательство ВГУЭС, 2006.
2. Благодатских В.А., Волнин В.А., Поскакалов К.Ф. Стандартизация разработки программных средств. – М: Финансы и статистика, 2003.
3. ГОСТ 19.102-77 ЕСПД. Стадии разработки
1. Разработать программный модуль «Учет успеваемости студентов». Программный модуль предназначен для оперативного учета успеваемости студентов в сессию деканом, заместителями декана и сотрудниками деканата. Сведения об успеваемости студентов должны храниться в течение всего срока их обучения и использоваться при составлении справок о прослушанных курсах и приложений к диплому.
2. Разработать программный модуль «Личные дела студентов». Программный модуль предназначен для получения сведений о студентах сотрудниками деканата, профкома и отдела кадров. Сведения должны храниться в течение всего срока обучения студентов и использоваться при составлении справок и отчетов.
3. Разработать программный модуль «Решение комбинаторно-оптимизационных задач». Модуль должен содержать алгоритмы поиска цикла минимальной длины (задача коммивояжера), поиска кратчайшего пути и поиска минимального связывающего дерева.
4. Разработать программный модуль «Обработка матрицы». Модуль должен содержать алгоритмы поиска сумм и произведения элементов матрицы по строкам и столбцам, а также вычисление средних, минимальных и максимальных величин в матрице.
5. Разработать приложение Windows «Органайзер». Приложение предназначено для записи, хранения и поиска адресов и телефонов физических лиц и организаций, а также расписания, встреч и др. Приложение предназначено для любых пользователей компьютера.
6. Разработать приложение Windows «Калькулятор». Приложение предназначено для любых пользователей и должно содержать все арифметические операции (с соблюдением приоритетов) и желательно (но не обязательно) несколько математических функций.
7. Разработать программный модуль «Кафедра», содержащий сведения о сотрудниках кафедры (ФИО, должность, ученая степень, дисциплины, нагрузка, общественная работа, совместительство и др.). Модуль предназначен для использования сотрудниками отдела кадров и деканата.
8. Разработать программный модуль «Лаборатория», содержащий сведения о сотрудниках лаборатории (ФИО, пол, возраст, семейное положение, наличие детей, должность, ученая степень). Модуль предназначен для использования сотрудниками профкома и отдела кадров.
9. Разработать программный модуль «Химчистка». При записи на обслуживание заполняется заявка, в которой указываются ФИО владельца, описание изделия, вид услуги, дата приема заказа и стоимость услуги. После выполнения работ распечатывается квитанция.
10.Разработать программный модуль «Учет нарушений правил дорожного движения». Для каждой автомашины (и ее владельца) в базе хранится список нарушений. Для каждого нарушения фиксируется дата, время, вид нарушения и размер штрафа. При оплате всех штрафов машина удаляется из базы.
11. Разработать программный модуль «Картотека автомагазина», предназначенный для использования работниками агентства. В базе содержатся сведения об автомобилях (марка, объем двигателя, дата выпуска и др.). При поступлении заявки на покупку производится поиск подходящего варианта. Если такого нет, клиент заносится в клиентскую базу и оповещается, когда вариант появляется.
12. Разработать программный модуль «Картотека абонентов АТС». Картотека содержит сведения о телефонах и их владельцах. Фиксирует задолженности по оплате (абонентской и повременной). Считается, что повременная оплата местных телефонных разговоров уже введена.
13. Разработать программный модуль «Автокасса», содержащий сведения о наличии свободных мест на автобусные маршруты. В базе должны содержаться сведения о номере рейса, маршруте, водителе, типе автобуса, дате и времени отправления, а также стоимости билетов. При поступлении заявки на билеты программа производит поиск подходящего рейса.
14. Разработать программный модуль «Книжный магазин», содержащий сведения о книгах (автор, название, издательство, год издания, цена). Покупатель оформляет заявку на нужные ему книги, если таковых нет, он заносится в базу и оповещается, когда нужные книги поступают в магазин.
15. Разработать программный модуль «Автостоянка». В программе содержится информация о марке автомобиля, его владельце, дате и времени въезда, стоимости стоянки, скидках, задолженности по оплате и др.
16. Разработать программный модуль «Кадровое агентство», содержащий сведения о вакансиях и резюме. Программный модуль предназначен как для поиска сотрудника, отвечающего требованиям руководителей фирмы, так и для поиска подходящей работы.
Примечание. При разработке программы не ограничиваться функциями, приведенными в варианте, добавить несколько своих функций. Обязательно использование структурного и модульного подходов к программированию.
Пример 2.Разработать техническое задание на разработку «Модуля автоматизированной системы оперативно-диспетчерского управления теплоснабжением корпусов Московского института».
1. Введение
Работа выполняется в рамках проекта «Автоматизированная система оперативно-диспетчерского управления электротеплоснабжением корпусов Московского института».
2. Основаниедля разработки
2.1.Основанием для данной работы служит договор № 1234 от 10 марта 2003 г.
«Модуль автоматизированной системы оперативно-диспетчерского управления теплоснабжением корпусов Московского института».
2.3.Исполнители: ОАО «Лаборатория создания программного обеспечения».
Назначение разработки
Создание модуля для контроля и оперативной корректировки состояния основных параметров обеспечения корпусов Московского института.
Технические требования
4.1. Требования к функциональным характеристикам. 4.1.1. Состав выполняемых функций. Разрабатываемое ПО должно обеспечивать:
•сбор и анализ информации о расходовании тепла, горячей и холодной воды по данным теплосчетчиков SA-94 на всех тепловых выходах;
•сбор и анализ информации с устройств управления системами воздушного отопления и кондиционирования типа РТ1 и РТ2 (разработки кафедры СММЭ и ТЦ);
•предварительный анализ информации на предмет нахождения параметров в допустимых пределах и сигнализирование при выходе параметров за пределы допуска;
•выдачу рекомендаций по дальнейшей работе;
•отображение текущего состояния по набору параметров — циклически постоянно (режим работы круглосуточный), при сохранении периодичности контроля прочих параметров;
•визуализацию информации по расходу теплоносителя:
—текущую, аналогично показаниям счетчиков;
—с накоплением за прошедшие сутки, неделю, месяц — в виде почасового графика для информации за сутки и неделю;
—суточный расход — для информации за месяц.
Для устройств управления приточной вентиляцией текущая информация должна содержать номер приточной системы и все параметры, выдаваемые на собственный индикатор.
По отдельному запросу осуществляются внутренние настройки.
В конце отчетного периода система должна архивировать данные.
4.1.2. Организация входных и выходных данных.
Исходные данные в систему поступают в виде значений с датчиков, установленных в помещениях института. Эти значения отображаются на компьютере диспетчера. После анализа поступившей информации оператор диспетчерского пункта устанавливает необходимые параметры для устройств, регулирующих отопление и вентиляцию в помещениях. Возможна также автоматическая установка некоторых параметров для устройств регулирования.
Основной режим использования системы — ежедневная работа.
4.2. Требования к надежности.
Для обеспечения надежности необходимо проверять корректность получаемых данных с датчиков.
4.3. Условия эксплуатации и требования к составу и параметрам технических средств.
Для работы системы должен быть выделен ответственный оператор.
Требования к составу и параметрам технических средств уточняются на этапе эскизного проектирования системы.
4.4. Требования к информационной и программной совместимости.
Программа должна работать на платформах Windows 98/ NT/2000.
4.5. Требования к транспортировке и хранению.
Программа поставляется на лазерном носителе информации.
Программная документация поставляется в электронном и печатном виде.
4.6. Специальные требования:
•программное обеспечение должно иметь дружественный интерфейс, рассчитанный на пользователя (в плане компьютерной грамотности) квалификации;
•ввиду объемности проекта задачи предполагается решать поэтапно, при этом модули ПО, созданные в разное время, должны предполагать возможность наращивания системы и быть совместимы друг с другом, поэтому документация на принятое эксплуатационное ПО должна содержать полную информацию, необходимую для работы программистов с ним;
•язык программирования — по выбору исполнителя, должен обеспечивать возможность интеграции программного обеспечения с некоторыми видами периферийного оборудования (например, счетчик SA-94 и т. п.).
Требования к программной документации
Основными документами, регламентирующими разработку будущих программ, должны быть документы Единой Системы Программной Документации (ЕСПД): руководство пользователя, руководство администратора, описание применения.
Дата добавления: 2018-06-01 ; просмотров: 1759 ; Мы поможем в написании вашей работы!
Поделиться с друзьями:
Источник: studopedia.net