Документация достаточна, когда независимая команда может реализовать и проверить интеграцию без угадывания существенных правил. Глубина зависит от риска, сложности и договорённостей участников.
Насколько глубокой должна быть проработка документации по интеграции? Как вы определяете достаточную глубину?
Документация достаточна, когда независимая команда может реализовать и проверить интеграцию без угадывания существенных правил. Глубина зависит от риска, сложности и договорённостей участников.
Короткий ответ
Что ответить на собеседовании
Подробный разбор
Ответ с пояснениями
Документация достаточна, когда независимая команда может реализовать и проверить интеграцию без угадывания существенных правил. Глубина зависит от риска, сложности и договорённостей участников.
Минимально нужны цель, участники, контракт данных, примеры, авторизация, ошибки, таймауты, повторы и правила совместимости. Для денежных или критичных операций дополнительно описывают идемпотентность, сверку и восстановление после частичного сбоя. Детали внутренней реализации другой стороны обычно не нужны, если не влияют на контракт. Проверка достаточности — совместное ревью разработчиками и QA и разбор конкретных сценариев, а не заданное число страниц.