Описание API/SDK, Docs as Code
Документирование HTTP API с Foliant
Доклад был на прошедшей конференции TechWriter Days 1 и сейчас находится в архиве.
Расскажу про формирование справочников HTTP API при использовании подхода Docs-as-code на основе Foliant. В докладе будут рассмотрены несколько ситуаций, с которыми можно столкнуться при необходимости собирать справочники API: есть Сваггер; нет Cваггера, но есть спецификации; есть комментарии в коде; комбинирование разных ситуаций. Расскажу, как в каждой из ситуации можно поступить, чтобы настроить сборку справочников HTTP API. Документирование HTTP API с Foliant from Vladislav Orlikov
Другие доклады TechWriter Days 1
Найм, развитие, обучение
Ландшафт рынка труда русскоязычных техписателей по результатам большого соцопроса
section-a
UX/UI
Тексты в интерфейсах сложных B2B продуктов: как составить и где расположить
section-b
Прочее
Эмоциональный интеллект в работе технического писателя
section-c
Подходы, инструменты, стандарты
Технический писатель vs тестировщик: кто лучше напишет ПМИ?
section-c
Подходы, инструменты, стандарты
Как приручить осьминога: мировые тренды в порталах документации
section-a
Найм, развитие, обучение
Как карта компетенций поможет сделать level up в профессии
section-b
Подходы, инструменты, стандарты
Мастер-класс: Создание статического сайта с помощью Hugo
section-c
UX/UI
Из технического писателя в UX-писателя: как научиться писать для интерфейсов
section-a
