Шаблоны FRD: стандартный и API

Два шаблона FRD для разных ситуаций. Скопируйте нужный, заполните секции, удалите подсказки.

Как выбрать:

• Стандартный FRD — системы с UI, сложная бизнес-логика, корпоративные проекты
• API FRD — API-first продукты, микросервисы, интеграции

Подробнее о каждом формате: FRD — полное руководство.

Стандартный FRD

Полный шаблон с семью секциями. Для систем со сложными бизнес-правилами и множеством точек интеграции.

# FRD — [Название системы]

## Overview
- **Название системы:**
- **Автор:**
- **Дата:**
- **Версия:**
- **Статус:** Draft / In Review / Approved
- **Связанный PRD:** [ссылка]

## 1. Введение
### Цель
Что этот документ специфицирует и какую систему описывает.

### Скоуп
Что покрыто и что явно исключено.

### Определения и аббревиатуры
| Термин | Определение |
|--------|------------|
|        |            |

### Ссылки
- PRD: [ссылка]
- Архитектурный документ: [ссылка]
- Дизайн-система: [ссылка]

## 2. Функциональные требования

Используйте «shall» для обязательных, «should» для опциональных требований.

| ID | Требование | Приоритет | Источник | Критерии приёмки |
|----|-----------|----------|---------|-----------------|
| FR-001 |       | Must / Should | PRD §X |                 |
| FR-002 |       |          |         |                 |
| FR-003 |       |          |         |                 |

### FR-001: [Название требования]
**Описание:** [Детальное описание поведения]
**Вход:** [Что запускает это поведение]
**Выход:** [Что система производит]
**Бизнес-правила:**
- [Правило 1]
- [Правило 2]
**Ошибочные состояния:**
- [Что происходит, когда X не работает]
- [Что происходит, когда Y невалиден]

## 3. Нефункциональные требования

| ID | Требование | Категория | Целевое значение |
|----|-----------|----------|-----------------|
| NFR-001 |       | Производительность |     |
| NFR-002 |       | Безопасность |            |
| NFR-003 |       | Доступность |             |
| NFR-004 |       | Масштабируемость |        |
| NFR-005 |       | Accessibility |           |

## 4. Требования к данным

### Модель данных
[Описание сущностей и связей или ссылка на диаграмму]

### Словарь данных
| Поле | Тип | Обязательное | Ограничения | Описание |
|------|-----|-------------|------------|----------|
|      |     | Да / Нет    |            |          |

### Хранение данных
- [Политика хранения для каждой категории данных]

## 5. Требования к интерфейсам

### Пользовательский интерфейс
- [UI-спецификации, экранные сценарии, правила валидации]
- [Ссылка на вайрфреймы/мокапы в приложениях]

### Системные интерфейсы
| Система | Протокол | Формат данных | Направление |
|---------|----------|--------------|------------|
|         | REST / SOAP / MQ |     | Inbound / Outbound / Both |

### Внешние интеграции
| Сервис | Назначение | Аутентификация | SLA |
|--------|-----------|---------------|-----|
|        |           |               |     |

## 6. Критерии приёмки

| FR ID | Критерий | Метод тестирования |
|-------|---------|-------------------|
| FR-001 |        | Ручное / Автоматизированное |
| FR-002 |        |                   |

## 7. Приложения

### A. Вайрфреймы / мокапы
[Ссылки или встроенные изображения]

### B. Диаграммы состояний
[Переходы состояний системы]

### C. Глоссарий
| Термин | Определение |
|--------|------------|
|        |            |

### D. Журнал изменений
| Версия | Дата | Автор | Изменения |
|--------|------|-------|----------|
| 1.0    |      |       | Первый черновик |

API FRD

Шаблон для API-first продуктов. Фокус на эндпоинтах, схемах и обработке ошибок.

Подробнее: API FRD — руководство.

# API FRD — [Название API]

- **Автор:**
- **Дата:**
- **Версия API:**
- **Базовый URL:** `https://api.example.com/v1`
- **Связанный PRD:** [ссылка]

## 1. Обзор API
[Что этот API делает, кто его потребляет, как вписывается в систему.]

## 2. Аутентификация
| Аспект | Спецификация |
|--------|-------------|
| Метод |              |
| Token endpoint |      |
| Время жизни токена |  |
| Модель авторизации |  |

## 3. Эндпоинты

### POST /resource
**Описание:**
**Аутентификация:** Обязательна / Опционально
**Тело запроса:**
```json
{
  "field": "type (required/optional, constraints)"
}

Ответ 201:

{
  "id": "string",
  "created_at": "ISO 8601"
}

Ответ 422:

{
  "error_code": "VALIDATION_ERROR",
  "message": "string",
  "details": []
}

GET /resource/:id

Описание: Аутентификация: Обязательна Ответ 200: [схема] Ответ 404: [схема ошибки]

[Повторите для каждого эндпоинта]

4. Обработка ошибок

5. Лимиты запросов

6. Версионирование

• Стратегия: URL / Header
• Политика устаревания:
• Расписание Sunset:

7. Модели данных

[Общие схемы, используемые в нескольких эндпоинтах]

ModelName:
  field_name: type (constraints)

---

## Ресурсы

- [FRD — полное руководство](/ru/product/guides/frd/) — когда использовать стандартный, а когда API
- [API FRD — руководство](/ru/product/guides/frd/api) — спецификация на уровне эндпоинтов
- [Промпт-генератор FRD](/ru/product/prompts/frd-generator) — создайте FRD с помощью ИИ
- [Промпт-навигатор](/ru/product/prompts/navigator) — подберите нужный тип документа