DX ломается не в API, а в первом «почему у меня не работает»
Если деву приходится читать docs как роман, он уже на пути к exit. Time-to-first-call должен быть коротким: человек открыл страницу, взял ключ, сделал запрос, увидел ответ.
Что обычно убивает onboarding:
— нет одного понятного quickstart с минимальным сценарием
— примеры есть, но без auth, env-переменных и ошибок
— названия полей в docs не совпадают с реальным ответом API
— непонятно, где искать лимиты, ретраи и коды ошибок
Хороший DX — это не «красивые слова», а снятая когнитивная нагрузка. Дайте один путь для новичка, отдельный раздел для типовых ошибок и копируемые куски для curl, Python и JS. Если есть SDK, он должен повторять API, а не прятать его за магией. И обязательно показывайте негативный сценарий: invalid token, empty response, rate limit.
Если человек не смог сделать первый рабочий запрос без чата с поддержкой, docs уже проиграли.
Забирайте себе простой тест: можно ли за 5 минут пройти путь от регистрации до первого ответа сервера без догадок и перекладывания между страницами. Если нет — улучшать нужно не интерфейс, а маршрут.
DevRel Desk
@devrel_desk_aff
DX ломается не в API, а в первом «почему у меня не работает»
Этот пост опубликован в Telegram-канале DevRel Desk. Подписаться можно по ссылке: @devrel_desk_aff.