Проверяемая спецификация программного продукта

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

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

Пользовательские роли, программные модули, данные и внешние интерфейсы соединены с техническим заданием, матрицей тестов и интерфейсом готовой программы

Что за услуга?

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

Техническое задание на программное обеспечение фиксирует границы системы, роли, функциональные и нефункциональные требования, модели данных, интеграции и критерии приёмки. S.O.L CORP уточняет исключения, права доступа, производительность и эксплуатацию. Документ создаёт общую основу для заказчика, разработчиков, тестировщиков и будущей поддержки.

Практическая ценность

Что получает заказчик после подготовки ТЗ

Иконка: Определённый продукт

Определённый продукт

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

Иконка: Проверяемые требования

Проверяемые требования

Функция или показатель имеют условия, результат, обработку ошибки и метод проверки, а не остаются пожеланием.

Иконка: Сравнимые предложения

Сравнимые предложения

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

Иконка: Контроль изменений

Контроль изменений

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

Когда нужен документ

В каких ситуациях требуется отдельное ТЗ на программу

Иконка: Новая программа или модуль

Новая программа или модуль

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

Иконка: Сложный состав компонентов

Сложный состав компонентов

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

Иконка: Интеграции и обмен данными

Интеграции и обмен данными

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

Иконка: Тендер или сравнение подрядчиков

Тендер или сравнение подрядчиков

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

Иконка: Модернизация существующего ПО

Модернизация существующего ПО

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

Методика SRS-TRACE-01

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

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

  1. 01

    Назначение и границы

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

  2. 02

    Пользователи и стороны

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

  3. 03

    Среда эксплуатации

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

  4. 04

    Функции и сценарии

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

  5. 05

    Данные и состояния

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

  6. 06

    Внешние интерфейсы

    Описываем API, файлы, устройства, протоколы, форматы, события, тайм-ауты, повторы и сверку обмена.

  7. 07

    Роли и доступ

    Связываем операции и данные с полномочиями, областями видимости, разделением ответственности и аудитом действий.

  8. 08

    Правила и алгоритмы

    Формализуем расчёты, условия, приоритеты, статусы, исключения и допустимые параметры без скрытой логики.

  9. 09

    Качество продукта

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

  10. 10

    Защита и восстановление

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

  11. 11

    Поставка и миграция

    Описываем установку, конфигурацию, перенос данных, документацию, обучение, обновление, откат и передачу доступов.

  12. 12

    Проверка и изменения

    Связываем требования с тестами и приёмкой, фиксируем версии, согласование, базовую линию и оценку влияния правок.

Центральная спецификация программного обеспечения связана с границами продукта, пользователями, средой, функциями, данными, интерфейсами, доступом, качеством, безопасностью, развёртыванием и проверкой

Комплект результата

Какие материалы передаются заказчику

Иконка: ТЗ или SRS

ТЗ или SRS

Согласованная спецификация назначения, контекста, функций, данных, качества, поставки и приёмки.

Иконка: Матрица трассируемости

Матрица трассируемости

Связи между источником, требованием, сценарием, зависимостью, компонентом и способом проверки.

Иконка: Приложения по данным и интерфейсам

Приложения по данным и интерфейсам

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

Иконка: Карта верификации и приёмки

Карта верификации и приёмки

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

Выбор документа

Чем отличаются концепция, ТЗ и технический проект

ФорматКогда подходитЧто получает заказчик
Концепция программыНужно согласовать проблему, назначение, пользователей, границы и возможный вариант продукта до детализации требований.Общее видение, контекст и решения, которые требуют следующего исследования. Недостаточно для полной разработки и приёмки.
ТЗ или SRSНужно определить проверяемые требования к программному продукту и единый предмет оценки, разработки и тестирования.Согласованные функциональные и качественные требования, данные, интерфейсы, ограничения, трассируемость и приёмка.
Технический проектТребования согласованы и нужно принять архитектурные, технологические и конструктивные решения реализации.Архитектура, компоненты, взаимодействия, схемы, технологии и решения, обоснованные требованиями и ограничениями.

Инженерия требований

Как применяем SRS-TRACE-01

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

Отделяем требование от решения

Фиксируем необходимое поведение и ограничение, а технологию предписываем только при подтверждённой причине: совместимости, инфраструктуре, лицензии или политике.

Строим трассируемость

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

Проверяем наблюдаемость

Каждое существенное условие должно быть проверяемым осмотром, демонстрацией, тестом или анализом в определённой среде.

Фрагмент спецификации

Как выглядит проверяемое требование программы

Пример показывает структуру требования, а не реальную программу или готовое решение конкретного заказчика.

SRS-TRACE-04Функциональное требование с обработкой ошибки
Условие
Авторизованный оператор выбрал подтверждённую запись, заполнил обязательные поля и инициировал передачу данных во внешнюю систему.
Поведение программы
Программа проверяет данные, создаёт уникальную операцию, передаёт запрос, сохраняет идентификатор и журналирует ответ. При тайм-ауте операция остаётся в состоянии повторной проверки без создания дубля.
Наблюдаемый результат
При успешном ответе оператор видит внешний идентификатор и время обмена. При ошибке видит безопасное сообщение и статус, а администратору доступен технический журнал без раскрытия закрытых данных.
Критерий приёмки
Тест проверяет успешный ответ, тайм-аут, повтор, недопустимые данные и одинаковый запрос. В каждом случае статус, число созданных операций, журнал и отображение соответствуют спецификации.

Оценка работ

От чего зависят сроки и стоимость ТЗ на программу

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

Пример решения

ТЗ на программу обработки и согласования заявок

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

Этапы работ

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

  1. 1

    Определяем назначение документа

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

  2. 2

    Исследуем контекст

    Проводим интервью, изучаем процессы, документы, существующее ПО, данные, инфраструктуру и ограничения.

  3. 3

    Моделируем продукт

    Фиксируем границы, роли, компоненты, сценарии, состояния, сущности и внешние взаимодействия.

  4. 4

    Формулируем требования

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

  5. 5

    Строим трассируемость

    Присваиваем идентификаторы и связываем требования с источниками, зависимостями, решениями и тестами.

  6. 6

    Проверяем и согласуем

    Проводим предметную, техническую и редакционную проверку, устраняем противоречия и фиксируем открытые вопросы.

  7. 7

    Фиксируем базовую версию

    Передаём документ и приложения, утверждаем версию, порядок изменений и переход к оценке, проектированию или разработке.

Риски слабой спецификации

Какие ошибки предотвращает ТЗ на программу

Иконка: Заполнить универсальный шаблон

Заполнить универсальный шаблон

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

Иконка: Оставить качество словами

Оставить качество словами

«Быстро» и «надёжно» нельзя принять. Условие переводится в показатель, нагрузку, среду и метод проверки.

Иконка: Пропустить данные и ошибки

Пропустить данные и ошибки

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

Иконка: Потерять влияние правки

Потерять влияние правки

Изменение требования затрагивает интерфейс, данные и тест. Трассируемость показывает связи до согласования новой версии.

Опыт, экспертиза и доверие

Кто отвечает за методику подготовки ТЗ на программу

Методика S.O.L CORP основана на анализе задачи, проверке исходных данных и применении профильной документации. Для каждой услуги мы определяем состав работ, ограничения, критерии результата и порядок проверки. Решения адаптируются под конкретный проект и согласуются с заказчиком до начала реализации.

Ответственный за материал
S.O.L CORP
Область компетенции
Разработчик движка Layer и основатель S.O.L CORP. Разработка цифровых продуктов с 2017 года. Область компетенции: бизнес-анализ, требования к ПО, роли и права, модели данных, архитектура веб-систем, API, интеграции, безопасность приложений, тестирование и критерии приёмки.
Дата проверки

Вопросы и ответы

Ответы на вопросы о ТЗ на программу

Чем ТЗ на программу отличается от ТЗ на сайт?

ТЗ на программу сосредоточено на программном продукте: компонентах, среде выполнения, функциях, состояниях, данных, алгоритмах, интерфейсах, качестве, поставке и тестировании. ТЗ на сайт дополнительно подробно учитывает публичную структуру, контент, CMS, SEO, редакторские роли и веб-аналитику. Для сложного веб-приложения области пересекаются, но границы и основной объект документа всё равно фиксируются.

Обязательно ли оформлять ТЗ по ГОСТ 19.201-78?

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

Можно ли использовать ТЗ для выбора подрядчика?

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

Нужно ли выбрать технологию до написания ТЗ?

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

Входит ли прототип интерфейса в техническое задание?

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

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

Требование связывается с характеристикой качества, контекстом, показателем, ограничением и методом измерения. Например, время реакции задаётся для конкретной операции, нагрузки, объёма данных, конфигурации и процентиля, а не словом «быстро». Состав областей выбирается по рискам продукта с опорой на актуальную модель ISO/IEC 25010:2023.

Кому принадлежат ТЗ и приложения?

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

Работаете ли вы только в Санкт-Петербурге?

Нет. S.O.L CORP находится в Санкт-Петербурге и ведёт проекты по всей России. Интервью, демонстрации существующего ПО, согласование требований и проверка версий могут проходить дистанционно. Для результата важнее доступ к владельцам процессов, данным, системам и ответственным за приёмку.

Начнём с задачи

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

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

support@solcorp.ru Пн–Пт, 10:00–19:00 МСК