✱ Подходы, инструменты, стандарты
Собрать за 60 секунд: в роли штурмана — технический писатель
Techwriter Days #2
2025-03-28 13:00
Секция A
40 мин
Средне
Спикеры
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Всем привет! Рады поделиться записью доклада от Глеба Свистунова на Techwriter Days 2. Давайте погрузимся в детали темы "Собрать за 60 секунд: в роли штурмана — технический писатель". Во время выступления Глеб рассказал о том, как его команда из компании Ядро, ведущего разработчика серверов и систем хранения данных, столкнулась с проблемой разросшихся до 400 страниц инструкций. Это не только усложняет работу сборщикам, но и тормозит процесс сборки.
Глеб предложил интересное решение — конструктор динамической документации. Этот подход упрощает задачу технического писателя и освобождает ресурсы для сборщиков. Вместо многотомной инструкции, каждый получает именно то, что ему нужно. Как это выглядит? Представьте себе, что вместо погони за нужной информацией, у вас есть четкий, лаконичный гид, созданный автоматически на основе выбранных параметров.
Часто технический писатель пишет один документ на «все случаи жизни» — спектр возможных сценариев применения может быть очень широк.
Представим, что нам надо написать инструкцию по обновлению мобильного приложения: мы заранее не знаем, какое железо будет у пользователя, даже не знаем, планшет или телефон, какая ОС и какой версии, с какой версии необходимо обновляться. Перечисление возможных условий усложняет текст. Такую документацию сложно не только разрабатывать, но и читать — приходится изучить все возможные варианты и выбрать комбинацию нужных.
Мы в Yadro выработали подход к разработке динамического документа под изменяющиеся условия. Рассмотрим его на примере работы технического писателя производственного направления YADRO.
Доступно только после покупки 😊