✱ Описание API/SDK, Docs as Code
Открывая дверь в документацию API: почему и как мы разработали свой портал
Techwriter Days #2
2025-03-29 15:00
Секция A
40 мин
Средне
Спикеры
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Открывая дверь в мир API-документации! На конференции Techwriter Days выступила Камила Мазаева, системный аналитик из Альфабанка, и поделилась опытом создания собственного портала документации. Работа с технической документацией более 6 лет позволила Камиле проанализировать проблемы, с которыми сталкиваются разработчики при интеграции API. В своём докладе она рассказала, как отсутствие наглядных примеров и сложные инструкции могут серьёзно замедлить процесс интеграции.
Камила рассказала, почему в Альфабанке решили отказаться от коробочных решений и создать независимый портал. Основной целью было сделать документацию доступной и понятной, использовав платформу GitHub и синтаксис Markdown. Однако, развитие портала не стояло на месте: они учли современные требования к API-документации, расширяя функционал портала.
Современные цифровые решения часто строятся вокруг API, что делает качество их документации критическим аспектом. Однако разработчики нередко сталкиваются с различными проблемами, такими как запутанные инструкции и отсутствие наглядных примеров, что значительно усложняет процесс разработки и мешает успешной интеграции. Чтобы решить эту проблему, мы в Альфа-Банке создали свой портал с документацией API, сделав ее максимально простой и понятной.
Этот доклад будет полезен тем, кто хочет понять, с какой стороны подойти к задаче создания собственной документации, получить сравнительный анализ инструментов и определить ключевые показатели эффективности (KPI) для своего проекта.
Доступно только после покупки 😊
