Фантастические техписы и места их обитания
Доклад отклонён
Целевая аудитория
Тезисы
— Кто-нибудь знает, как это работает?
— Петя знал. Но уволился.
— А документация?.
— Была у Пети в чертогах разума.
— О нет, мы запустили новый продукт, а пользователи не разобрались в интерфейсе!
— Может, пересмотреть интерфейс?
— Нет! Есть идея лучше! Давайте опишем напишем к нему инструкцию!
— Мы большая серьёзная компания.
— А документация у вас есть?
— Ну у нас есть Вася. Он умеет много чего. И писать документацию по ГОСТам.
Если эти ситуации вам знакомы и защемили сердечко — доклад поможет разобраться как всё это чинить и чьими силами.
Имя вашему спасителю — технический писатель. Вот какими они бывают:
- Командные домовые: сидят с одним отделом, внимательно переваривают всё, что делает разработка, пишут онбординги, описания систем и другие полезные конкретной команде документы. Умеют читать и писать код, могут найти проблемные места в архитектуре и в целом напоминают домовят, благодаря которым всегда понятно, что происходит и где почитать.
- Продуктовые гномы больше напоминают серьёзную гильдию шлифовки внешних инструкций и добычи полезных знаний из заказчиков. Такие команды, как правило, самые большие и работают по принципу заказной разработки.
- Нормативные феи. Самый загадочный для меня тип, но самый распространённый. Благодаря этим техписателям компания может быть уверена, что на любой вопрос аудитора найдётся корректный документ или шаблон.
У каждого из них есть свои особенности — посмотрим примеры документов, требования к навыкам и метрики. А ещё сформулируем триггеусловие, после которого вам надо открывать вакансию на именно этого специалиста.
Руководитель отдела технической документации. В техписательстве с 2018 года, в IT — со школы.
Ozon Tech
Видео
Другие доклады секции
KnowledgeConf: Коммуникация и связи между отделами