Описание API/SDK, Docs as Code
Мастер-класс: REST and Peace: пишем спецификацию OpenAPI в Redocly
Доклад был на прошедшей конференции TechWriter Days 2 и сейчас находится в архиве.
На мастер-классе я расскажу о спецификации OpenAPI в интерактивном формате. Мы посмотрим строение API-запроса и спецификации, потренируемся отправлять запросы, а также соберем документацию в Redocly. Вы узнаете, почему мы выбрали Redocly, а также о том, какие фишки наша команда добавила на наш портал документации API. Для участия в мастер-классе вам понадобятся: Ноутбук с интернетом Командная строка VSCode или любая другая IDE
Другие доклады TechWriter Days 2
Подходы, инструменты, стандарты
Разговор с командой разработки на одном языке нотаций… Или как приручить лису
section-a
Наём, развитие, обучение
Время собеседований. Кто такой технический писатель: разработчик или писарь?
section-b
Процессы
Четыре причины, чтобы перестроить работу с текстом. Опыт редакции Госуслуг
section-c
Подходы, инструменты, стандарты
Инструкция для инструкции. Как написать гид по стилю
section-d
Подходы, инструменты, стандарты
Как скрестить ежа с ужом. Или как новые требования влияют на нашу работу
section-a
Управление знаниями
Спасти нельзя стереть, или генеральная уборка для вашей БЗ
section-b
Подходы, инструменты, стандарты
Технический долг в работе писателя
section-c
ИИ в документации
Подводные камни при внедрении ИИ с точки зрения технического писателя
section-c
