Skip to Content

Технический писатель

Автор технической документации (технический писатель) - человек у компьютера. Именно он пишет Справки и Руководства с инструкциями о том, как использовать программное обеспечение и аппаратные продукты. Помимо того, что на нем лежит ответственность за подготовку технического содержания документации (в основном на английском языке), автор передает информацию в различных форматах, создает учебное видео и работает в качестве неотъемлемой части инженерных команд.
Техническая документация включает в себя информацию, которая помогает потребителям использовать конкретные продукты, для которых она была разработана.

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

Маргарита - технический писатель в VMware. Она имеет степень магистра в области химической физики и теоретической химии Софийского университета "Св. Климента Охридского".

”Я стала техническим писателем абсолютно случайно. Я начала работать в качестве химика-теоретика в компании, которая имеет дело с биоинформатикой. Завершив проект, для которого меня наняли, я хотела начать писать документацию на свою продукцию, так как у меня есть хорошее знание английского языка. В самом деле, у меня не было ни малейшего представления о том, что это за профессия, после того как я провела поиск на Google, я подумала: «Это для меня!». В итоге я пришла в компанию Sciant, которая была приобретена VMware. Когда я стала частью VMware, то была просто техническим писателем. После нескольких лет напряженной учебы и упорного труда я была повышена до старшего технического писателя. Правда в том, что в этой компании стандарт и качество работы чрезвычайно высоки. Наша самая большая проблема была в том, чтобы показать профессионализм людей, которые пишут документацию на иностранном языке. Почему? Потому что тогда наш отдел был очень маленьким, в отличие от представительств во всем мире.

Затем мы узнали стандарты DITA. DITA это архитектура на основе XML для разработки информации. Мы прошли длительный процесс обучения в компании, чтобы писать в DITA, потому что VMware является одной из первых компаний, которые приняли эту архитектуру в качестве стандарта.

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

Мои задачи и обязанности. Все что я делаю в течение рабочего дня, связано с продуктами и проектами. Как следует из названия нашего отдела - "Технические Коммуникации" - 80% времени тратится на исследования и коммуникации с различными группами в глобальном масштабе, и только 20% времени посвящены написанию документации. Нужно держать связь со всеми менеджерами, инженерами и отвечать на вопросы, связанные с продуктами.
Мы часто редактируем и переписываем. Мы часто говорим по телефону - с коллегами из разных мест. Не только для координации работы над проектом, но и чтобы узнать что-то новое, связанное с профессией. В нашей работе всегда есть место для совершенствования и изменения, и это то, что хорошо - технология постоянно развивается, а вместе с ней и мы.

Инструкции предназначены, чтобы помочь людям, и я могу смело сказать, что документация VMware читаема и любима нашими пользователями. Лучшая вещь для меня - наконец увидеть готовый продукт - все написанное в день релиза. Это кайф, даже в три часа утра, когда я вижу, как документация доступна для тысяч клиентов со всего мира. Невероятно интересно быть частью чего-то большого».

Курт Воннегут, который в начале своей карьеры работал в качестве технического писателя для General Electric, описывает этих писателей, как людей, которые "... которые обучаются не раскрывать ничего о себе в письменной форме".

Голосов пока нет