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