Применение documentation as code подхода для сложных интерфейсов
Тезисы
Документация, которой можно доверять и которую удобно поддерживать.
Пользовательская документация часто устаревает быстрее, чем сам интерфейс. Как сделать её неотъемлемой частью продукта, а не догоняющим артефактом?
В докладе разберём подход documentation as code и его применение в сложных интерфейсах — с множеством сценариев взаимодействия или нетривиальными данными.
Покажу, как автоматизация меняет правила игры:
• проверка ссылок и грамматики
• синхронизация выпуска продукта и документации
• удобное ревью и контроль изменений
• тестирование скриншотами для контроля расхождений между интерфейсом и документацией
• кастомные плагины и стилизация
• встраивание фрагментов документации прямо в интерфейс через API
В результате вы получите не «документацию в уголке», а полноценную часть продукта, которая живёт, тестируется и развивается как код.
Документация, которой можно доверять и которую удобно поддерживать.
Пользовательская документация часто устаревает быстрее, чем сам интерфейс. Как сделать её неотъемлемой частью продукта, а не догоняющим артефактом?
В докладе разберём подход documentation as code и его применение в сложных интерфейсах — с множеством сценариев взаимодействия или нетривиальными данными.
Покажу, как автоматизация меняет правила игры:
• проверка ссылок и грамматики
• синхронизация выпуска продукта и документации
• удобное ревью и контроль изменений
• тестирование скриншотами для контроля расхождений между интерфейсом и документацией
• кастомные плагины и стилизация
• встраивание фрагментов документации прямо в интерфейс через API
В результате вы получите не «документацию в уголке», а полноценную часть продукта, которая живёт, тестируется и развивается как код.
Информация о спикере
Иван Большаков
Ведущий инженер-программист по инструментам разработки, YADRO
.
  • Иван Большаков
    Ведущий инженер-программист по инструментам разработки
    YADRO
Все доклады секции