ВАШЕ ОШИБКА-API В 2:00 НОЧИ — ЭТО НЕ DX, ЭТО ИЗДЕВАТЕЛЬСТВО
Разработчик в релизной панике подключает ваш API и видит в ответ: `invalid_request`. Всё. Ни причины, ни поля, ни что чинить. Удобно? Только если ваша цель — получить злой тикет в поддержку и сорвать онбординг.
Для агентства это тот же тендерный грех, только в коде: вы просите человека быстро пройти путь, но ставите ему кривой ТЗ без критериев и без подсказок. Итог — лишние итерации, потерянное время, срыв дедлайна.
Нормальная ошибка отвечает на 4 вопроса:
- что сломалось;
- где именно;
- почему это произошло;
- как исправить.
Формат можно сделать по-человечески и без цирка: код, короткое описание, поле/параметр, ожидаемое значение, пример исправления. Да, это скучно. И это комплимент. Скучный API — это тот, который не мешает работать.
Главная метрика онбординга не «сколько страниц документации вы написали», а время до первого успешного вызова. Если оно растёт — у вас не продукт, а квест с плохими подсказками.
Tender Blackbook
@TenderBlackPro
ВАШЕ ОШИБКА-API В 2:00 НОЧИ — ЭТО НЕ DX, ЭТО ИЗДЕВАТЕЛЬСТВО
Этот пост опубликован в Telegram-канале Tender Blackbook. Подписаться можно по ссылке: @TenderBlackPro.