Стандарты разработки технической документации
Выбор шаблона технической документации (в этой статье мы будем говорить, в первую очередь, о техническом задании на разработку ПО) определяется спецификой проекта и принятыми в компании договоренности. Например, работая на госпроектах, вы будете встречаться с документами, разработанными по ГОСТ. И это один из немногих случаев, когда документы полностью соответствуют общепринятому регламентированному шаблону. Чаще техническое задание лишь опирается на один или несколько стандартов и включает в себя информацию, необходимую заказчику, команде разработки и другим заинтересованным лицам.
Ниже дано краткое описание наиболее распространенных стандартов разработки ТЗ.
ГОСТ 19
Комплекс государственных стандартов, определяющий правила разработки ПО и технической документации к ПО. Морально устаревший стандарт.
Техническое задание, разработанное в соответствии с ГОСТ 19й серии, должно содержать следующие разделы:
- Введение;
- Основания для разработки;
- Назначение разработки;
- Требования к программе или программному изделию;
- Требования к программной документации;
- Технико-экономические показатели;
- Стадии и этапы разработки;
- Порядок контроля и приемки;
в техническое задание допускается включать приложения.
ГОСТ 34
Стандарт регламентирует не только создание ПО и соответствующей документации, но и работу всей системы (сотрудники, оборудование, логистика и т.п.).
Техническое задание, разработанное в соответствии с ГОСТ 19й серии, должно содержать следующие разделы:
- Общие сведения;
- Назначение и цели создания (развития) системы;
- Характеристика объектов автоматизации;
- Требования к системе;
- Состав и содержание работ по созданию системы;
- Порядок контроля и приемки системы;
- Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие;
- Требования к документированию;
- Источники разработки.
ISO/IEC/IEEE 29148:2011
Стандарт представляет собой структурированный набор требований (функционал, производительность, конструктивные ограничения и атрибуты) к программному обеспечению и его внешним интерфейсам. Предназначен для того, чтобы установить базу для соглашения между заказчиком и разработчиком о том, как должен функционировать программный продукт. Может включать ряд пользовательских сценариев (use cases), которые описывают варианты взаимодействия между пользователями и программным обеспечением.
Структура документа:
- Введение
- Общее описание
- Функциональность системы
- Требования к внешним интерфейсам
- Нефункциональные требования
- Прочее
Шаблон спецификации требований к ПО (по К.Вигерсу)
Данный документ не является официальным комплексом требований, но de facto используется многими аналитиками как стандарт разработки спецификации.
Структура документа:
- Введение
- Общее описание
- Системные функции
- Требования к интерфейсу
- Прочие нефункциональные требования
- Прочие требования
Превью шаблона
Пример документа
Многие стандарты и методологии в области разработки ПО (например, SWEBOK, BABOK) ссылаются на рассмотренные зарубежные стандарты.