Кто такой технический писатель
Оказывается, многие люди не знают, кто такой технический писатель, и чем он занимается. Даже ИТ-специалисты не всегда могут толком это объяснить. Поэтому первый пост в своем блоге я посвятил именно этим вопросам. Постарался быть кратким и рассказать обо всем простыми словами.
Технический писатель в IT-компании — это специалист, который пишет понятные инструкции и создает документацию для пользователей и сотрудников компании.
Представьте, что разработчики создали крутой продукт, но никто не понимает, как им пользоваться — вот тут на помощь приходит технический писатель.
Или, например, компания наняла нового сотрудника, которому нужно быстро разобраться в архитектуре и возможностях продукта, чтобы приступить к выполнению рабочих задач. Без документации и внутренней базы знаний ему будет сложно это сделать.
Основные задачи технического писателя
- Создание руководств для пользователей по работе с продуктами и сервисами
- Написание инструкций по установке, настройке и обслуживанию
- Разработка обучающих материалов для новых сотрудников
- Составление технических описаний для устройств и систем
- Создание схем, таблиц и графиков для документации
- Перевод технической документации на иностранные языки
Как работает технический писатель
- Изучает продукт или технологию
- Уточняет детали у разработчиков
- Определяет, для кого пишет материал
- Создаёт структурированный текст
- Дополняет его схемами и иллюстрациями
- Проверяет и корректирует готовый материал
- Поддерживает документы в актуальной редакции
Чем полезен компании
- Помогает сократить затраты на поддержку клиентов
- Ускоряет процесс обучения новых сотрудников
- Делает продукты более понятными для пользователей
- Снижает количество ошибок при использовании продукта
Что должен знать и уметь
- Умение понятно объяснять сложные вещи
- Навыки работы с документацией
- Способность работать с разными инструментами (графическими и текстовыми редакторами, системами управления контентом)
- Базовые технические знания концепций, сервисов, технологий и нормативов
- Умение читать и понимать программный код
- Развитые коммуникативные навыки
- Знание иностранных языков (как правило, английского)
Чем отличается от других специалистов
- Технический писатель отличается от обычного писателя. Он не сочиняет и не фантазирует, а описывает программные решения “как есть”. Оперирует фактами, результатами тестирования и пользовательским опытом.
- Технический писатель отличается от копирайтера. Он фокусируется на архитектуре, функционале и алгоритмах программного продукта, а не на коммерческих ценностях, конкурентных преимуществах и маркетинге.
- Технический писатель отличается от разработчиков. Он описывает программные продукты языком, понятным пользователю и специалистам других профессий. Применяет точные и емкие формулировки, приводит термины и тексты к единообразию.