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