Техническое задание на программу

В главе 1 «Техническое задание» необходимо разработать техническое задание на создаваемое программное обеспечение в соответствии с ГОСТ 19.201-78 «Техническое задание. Требования к содержанию и оформлению».

1. Техническое задание
1.1 Введение технического задания
1.2 Назначение разработки
1.3 Требования к программе или программному изделию
1.3.1 Требования к функциональным характеристикам
1.3.2 Требования к надежности
1.3.3 Требования к составу и параметрам технических средств
1.3.4 Требования к информационной и программной совместимости

1.4 Требования к программной документации

В разделе 1.1 «Введение технического задания» должно включать наименование и краткую характеристику об­ласти применения программы или программного продукта, а также объекта (например, системы) в котором предполагается их использовать. Основное назначение введения — продемонстрировать актуальность данной разработки и показать, какое место эта разработка занимает в ряду подобных.

В разделе 1.2 «Назначение разработки» должен содержать описание функцио­нального и эксплуатационного назначения программного продукта с указа­нием категорий пользователей.

Как составить техническое задание на разработку программного обеспечения? 4 основных правила ТЗ!

Раздел 1.3 «Требования к программе или программному изделию» должен включать следующие подразделы:
— требования к функциональным характеристикам;
— требования к надежности;
— требования к составу и параметрам технических средств;
— требования к информационной и программной совместимости.

В подразделе 1.3.1 «Требования к функциональным характеристикам» должны быть перечислены выполняемые функции и описаны состав, характеристики и формы представления исходных данных и результатов. В этом же подразделе при необходимости указывают критерии эффективности: максимально допустимое время ответа системы, максимальный объем используемой оперативной и/или внешней памяти и др.

В подразделе 1.3.2 «Требования к надежности» указывают уровень надежнос­ти, который должен быть обеспечен разрабатываемой системой и время восстановления системы после сбоя. Для систем с обычными требова­ниями к надежности в этом подразделе иногда регламентируют действия разра­батываемого продукта по увеличению надежности результатов (обеспечения устойчивого функционирования, контроль входной и выходной информации, создание резервных копий промежуточ­ных результатов, время восстановления после отказа и т. п.).

В подразделе 1.3.3 «Требования к составу и параметрам технических средств» указывают необходимый состав технических средств с указанием их основ­ных технических характеристик: тип микропроцессора, объем памяти, нали­чие внешних устройств и т. п. При этом часто указывают два варианта кон­фигурации: минимальный и рекомендуемый.

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

Как составить ТЗ на разработку программы? Техническое задание по ГОСТу

В разделе 1.4 «Требования к программной документации» указывают необхо­димость наличия руководства системного программиста, руководства пользователя, пояснительной записки и т. п. На все эти типы документов также существуют ГОСТы.

Источник: prepodbegun.blogspot.com

Стандарты и шаблоны для ТЗ на разработку ПО

Недавно ко мне обратились, чтобы я посоветовал стандарты для написания технического задания (ТЗ) на разработку автоматизированных систем (АС) и программного обеспечения (ПО). Вот думаю, сейчас зайду в Яндекс, найду подходящую статейку и отправлю её. Но не тут-то было! Одной статьи, где перечисляются стандарты для ТЗ, включая шаблоны и примеры готовых документов, я не нашел. Придется сделать такую статейку самому…

И так, основные стандарты, методологии и своды знаний, где упоминается ТЗ или SRS (Software (or System) Requirements Specification):

• ГОСТ 34
• ГОСТ 19
• IEEE STD 830-1998
• ISO/IEC/ IEEE 29148-2011
• RUP
• SWEBOK, BABOK и пр.

ГОСТ 34

ГОСТ 34.602-89 Техническое задание на создание автоматизированной системы рекомендует структуру ТЗ на создание именно СИСТЕМЫ, в которую входят ПО, аппаратное обеспечение, люди, которые работают с ПО, и автоматизируемые процессы.

Согласно ГОСТ 34 техническое задание должно включать следующие разделы:

При разработке ТЗ для государственных проектов Заказчики, как правило, требуют соблюдение именно этого стандарта.

ГОСТ 19

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

1. Введение;
2. Основания для разработки;
3. Назначение разработки;
4. Требования к программе или программному изделию;
5. Требования к программной документации;
6. Технико-экономические показатели;
7. Стадии и этапы разработки;
8. Порядок контроля и приемки;
9. Приложения.

Естественно ГОСТ 34 (и 19) уже устарели, и я не люблю их использовать, но при правильном интерпретации стандартов, можно получить хорошее ТЗ, см. Заключение.

IEEE STD 830-1998

Согласно стандарту техническое задание должно включать следующие разделы:

• 1. Назначение
• 2. Область действия
• 3. Определения, акронимы и сокращения
• 4. Ссылки
• 5. Краткий обзор

• 1. Взаимодействие продукта (с другими продуктами и компонентами)
• 2. Функции продукта (краткое описание)
• 3. Характеристики пользователя
• 4. Ограничения
• 5. Допущения и зависимости

• 1. Требования к внешним интерфейсам

• 1. Интерфейсы пользователя
• 2. Интерфейсы аппаратного обеспечения
• 3. Интерфейсы программного обеспечения
• 4. Интерфейсы взаимодействия

На самом деле новичку достаточно трудно понять, что должно содержаться в данных разделах по вышеприведенной структуре (как и в случае с ГОСТом), поэтому нужно читать сам стандарт, который легко найти в Интернете. Как и примеры, правда, на англ. языке.

Мне же больше нравится адаптированный шаблон Карла Вигерса, который я использую при разработки ТЗ для коммерческих компаний. И вообще дедушка Вигерс предоставляет множество полезных рекомендаций по работе с требованиями (куда идут деньги при покупке этих рекомендаций, читайте в начале красным). Ну а его книжку вы уже несколько раз, надеюсь, перечитали.

ISO/IEC/ IEEE 29148-2011

Стандарт IEEE 29148-2011 обеспечивает единую трактовку процессов и продуктов, используемых при разработке требований на протяжении всего жизненного цикла систем и программного обеспечения. Он приходит на смену стандартов IEEE 830-1998, IEEE 1233-1998, IEEE 1362-1998.

Пример технического задания по ГОСТ 19.201-78

Ниже приведен пример оформления технического задания по ГОСТ 19.201-78 на информационную систему кинотеатра. Цель примера — показать студентам как это должно выглядеть и что примерно может быть записано в разделы ТЗ, предусмотренные ГОСТ-ом. Так как при реальное техническое задание утверждает заказчик, а в данном случае — нет, то представим, что к нам обратился заказчик из некоторой фирмы и у него есть (нам известны) его требования к системе.

1 Введение

1.1 Наименование программы

Наименование программы – «Кинотеатр+».

1.2 Краткая характеристика области применения

Система «Кинотеатр+» предназначена для организация продажи билетов в кинотеатрах, состоящих из нескольких залов. Для каждого зала в кинотеатре должен быть предусмотрен только один оператор-кассир, выполняющий продажу и возврат билетов посетителям.

2 Основания для разработки

Основанием для разработки является Договор 12 от 01.08.2020. Договор утвержден Директором ООО «Скучные Фильмы» Ивановым Иваном Ивановичем, именуемым в дальнейшем Заказчиком, и Петровым Петром Петровичем (самозанятый), именуемым в дальнейшем исполнителем, 01.08.2020. Согласно Договору, Исполнитель обязан разработать и установить систему «Кинотеатр+» на оборудовании Заказчика не позднее 12.01.2021, предоставить исходные коды и документацию к разработанной системе не позднее 01.06.2021. Наименование темы разработки – «Разработка информационно-справочной системы Кинотеатр+».
Условное обозначение темы разработки (шифр темы) – «Кино-01».

3 Назначение разработки

Программа будет использоваться в кинотеатре двумя группами пользователей: оператор-кассир и посетитель.

3.1 Функциональное назначение

Для посетителя кинотеатра программа предоставляет возможность просмотра текущей заполненности зала (отображение свободных и занятых мест). Для оператора-кассира программа позволяет помечать места в зале как «занятые» (при продаже билетов) или «свободные» (в случае возврата билетов).

3.2 Эксплуатационное назначение

Программа должна эксплуатироваться в зале ожидания кинотеатра. Запущенная с правами посетителя, она может транслироваться на большие мониторы (для посетителей). С правами кассира программа запускается на компьютере кассира.

4 Требования к программе или программному изделию

4.1 Требования к функциональным характеристикам

4.1.1 Требования к составу выполняемых функций

После запуска программы пользователю отображается форма ввода логина и пароля, показанная на рисунке 1. В системе существует всего 2 пользователя — кассир и посетитель. Программа проверяет тип пользователя и открывает соответствующий интерфейс. Для посетителя кинотеатра программа предоставляет следующие возможности:

• просмотр расписания фильмов;
• просмотр заполненности зала для конкретного проката фильма.

При просмотре расписания выводится таблица, каждая строка которой описывает прокат фильма и содержит следующую информацию:

• дата и время проката;
• название фильма;
• возрастные ограничения.

Примерный вид окна просмотра прокатов для посетителя показан на рисунке 2. В верхней строке отображается название зала и текущее время. Уже начаты сеансы помечаются желтым цветом (на них еще можно купить билеты, с опозданием). После завершения проката строка таблицы автоматически удаляется (отображаются только текущие и будущие прокаты).

При просмотре заполненности зала, посетителю выводится схема кинотеатра, на которой показано:

• положение экрана;
• ряды, состоящие из мест;
• свободные места (выделены синим цветом) и занятые (выделены красным).

Пример схемы зала приведен на рисунке 3.

Для оператора-кассира программа предоставляет все функции, предоставляемые посетителю, а также возможности:

• выбора группы из свободных или занятых мест (мышкой, с зажатой клавишей Ctrl);
• пометки выбранных мест как «занятых» или «свободных»;
• изменение расписания проката фильмов.

Окно расписания проката для оператора, помимо таблицы, должно содержать кнопки «Добавить» и «Удалить», как показано на рисунке 4.

Для удаления сеанса оператор выбирает строку таблицы и нажимает кнопку «Удалить». Удалить можно только прокат, на который нет проданных билетов.

Для изменения информации о прокате оператор выполняет двойной клик мышью по изменяемому полю — после этого вводит в поле новое значение. Изменять можно только прокаты, показ которых еще не начат.

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

Все изменения, выполняемые оператором-кассиром должны отражаться на схеме для посетителей.

4.1.2 Требования к организации входных и выходных данных

Данные о прокатах фильмов и пользователях хранятся в базе данных. СУБД обеспечивает разграничение прав доступа к данным — дает клиенту права на чтение, а оператору — на чтение и запись. Ввод данных в базу (логины и пароли) выполняет администратор, выполняющий поставку программного обеспечения заказчику. Выполняет он это с помощью запросов к СУБД.

После установки программы, ввод данных в систему осуществляет только кассир, валидация данных выполняется на стороне клиента:

• дата и время должны быть записаны в формате: «ДД.ММ.ГГГГ ЧЧ:ММ»;
• название — последовательность не более чем из 200 любых символов;
• возрастные ограничения — “ +”.

4.1.3 Требования к временным характеристикам

После изменения кассиром данных, находящихся в базе данных, новая информация на клиентах отображается не позднее, чем через 5 секунд.

4.2 Требования к надежности

Вероятность безотказной работы системы должна составлять не менее 99.99% при условии исправности сети (связи приложений оператора и посетителя с базой данных).

4.2.1 Требования к обеспечению надежного (устойчивого) функционирования программы

В связи с тем, что в базе данных хранятся данные о совершенных клиентами покупках (финансовая информация) — базу данных стоит резервировать (резервирование замещением).

Надежное (устойчивое) функционирование программы должно быть обеспечено выполнением заказчиком совокупности организационно-технических мероприятий, перечень которых приведен ниже:

• организацией бесперебойного питания технических средств;
• использованием лицензионного программного обеспечения;
• регулярным выполнением рекомендаций Министерства труда и социального развития РФ, изложенных в Постановлении от 23 июля 1998 г. «Об утверждении межотраслевых типовых норм времени на работы по сервисному обслуживанию ПЭВМ и оргтехники и сопровождению программных средств»;
• регулярным выполнением требований ГОСТ 51188-98. Защита информации. Испытания программных средств на наличие компьютерных вирусов.

4.2.2 Время восстановления после отказа

Время восстановления после отказа, вызванного сбоем электропитания технических средств (иными внешними факторами), не фатальным сбоем (не крахом) операционной системы, не должно превышать 10 минут при условии соблюдения условий эксплуатации технических и программных средств.

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

4.2.3 Отказы из-за некорректных действий оператора

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

4.3 Условия эксплуатации

Программа (клиент) запускается на компьютере оператора-кассира и компьютере, доступном посетителям кинотеатра. База данных находится на третьем компьютере. Должна существовать устойчивая связь по сети между клиентами и базой данных.

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

4.3.1 Климатические условия эксплуатации

Специальные условия не требуются.

4.3.2 Требования к видам обслуживания

Программа не требует проведения каких-либо видов обслуживания.

4.3.3 Требования к численности и квалификации персонала

При установке и настройке системы необходим системный администратор. В процессе эксплуатации с программой работают оператор-кассир и посетитель кинотеатра.

Системный администратор должен иметь высшее профильное образование и сертификаты компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:

• установка клиентских приложений;
• настройка СУБД;
• настройка сети между клиентами и СУБД.

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

Администратор и оператор-кассир должны быть аттестованы на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).

К квалификации посетителя кинотеатра специальные требования не предъявляются.

4.4 Требования к составу и параметрам технических средств

Состав технических средств:

• Компьютер оператора, включающий в себя:

• процессор x86 с тактовой частотой, не менее 1 ГГц;
• оперативную память объемом, не менее 1 Гб;
• видеокарту, монитор, мышь, клавиатура.

• процессор x86 с тактовой частотой, не менее 1 ГГц;
• оперативную память объемом, не менее 1 Гб;
• видеокарту, монитор, мышь.

• процессор x86 с тактовой частотой, не менее 1 ГГц;
• оперативную память объемом, не менее 1 Гб;
• видеокарту, монитор, мышь.

4.5 Требования к информационной и программной совместимости

Приложения кассира и посетителя обмениваются с СУБД сообщениями по локальной сети, при этом используется протокол HTTP. Должно быть исключено появление посторонних устройств в сети.

4.6 Требование к маркировке и упаковке

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

4.7 Требования к транспортированию и хранению

Специальных требований не предъявляется.

4.8 Специальные требования

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

5 Требования к программной документации

Предварительный состав программной документации:

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

6 Технико-экономические показатели

Программа «Кинотеатр+» пригодна для небольших кинотеатров, не рассматривающих возможность продажи билетов через Internet. Скорее всего программа будет использоваться в поселковых кинотеатрах.
Функциональность программы совпадает с аналогами (установленными в кинотеатрах нашего города).
В связи с тем, что из года в год кинотеатров не становится значительно больше, а количество маленьких кинотеатров даже снижается — не стоит ожидать роста годовой потребности. Однако, в случае бесплатного распространения программы, потребность в ней может быть весьма высокой — в каждом поселке есть кинотеатр. Экономический эффект при этом может быть обеспечен за счет платной установки системы.

7 Стадии и этапы разработки

Разработка должна быть проведена в три стадии:

1. техническое задание;
2. технический (и рабочий) проекты;
3. внедрение.

На стадии «Техническое задание» должен быть выполнен этап разработки, согласования и утверждения настоящего технического задания.

На стадии «Технический (и рабочий) проект» должны быть выполнены перечисленные ниже этапы работ:

• разработка программы;
• разработка программной документации;
• испытания программы.

На стадии «Внедрение» должен быть выполнен этап разработки «Подготовка и передача программы».

Содержание работ по этапам:
На этапе разработки технического задания должны быть выполнены перечисленные ниже работы:

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

На этапе разработки программы должна быть выполнена работа по программированию (кодированию) и отладке программы.

На этапе разработки программной документации должна быть выполнена разработка программных документов в соответствии с требованиями ГОСТ 19.101-77.

На этапе испытаний программы должны быть выполнены перечисленные ниже виды работ:

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

На этапе подготовки и передачи программы должна быть выполнена работа по подготовке и передаче программы и программной документации в эксплуатацию на объектах заказчика.

8 Порядок контроля и приемки

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

Ход проведения приемо-сдаточных испытаний заказчик и исполнитель документируют в протоколе испытаний.
На основании протокола испытаний исполнитель совместно с заказчиком подписывают акт приемки-сдачи программы в эксплуатацию.

Список используемой литературы

1. ГОСТ 19.201-78 Единая система программной документации. Техническое задание. Требования к содержанию и оформлению. 1978. Режим доступа: http://protect.gost.ru/document.aspx?control=7https://pro-prof.com/forums/topic/%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80-%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B3%D0%BE-%D0%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%B3%D0%BE%D1%81%D1%82-19-201-78″ target=»_blank»]pro-prof.com[/mask_link]