​​Хелп Stripe Что мне нравится в хелпе Stripe. Я выбрала St | Shut up and write

​​Хелп Stripe

Что мне нравится в хелпе Stripe. Я выбрала Stripe, потому что мне все говорят, что у них классная документация, но не говорят, почему.

Много примеров

Хорошая документация для разработчиков не бывает без примеров кода. У Stripe примеры кода есть для всего и встроены в документацию. А еще есть готовые проекты, которые можно клонировать и начать работу. Чтобы разобраться с чужим кодом было проще, есть динамические примеры, в которых объясняется каждая строчка кода. Отдельно собраны готовые no-code решения.

Не только про Stripe

В документации написано не только про Stripe, там собрана информация по предметной области, которая будет полезна тем, кто до этого не работал с платежными сервисами, как Stripe. Например, есть статья про то, как работает оплата картами онлайн.

Видео

Видео — это не самый популярный формат документации, не все пользователи будут его смотреть. Поэтому мне нравится, что видео не встроено в документацию и не перегружает ее. Но в конце каждой страницы есть ссылка на Youtube, для тех, кому не хватило текстовой версии, а еще всегда есть гугл, если разработчик ищет видео, он сможет найти официальный источник. У самого популярного видео больше 40 тысяч просмотров.

Навигация

Сайт с документацией Stripe — это именно портал разработчика. Тут разработчик может найти инструкцию, готовый пример или дополнительную информацию, перейти в личный кабинет. Информации много, но с удобной навигацией найти ее легко. Вверху страницы, сразу под строкой поиска, меню для навигации между документацией к разным продуктам. Когда вы перешли в раздел про продукт, то первая страница — это описание раздела и навигация по нему, очень удобно, что такие страницы всегда называются одинаково — Overview.

#хелплинч #makedocumentationgreat