Rewrite technical specification in formal style

This commit is contained in:
Ruslan Bakiev
2026-05-01 11:50:58 +07:00
parent ef0622fe89
commit 46bb36d63c
12 changed files with 674 additions and 681 deletions

View File

@@ -1,58 +1,39 @@
# Нормативная база и формат ТЗ
# 1. Основания для разработки и нормативные материалы
## Базовый стандарт
## 1.1 Основания для разработки
Структура настоящего ТЗ ориентирована на `ГОСТ 19.201-78` как на базовый стандарт для технического задания на программный продукт.
Разработка программного продукта выполняется на основании следующих документов:
В практической части документ адаптирован под современную веб-разработку, потому что продукт:
- договор на разработку программного продукта №28/04-26ПО от 28 апреля 2026 года
- приложение №1 к договору: спецификация основных требований к программному обеспечению `Личный кабинет Фрегат`
- согласованные требования заказчика к клиентскому, менеджерскому, бонусному и интеграционному контурам
- действующее состояние клиентской и серверной кодовой базы, используемое как фактическая основа для детализации требований
- является B2B веб-системой
- включает несколько ролей и интерфейсов
- зависит от внешних интеграций
- разрабатывается поэтапно
## 1.2 Нормативные и методические материалы
## Принцип адаптации ГОСТ
При подготовке настоящего технического задания используется структура технической документации, соответствующая общепринятой практике составления ТЗ на программные продукты, включая подходы, применяемые в `ГОСТ 19.201-78`.
Мы не копируем ГОСТ механически, а используем его как каркас. Поэтому в ТЗ оставляем обязательную инженерную логику:
Настоящий документ устанавливает требования к программному продукту применительно к современному веб-решению с разграничением ролей, интеграцией с учетной системой, журналированием событий и поддержкой клиентских и менеджерских сценариев.
- основания для разработки
- назначение продукта
- требования к продукту
- требования к данным и документации
- этапы разработки
- порядок приемки
## 1.3 Исходные материалы для детализации требований
И дополняем это современными разделами:
При разработке технического задания использованы следующие исходные материалы:
- user flow
- экранная карта
- роли и права
- интеграции и события
- статусы бизнес-процессов
- UX/UI-этап как отдельный приемочный блок
- договорная документация заказчика
- согласованные бизнес-сценарии работы клиента и менеджера
- перечень разделов личного кабинета
- перечень основных товарных направлений и параметров каталога
- реализованные интерфейсные формы и сущности текущей версии продукта
- требования к обмену данными с учетной системой 1С
- требования к уведомлениям, бонусной программе и административным настройкам
## Разделы, которые должны быть в финальном ТЗ
## 1.4 Назначение настоящего документа
Финальная редакция ТЗ должна включать:
Настоящий документ предназначен для:
1. Основания для разработки
2. Назначение и цели продукта
3. Объект автоматизации и границы системы
4. Состав ролей и прав доступа
5. Функциональные требования
6. Нефункциональные требования
7. Требования к данным и интеграциям
8. Требования к документации и передаваемым материалам
9. Этапы выполнения работ
10. Критерии приемки
11. Приложения
## Что еще нужно будет приложить к финальной версии
- карта экранов
- перечень статусов и переходов
- перечень сущностей и их полей
- описание уведомлений
- список интеграционных точек с 1С
- перечень страниц Этапа 1
- список артефактов, передаваемых заказчику по результату
- фиксации полного объема требований к программному продукту
- определения состава реализуемых функций
- определения состава данных и интеграционных точек
- определения требований к пользовательским и административным интерфейсам
- определения критериев приемки результата работ
- определения состава артефактов, передаваемых заказчику