Как мы сделали автогенерацию документации для CI/CD из комментариев в коде

В сфере искусственного интеллекта произошло заметное событие. Меня зовут Николай Чурянин, я занимаюсь iOS-разработкой в ПСБ. Сегодня я хочу рассказать вам, как делал новую документацию для нашего модуля CI/CD. Конечно же, документация у нас была и раньше.

И даже не одна — а это, как понимаете, только усугубляло проблему. Часть документации лежала в readme-репозитории — с него-то она по сути и началась. Но обновлялась она там нерегулярно, оказалось, что работать с ней было не очень-то удобно.

Технические детали

В какой-то момент этот репозиторий перестали поддерживать, и я попытался оформить её на внутреннем портале. Увы, пользы от этого стало ещё меньше: там документация была оторвана от кода — от наших скриптов. Вдобавок, её было трудно обновлять.

Надо ли говорить, что и её забросили? «Совсем без документации тоже нельзя», — решил я и принялся искать другой способ. И нашёл его (спойлер: без ИИ тут не обошлось).

Покажу, что получилось и как всё теперь работает.

Этот прогресс даёт важные сигналы о будущем отрасли, и технологический мир внимательно наблюдает.