Новый взгляд на документирование API и SDK в Яндексе

Яндекс — крупная компания с большим количеством API и SDK, которым нужна документация. В какой-то момент мы поняли, что технической документации становится все больше и она слишком разная. Поэтому решили разработать внутренние стандарты для документирования API и SDK.

В докладе мы расскажем об основных этапах стандартизации: разработке общей структуры для документирования API и SDK; опыте использования универсального генератора и переходе на нативные генераторы для получения документации из кода; внедрении общих сценариев для локализации документации из кода.