Описание API/SDK, Docs as Code
Открывая дверь в документацию API: почему и как мы разработали свой портал
Доклад был на прошедшей конференции TechWriter Days 2 и сейчас находится в архиве.
Современные цифровые решения часто строятся вокруг API, что делает качество их документации критическим аспектом. Однако разработчики нередко сталкиваются с различными проблемами, такими как запутанные инструкции и отсутствие наглядных примеров, что значительно усложняет процесс разработки и мешает успешной интеграции. Чтобы решить эту проблему, мы в Альфа-Банке создали свой портал с документацией API, сделав ее максимально простой и понятной. Этот доклад будет полезен тем, кто хочет понять, с какой стороны подойти к задаче создания собственной документации, получить сравнительный анализ инструментов и определить ключевые показатели эффективности (KPI) для своего проекта.