Оформление программной документации




 

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

 

Техническое задание (ТЗ) на разработку программного продукта выполняется согласно требованиям ГОСТ 19.201-78 ЕСПД. «Техническое задание. Требования к содержанию и оформлению», переизданного в ноябре 1987 г.

 

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

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

Общие положения

Техническое задание оформляют на листах формата А4 и/или А3, как правило, без заполнения полей листа. Номера листов (страниц) проставляют в верхней части листа над текстом.

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

 

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

· наименование и область применения;

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

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

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

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

· стадии и этапы разработки;

· порядок контроля и приемки;

· приложения.

 

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

 

Содержание разделов

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

В разделе Основание для разработки должны быть указаны:

· документ (документы), на основании которых ведется разработка;

· организация, утвердившая этот документ, и дата его утверждения;

· наименование и (или) условное обозначение темы разработки.

 

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

 

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

Здесь можно ограничиться одной-двумя фразами. Главное – четко определить, для чего нужна эта программа.

 

Например: Программа представляет собой ядро автоматизированного рабочего места (АРМ) разработчика непрерывных линейных систем автоматического управления (САУ), позволяющее пользователю решать задачи анализа простых моделей.

 

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

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

· требования к надежности;

· условия эксплуатации;

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

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

· требования к маркировке и упаковке;

· требования к транспортированию и хранению;

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

 

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

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

 

Например: Программа должна позволять … вычислять … строить… создавать …

Исходные данные: текстовый файл с заданной …

Выходные данные: графическая и текстовая информация - результаты анализа системы…; текстовые файлы - отчеты о … диагностика состояния системы и сообщения о всех возникших ошибках.

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

 

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

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

 

Например, для программных продуктов, предполагающих использование в учебном процессе, можно ограничиться фразами типа: "Условия эксплуатации программы совпадают с условиями эксплуатации ПЭВМ IBM PC и совместимых с ними ПК", "Программа должная быть рассчитана на непрофессионального пользователя" и т.п.

Требования к составу и параметрам технических средств. Указывают необходимый состав технических средств с указанием их технических характеристик.

 

Например: Необходимо наличие IBM PC - совместимого ПК с графическим адаптером EGA (VGA). Необходимое дисковое пространство – не менее 600 Кб, объем свободной оперативной памяти - не менее 400 Кб. Желательно наличие драйвера EMS и манипулятора типа "мышь".

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

 

Например: Программа должна работать автономно под управлением ОС семейства WIN32(Windows 95, Windows 98, Windows 2000, Windows NT и т.д.).

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

 

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

 

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

 

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

 

Специальные требования – это весьма ответственная вещь и их, по возможности, целесообразно избегать.

 

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

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

 

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

При этом целесообразно привести определение (оценку) как сметной стоимости разработки программы, так и определение трудоемкости этой работы.

 

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

 

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

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

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

· Рабочий проект. На этой стадии осуществляется программирование и отладка программы, разработка программных документов, программы и методики испытаний. Подготавливаются контрольно-отладочные примеры. Окончательно оформляются документация и графический материал. Как правило, в ходе разработки программы должна быть подготовлена следующая документация:

-текст программы;

-описание программы;

-программа и методика испытаний;

-описание применения;

-руководство пользователя.

 

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

 

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

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

· структура программы;

· формат представления входных данных программы;

· общая схема алгоритма (2 листа);

· основные вычислительные алгоритмы;

· пример работы программы.

 

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

 

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

 

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

 

В Приложениях к техническому заданию, при необходимости, приводят:

· перечень научно-исследовательских и других работ, обосновывающих разработку;

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

· другие источники разработки.

 

В Приложении к настоящим методическим указаниям приведена форма технического задания на разработку программного продукта (изделия, модели).

 



Поделиться:




Поиск по сайту

©2015-2024 poisk-ru.ru
Все права принадлежать их авторам. Данный сайт не претендует на авторства, а предоставляет бесплатное использование.
Дата создания страницы: 2018-01-27 Нарушение авторских прав и Нарушение персональных данных


Поиск по сайту: