TGViewer
Shut up and write Shut up and write @shut_up_and_write · 641 subscribers
Post #202 908
​​Описание ошибок Plaid

В API документации Plaid большой раздел посвящен ошибкам. В нем есть список всех возможных ошибок и описание их формата. Такое можно часто встретить в документации API.

А вот что не часто можно встретить в API документации, так это детальное описание каждой ошибки, где есть:
- список методов, которые могут вернуть эту ошибку
- описание ошибки и почему она произошла
- пример ошибки
- чек-лист что делать с ошибкой

Еще из интересного в этой документации есть чек-лист для запуска проекта и диаграммы для объяснения user flow.

#makedocumentationgreat #developerexperience
More from @shut_up_and_write
  1. Feb 4, 2022Как Twilio создают документацию Пересказ доклада Twilio про пределывание их документации.…
  2. Jan 21, 2022Docs for Developers Обзор на книгу Docs for Developers: An Engineer’s Field Guide to Techn…
  3. Jan 14, 2022Про редизайн документации GitLab - 2 GitLab проводит ежегодные опросы пользователей, чтобы…
  4. Jan 7, 20222021 → 2022 Краткое содержание 2021 и тренды на 2022. Что произошло за 2021 год - Gitlab,…
  5. Dec 24, 2021​​Какой длины делать обучающие видео? Компания TechSmith, которая делает Snagit и Camtasia…
  6. Dec 17, 2021The Best Developer Portals of 2021 Объявили победителей премии The Best Developer Portals.…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →