Ringova · Внешний руководитель документации

Порядок в документации IT-компании: аудит, команда, процессы

Строила отделы документации в Ozon и Яндексе. Теперь делаю это для вашей компании: внешний эксперт, без найма в штат.

Что получите и в какой срок, фиксируем до старта

Порядок в документации IT-компании: аудит, команда, процессы

С чем ко мне приходят

Документация не успевает за продуктом

Продукт растёт, а документация осталась на уровне стартапа. Клиенты не находят ответов и пишут в поддержку. Статьи устаревают быстрее, чем их обновляют.

Аудит, приоритеты, процесс обновления: статьи меняются вместе с релизами.

Техписатели есть, а толку нет

Наняли одного-двух техписателей, но непонятно, как ими управлять. Нет стандартов, нет метрик, результат не измеряется.

Процессы, матрица компетенций, метрики: видно, что делает команда и что это даёт продукту.

Нужен отдел документации, а экспертизы внутри нет

Компания доросла до того, что без документации уже не обойтись. Нанимать руководителя в штат дорого и долго.

Найм, процессы и инструменты беру на себя. Вы получаете отдел и передаёте его своему руководителю.

Поддержка тонет в одинаковых вопросах

Первая линия перегружена, потому что пользователи не находят ответ сами. Новый сотрудник входит в курс дела месяцами.

База знаний, куда пользователь и новичок идут раньше, чем в поддержку.

Почему внешний эксперт, а не штатный руководитель

Работала на разных масштабах

Ozon и Яндекс, продуктовые команды на росте, отделы из двух человек. Знаю, какие решения подходят под какой размер.

Результат остаётся у вас

Задачу, срок и что получите на выходе фиксируем до старта. Когда ухожу, процессы и шаблоны остаются у вашей команды.

Нейросети в работе редакции

Черновики, структура, ревью. Показываю команде, где нейросети экономят часы, а где портят текст.

Найм до месяца

За годы в профессии собрала сообщество техписателей. Кандидатов беру из него, поэтому вакансия закрывается за месяц.

Кейсы

Документация с нуля в e-commerce

Проблема: компания растёт, тысячи сотрудников, документации нет. Знания в головах, новички учатся по чатам, поддержка перегружена.

Решение: построила отдел из 20+ техписателей, внедрила docs-as-code, настроила метрики и связала документацию с обращениями в поддержку.

Результат: отдел работает без меня. DAU портала документации больше 600 000.

Единые стандарты для платформы городских сервисов

Проблема: несколько крупных продуктов, у каждого своя документация или никакой. Поддержка без аналитики, команды планируют вразнобой.

Решение: провела аудит, наняла техписателей, отдала рутину поддержки нейросетям, перевела планирование на кварталы.

Результат: команды пишут по одним стандартам, поддержка тратит меньше времени на рутину, техписатели работают внутри команд разработки.

Редакция для финтех-стартапа

Проблема: финтех-продукт растёт, тексты пишут все понемногу, без стандартов и ответственных.

Решение: описала, кто нужен, настроила найм, подобрала и вывела команду из 3 человек.

Результат: отдел из трёх человек закрывает все тексты компании: документацию, интерфейсы, письма клиентам.

Сопровождение небольшого отдела документации

Проблема: отдел из 2 техписателей работает, но процессов нет: один перегружен, другой ждёт задач, руководство не видит результата.

Решение: раз в неделю разбирали работу отдела: перераспределила нагрузку, ввела один список приоритетов, который видит руководство.

Результат: те же два человека закрывают больше задач. Руководство видит, что и зачем делается.

Восемь лет в технической документации. Пять из них руководила редакцией Ozon, собрала её с нуля до 20+ человек, потом строила стандарты документации в Яндексе. Сейчас работаю с компаниями как внешний эксперт.

Автор книги «Если ты — технический писатель». Преподаю Technical Communication в Университете Иннополис. Программный директор конференции WriteConf.

Активности

  • Основатель образовательного проекта «Буквально» для техписателей
  • Куратор секций по управлению знаниями на конференциях
  • Организатор Techdoc Meetup
  • tg-канал @ringova

Есть проблема с документацией?

Расскажите, что происходит, и я скажу, чем могу помочь. Первый созвон бесплатный.

Написать в Telegram