Вопросы к техническому писателю

Кто такой техпис?

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

Когда нужен техпис?

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

О чём стоит поговорить?

1. Какими направлениями вы занимаетесь?
   • пользовательской документацией,
   • документацией внешних API,
   • описанием внутренних систем: от онбордингов до сложных архитектурных взаимодействий,
   • текстами для лендингов, постов, обучающих курсов.
2. Успеваете ли обновлять документацию до релизов?
3. Где ведете задачи?
   • Какой регламент движения задач?
   • Как расставляются приоритеты по задачам?
   • Кто и как оценивает задачи?
   • Есть ли перелинковка с задачами разработки?
   • Проводится ли ревью?
   • Проводится ли SEO-оптимизация?
4. Какой язык разметки используете?
5. Где храните документацию?
6. Как измеряется качество документации?
   • Посещаемость сервиса документации (DAU, MAU)
   • Отказы
   • Удовлетворенность пользователей:
     • Соответствует ли документация лучшим практикам редактуры? Есть ли редполитика, насколько она полная и соответствует стандартам отрасли. Метрика бинарная, либо соответствует, либо нет.
     • Поисковость
       • насколько успешно индексируется справка,
       • легко и найти ответ через поисковик,
       • какую позицию занимает хелп в выдаче.
     • Опрос пользователей
7. Как вы взаимодействуете с технической поддержкой и другими отделами?