Практическая работа №10

Тема: Разработка технического задания на создание программного средства

Цель: - приобретение практических навыков по разработке технического задания (ТЗ) на создание программные средства различного назначения согласно требованиям стандартов ЕСПД.

Вид работы: фронтальный

Время выполнения: 2 часа

Теоретические сведения

Единая система программной документации

Общая характеристика ЕСПД

Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и большая часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Но уже тогда у программистов была масса претензий к этим стандартам. Что-то требовалось дублировать в документации много раз (как, казалось – неоправданно), а многое не было предусмотрено, как, например, отражение специфики документирования программ, работающих с интегрированной базой данных. Сейчас этот комплекс представляет собой систему межгосударственных стандартов стран СНГ (ГОСТ), действующих на территории РБ на основе межгосударственного соглашения по стандартизации.

Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки ПС, и связаны, по большей части, с документированием функциональных характеристик ПС. Следует отметить, что стандарты ЕСПД (ГОСТ серии 19) носят рекомендательный характер. Впрочем, это относится и ко всем другим стандартам в области ПС (ГОСТ серии 34, Международному стандарту ISO/IEC и др.). Эти стандарты становятся обязательными на контрактной основе – то есть при ссылке на них в договоре на разработку (поставку) ПС.

Говоря о состоянии ЕСПД в целом, можно констатировать, что большая часть стандартов ЕСПД морально устарела. К числу основных недостатков ЕСПД можно отнести:

• ориентацию на единственную каскадную модель ЖЦ ПС;

• отсутствие четких рекомендаций по документированию характеристик качества ПС;

• отсутствие системной увязки с другими действующими отечественными системами стандартов по ЖЦ и документированию продукции в целом, например, ЕСКД;

• нечетко выраженный подход к документированию ПС как товарной продукции;

• отсутствие рекомендаций по самодокументированию ПС, например, в виде экранных меню и средств оперативной помощи пользователю (Help);

• отсутствие рекомендаций по составу, содержанию и оформлению перспективных документов на ПС, согласованных с рекомендациями международных и региональных стандартов.

ЕСПД нуждается в полном пересмотре на основе стандарта ISO/IEC 12207 на процессы ЖЦ ПС.

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

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

Структура ЕСПД

Тем не менее, до пересмотра всего комплекса многие стандарты ЕСПД могут с пользой применяться в практике документирования ПС. Эта позиция основана на следующем:

• стандарты ЕСПД вносят элемент упорядочения в процесс документирования ПС;

• предусмотренный стандартами ЕСПД состав программных документов вовсе не такой «жесткий», как некоторым кажется: стандарты позволяют вносить в комплект документации на ПС дополнительные виды документов;

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

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

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

• дополняют выбранные программные документы нужными разделами и исключают ненужные;

• привязывают создание этих документов к той схеме ЖЦ, которая используется в проекте.

Группы стандартов ЕСПД представлены в табл.1.

Таблица 1 - Группы стандартов ЕСПД

Обозначение стандарта ЕСПД строят по классификационному признаку. Оно состоит из:

• числа 19 (присвоенных классу стандартов ЕСПД);

• одной цифры (после точки), обозначающей код классификационной группы стандартов, указанной в табл.1;

• двузначного числа (после тире), указывающего год регистрации стандарта (необязательно).

В ЕСПД существуют следующие стандарты:

• ГОСТ 19.001–77 ЕСПД. Общие положения.

• ГОСТ 19.101–77 ЕСПД. Виды программ и программных документов.

• ГОСТ 19.102–77 ЕСПД. Стадии разработки.

• ГОСТ 19.103–77 ЕСПД. Обозначение программ и программных документов.

• ГОСТ 19.104–78 ЕСПД. Основные надписи.

• ГОСТ 19.105–78 ЕСПД. Общие требования к программным документам.

• ГОСТ 19.106–78 ЕСПД. Требования к программным документам, выполненным печатным способом.

• ГОСТ 19.201–78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.

• ГОСТ 19.202–78 ЕСПД. Спецификация. Требования к содержанию и оформлению.

• ГОСТ 19.301–2000 ЕСПД. Программа и методика испытаний.

• ГОСТ 19.401–78 ЕСПД. Текст программы. Требования к содержанию и оформлению.

• ГОСТ 19.402–78 ЕСПД. Описание программы.

• ГОСТ 19.404–79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.

• ГОСТ 19.501–78 ЕСПД. Формуляр. Требования к содержанию и оформлению.

• ГОСТ 19.502–78 ЕСПД. Описание применения. Требования к содержанию и оформлению.

• ГОСТ 19.503–79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.

• ГОСТ 19.504–79 ЕСПД. Руководство программиста.

• ГОСТ 19.505–79 ЕСПД. Руководство оператора.

• ГОСТ 19.506–79 ЕСПД. Описание языка.

• ГОСТ 19.508–79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

• ГОСТ 19.604–78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.

• ГОСТ 19.701–90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.

• ГОСТ 19.781–90. Обеспечение систем обработки информации программное.

ГОСТ 19.101. Виды программ и программных документов

Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

Программу (по ГОСТ 19781) допускается идентифицировать и применять самостоятельно и/или в составе других программ. Их подразделяют на следующие виды:

• компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса;

• комплекс – программа, состоящая из двух или более компонентов и /или комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.

К программным документам относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ. Виды программных документов и их содержание приведены в табл.2.

Таблица 2 - Виды программных документов

Виды эксплуатационных документов и их содержание приведены табл.3.

Таблица 3 - Виды эксплутационных документов

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

Виды программных документов, разрабатываемых на разных стадиях разработки ПС, и их коды приведены в табл.4.

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

Таблица 4 - Виды и коды программных документов для разных стадий

Условные обозначения:

Ä - документ обязательный для компонентов, имеющих самостоятельное применение;

Å - документ обязательный;

à - необходимость составления документа определяется на этапе разработки и утверждения технического задания;

- - документ не составляют.

ГОСТ 19.102. Стадии разработки

Настоящий стандарт устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения. Стадии разработки, этапы и содержание работ должны соответствовать указанным в табл.5.

Таблица 5 - Стадии разработки программ и программной документации

Допускается исключать вторую стадию разработки, а в технически обоснованных случаях – вторую и третью стадии. Необходимость проведения этих стадий указывается в ТЗ. Разрешается объединять, исключать этапы работ и/или их содержание, а также вводить другие этапы работ по согласованию с заказчиком.

ГОСТ 19.103. Обозначение программ и программных документов

Настоящий стандарт устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

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

Устанавливается регистрационная система обозначения программ и программных документов. Структура обозначения программ и ее программного документа – спецификации представлена на рис.1.

Рисунок 1 - Структура обозначения программ и спецификации

Структура обозначения других программных документов представлена на рис.2.

Код страны-разработчика и код организации (предприятия) – разработчика присваивают в установленном порядке.

Рисунок 2 - Структура обозначения программ и спецификации

Регистрационный номер присваивают в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке. Регистрационный номер присваивается в порядке возрастания, начиная с 00001 до 99999, для каждой организации-разработчика.

Номер издания программы или номер редакции документа присваивают в порядке возрастания с 01 до 99.

Код вида документа присваивают в соответствии с требованиями ГОСТ 19.101–77.

Номер документа данного вида присваивают в порядке возрастания с 01 до 99.

Номер части одного и того же документа присваивают в порядке возрастания с 1 до 9. Если документ состоит из одной части, то дефис и порядковый номер части не указывают.

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

ГОСТ 19.105. Общие требования к программным документам

Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения и предусмотренных стандартами ЕСПД для любого способа выполнения документов на различных носителях данных.

Программный документ состоит из следующих условных частей:

• титульной;

• информационной;

• основной;

• регистрации изменений.

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

Титульная часть состоит из листа утверждения и титульного листа.

Правила оформления листа утверждения и титульного листа устанавливаются по ГОСТ 19.104–78.

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

В аннотации приводят сведения о назначении документа и краткое изложение его основной части.

Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:

• обозначение структурного элемента (номер раздела, подраздела и т.д.);

• наименование структурного элемента;

• адрес структурного элемента на носителе данных (например, номер страницы, имя файла и т.п.).

Правила обозначения структурных элементов основной части документа и их адресации устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.

Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.

О каждом изменении программного документа в части регистрации изменений делается запись в соответствии с требованиями ГОСТ 19.603.

ГОСТ 19.104. Основные надписи

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

В состав основных надписей листа утверждения и титульного листа в программных документах входят следующие структурные данные:

• наименование министерства (ведомства);

• наименование документа;

• обозначение документа;

• сведения о носителе данных, на котором представляется подлинник;

• общее количество листов утверждения, объем документа;

• сведения о разработчике;

• виза нормоконтролера;

• отметка об учете и хранении;

• сведения об изменении.

Лист утверждения выпускается на каждый программный документ на листах бумаги формата А4 независимо от вида документа, который может быть выполнен на любом носителе данных. Обозначение листа утверждения состоит из обозначения документа, к которому относится лист утверждения, и через дефис – шифра ЛУ. Лист утверждения не входит в общее количество листов документа. Лист утверждения вносят в спецификацию после утвержденного документа и хранят на предприятии – держателе подлинника документа. Лист утверждения спецификации также вносят в данную спецификацию. Копии листа утверждения высылают заказчику. Лист утверждения заполняют по форме, приведенной на рис.3.

Рисунок 3 - Форма листа утверждения

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

Выше поля 1, в правом верхнем углу, при необходимости ставится специальная отметка (гриф секретности, указания «Для служебного пользования», «С предприятия не выносить» и т.п.).

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

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

В поле 4 указывают обозначение документа и указание вида носителя данных. Вид носителя данных указывают только в случае выполнения документа на носителе данных.

В поле 5 указывают общее количество листов утверждения, например, «Листов 3». Для одного листа поле 5 не заполняют.

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

В поле 7 приводят год издания (утверждения) документа (без указания слова «год» или «г»).

Поле 8 содержит отметку об учете и хранении по ГОСТ 19.601–78; поле 9 – строку изменений по ГОСТ 19.604–78; поле 10 – литеру документа.

Титульный лист программного документа заполняют по форме и правилам, установленным для листа утверждения, при этом для следующих полей установлены правила:

• поле 1 – заполняют по требованию заказчика;

• поле 2 – не заполняют;

• поле 5 – указывают объем документа;

• поле 6 – не заполняют.

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

Содержание и правила выполнения основных надписей последующих листов программных документов, выполненных печатным способом, приведены в ГОСТ 19.106.

ГОСТ 19.201. Техническое задание. Требования к содержанию и оформлению

Настоящий стандарт устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

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

ТЗ оформляют в соответствии с ГОСТ 19.106 на листах формата А4 и при необходимости А3. Номера листов (страниц) проставляются в верхней части листа над текстом. Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104. Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать.

Для внесения изменений или дополнений в ТЗ на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к ТЗ проводят в том же порядке, который установлен для самого ТЗ.

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

• введение;

• основания для разработки;

• назначение разработки;

• требования к программе или программному изделию;

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

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

• стадии и этапы разработки.

В ТЗ допускается включать приложения.

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

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

В разделе «Основания для разработки» должны быть указаны: документы, на основании которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование и/или условное обозначение темы разработки.

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

Раздел «Требования к программе или программному изделию» должен содержать следующие подразделы:

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

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

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

• требования к составу и параметрам технических средств (необходимый состав технических средств с указанием их основных технических характеристик);

• требования к информационной и программной совместимости (требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой, необходимость обеспечения защиты информации и программ; кроме того, могут указываться протоколы межмашинного сетевого обмена данными, стандарты протоколов формализации данных и управления терминалами, стандарты и форматы сообщений, протоколы транзакций, протоколы запросов данных, стандарты представления данных, требования к СУБД и операционным системам);

• требования к маркировке и упаковке (к маркировке программного изделия, варианты и способы упаковки);

• требования к транспортированию и хранению (для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях);

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

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

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

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

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

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

Задания к практической работе

Результаты анализа и выбора номенклатуры и мер характеристик качества ПС должны быть документированы в ТЗ. Данная практическая работа является продолжением работы № 9, т.е. результаты анализа и выбора номенклатуры и мер характеристик качества ПС должны быть документированы в ТЗ. При этом должны быть выполнены все требования по структуре, содержанию и оформлению ТЗ.

1. Изучите и законспектируйте теоретический материал «Единая система программной документации», обратив особое внимание на следующие вопросы:

• структура ЕСПД;

• виды программ и программных документов;

• обозначение программ и программных документов;

• требования к оформлению программных документов;

• требования к содержанию и оформлению ТЗ.

2. Ответить на контрольные вопросы.

3. Используя результаты практической работы № 9, разработать техническое задание на заданное ПС, выполнив требования ЕСПД к содержанию и оформлению ТЗ.

4. Отчетом по практической работе является оформленное ТЗ.

Контрольные вопросы

1. Краткая характеристика стандартов ЕСПД, их недостатки. 

2. Структура стандартов ЕСПД.

3. Какие вы знаете виды программных документов?

4. Какие вы знаете стадии и этапы разработки программ и программной документации? Какие работы на них выполняются?

5. Правила обозначения программ и программных документов.

6. Из каких условных частей состоит программный документ?

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

Скачано с www.znanio.ru