Описание API/SDK, Docs as Code
Генерация из кода: ещё один способ поддерживать актуальность документации
Доклад был на прошедшей конференции TechWriter Days 1 и сейчас находится в архиве.
Обсудим проблемы синхронизации документации и кодовой базы продукта, проанализируем причины, выработаем стратегию их решения. Узнаем, как перестроить процесс разработки так, чтобы документация всегда была актуальной. Внедрим автоматизированные инструменты генерации документации из кода. Научимся писать тесты и размечать их для генератора документации. Генерация из кода: ещё один способ поддерживать актуальность документации 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
