Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Зачем мне технический писатель?

14.10.2015

01«Зачем мне технический писатель, если есть разработчик продукта, который запросто сможет создать документацию к нему?» – такой вопрос часто задают себе руководители компаний по разработке программного обеспечения. Те из них, кто в ходе рассуждений приходят к выводу, что технический писатель в компании не нужен и со всеми задачами по документации справятся разработчики – не правы. Почему – вы узнаете из сегодняшней статьи.

Если ваша компания небольшая и задачи по документированию есть не постоянно, всё равно отдавать их разработчикам продукта – не эффективно. В таких случаях лучшим решением оказывается передача задач по разработке документации на аутсорсинг. Мы оказываем услуги по разработке текстов на аутсорсинге, обучаем технических писателей, а также помогаем компаниям с наймом технических писателей, и будем рады оказаться полезными вашей компании.


Большинство образованных людей пишут достаточно хорошо, но написание технических материалов, таких как руководства пользователя программы или отчёты о научных исследованиях, требуют специфический набор навыков. Изучение теории и постижение практического опыта, связанного с профессией технического писателя, требует времени. Нанимая опытного технического писателя, вы получаете следующие преимущества:

  • Более чёткие коммуникации
  • Сниженные затраты на техническую поддержку
  • Сниженные затраты на документацию

Более чёткие коммуникации

Технические писатели яснее излагают информацию:

  • Большинство учёных, инженеров, программистов и других разработчиков продуктов являются экспертами в своей области, но они пишут доступно только лишь для равной себе аудитории. Но руководство к продукту в большинстве случаев предназначено для совершенно другой аудитории: пользователей продукта, которые знают о нём значительно меньше его разработчиков.
  • Технические писатели являются переводчиками с жаргона разработчиков на простой язык, который требуются пользователям продукта. Это также верно и для нетрадиционных продуктов, таких как информация сама по себе (например, сведения о передаче технологии).
  • Слова – не всегда лучший способ донести идею. С умом подобранное сочетание слов и графики часто справляется эффективнее.
  • Технические писатели могут помочь вам изменить пользовательский интерфейс продукта, чтобы снизить потребности в документации – иногда настолько, что хватит на оплату труда писателя.
  • Документация хорошего качества хорошо влияет на вашу компанию. Читатели часто предполагают, что если документация сделана плохо, то продукт, скорее всего, не окажется намного лучше.

Сниженные затраты на техническую поддержку

Хорошие инструкции уменьшают количество обращений в отдел технической поддержки:

  • Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Вашим клиентам, которые узнали из документации, как им выполнить свои задачи, не придётся обращаться в вашу техническую поддержку.
  • Никто не читает инструкции, да? Это – миф. Как минимум, большинство людей хотя бы просматривают индекс или содержание, чтобы увидеть, сможет ли инструкция ответить на их вопросы. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию.
  • Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле. В это время они часто обнаруживают баги или проблемы с удобством использования. Устранив эти проблемы до релиза продукта, вы будете уверены, что пользователи никогда не столкнутся с ними. К тому же, технические писатели часто формируют более целостный взгляд на продукт, чем может получиться у разработчиков, которые должны сосредотачиваться каждый на своей небольшой части продукта.
  • Технические писатели накапливают полезный опыт, работая с пользовательскими интерфейсами – это то, что большинство разработчиков никогда формально не изучали. Предлагая рационализированный, более эффективный вариант интерфейса, технический писатель освобождает время разработчиков, которое они смогут потратить на более трудоёмкие задачи по созданию корректно работающего кода.

Сниженные затраты на документацию

Наём технического писателя может значительно сократить ваши затраты на документацию:

  • Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать.
  • Публикуете ли вы документацию в печатном виде или онлайн, менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё. Также на коротких документах проще сосредоточиться, соответственно улучшается качество проверки.
  • Основная работа технического писателя – писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно – он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает ваших разработчиков продукта для работы, на которую вы их наняли: разработки продукта.

Источник: Why do I need a technical writer?

Тэги: , , ,

< Вернуться к списку публикаций

Облако тегов