✱ Подходы, инструменты, стандарты
Техническая документация после разрыва технологической цепочки, или вечером код — утром дока
Techwriter Days #2
2025-03-28 12:20
Секция D
20 мин
Средне
Спикеры
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Привет! Если вы пропустили наш последний выпуск конференции Techwriter Days 2, у нас есть хорошая новость. На нашей сцене выступила Дарья Ганицева, и провела потрясающий доклад о том, как минимальными ресурсами подготовить полторы тысячи документов на новый телекоммуникационный продукт. Дарья, имея более двадцатилетний опыт в телекоме, в 2023 году присоединилась к компании Ядро и с головой окунулась в новый проект. Вместе с командой ей удалось разработать уникальные процессы взаимодействия между техническими писателями, продукт-менеджерами и разработчиками, что позволило синхронизировать документирование с процессом разработки.
Дарья поделилась опытом создания четкой и качественной документации, ставящейся наравне с самим продуктом. Она рассказала о сложностях, с которыми столкнулась команда: от необходимости автоматизации процессов до построения взаимодействия в Jira. Гибкость и экспертиза специалистов команды позволили выйти на высокий уровень качества. Хотите узнать больше о том, как всё получилось?
После ухода иностранных производителей телекоммуникационного оборудования из России, мы в YADRO начали создание собственного оборудования. Заказчик требует отчеты о прогрессе разработки продукта в виде документации, а наличие ее в полном комплекте на момент готовности продукта критично.
В нашем случае комплект документации, который включает в себя порядка 1300 документов (описания программного обеспечения, эксплуатационную документацию и т.д.), должны оформить 9 технических писателей за 3 года.
Мы настроили подготовку документации так, что команда технических писателей работает вместе с R&D и продакт менеджментом с самого начала разработки. Это позволяет передавать заказчику часть документации уже сейчас и иметь финальный комплект к моменту заказов и поставки.
В своем докладе я хочу поделиться нашим опытом – как описывать то, чего нет? От процессов до минусов и подводных камней.
Доступно только после покупки 😊
