Этот материал прежде всего заинтересует тех, кто хочет освоить новую и ещё не слишком известную в Беларуси ИТ-профессию — технический писатель. В канун професионального праздника «техрайтеров», который отмечается 17 декабря*, мы встретились с командой Softeq Flash Solutions по подготовке технической документации и попросили их рассказать о своей работе. О том, чем занимаются технические писатели, какие книги нужно прочитать начинающим и почему коммуникации и индивидуальный подход решают в этой профессии всё, — в нашем интервью.
Вероника Каптур и коллеги
— Расскажите, как вы пришли в профессию?
Дина Волкова: Я работаю техническим писателем уже семь лет. Всё это время я специализируюсь в области разработки устройств памяти.
Вероника Каптур: Я в профессии также давно: уже почти пять лет. Ранее работала в отделе разработки мобильных игр и приложений, была преподавателем иностранных языков (английского и испанского).
Татьяна Богдевич: Я в профессии — чуть больше года, до этого преподавала английский язык в школе и на курсах иностранных языков, был опыт удалённой работы техническим писателем, переводчиком и копирайтером, но область ИТ была мне всегда интересна.
— В обычной жизни человек встречается с трудом технических писателей в виде инструкций, например, к бытовой технике, телефонам и т.д., но ваш конечный пользователь совсем иной…
Дина: Действительно, специфика нашей работы в том, что мы пишем для инженеров. То есть, информация через нас передаётся от разработчика к разработчику.
Татьяна: А это требует от нас более глубокого понимания того, как работает то или иное приложение. Более того, нам приходится разбираться не только в software-приложениях, но и в firmware, то есть понимать, как работает железо.
Вероника: Иногда для написания одного документа нужно проинтервьюировать несколько человек. Все по-разному излагают мысли, необходимо к каждому найти подход, структурировать полученную информацию, сделать её доступной для понимания и, наконец, оформить документ в едином стиле.
Дина: Поскольку мы не имеем такого же багажа технических знаний, как разработчики, нам часто приходится не только задавать вопросы, связанные со спецификой проекта или разрабатываемого модуля, но также выяснять некоторые вещи, которые программистам кажутся очевидными. При этом мы не имеем права постесняться и не спросить, так как это влияет на точность понимания нами того или иного предмета. И поначалу, если у вас немного опыта работы в ИТ, может возникуть определённый психологический барьер.
Дина Волкова
— Как вам, девушкам с гуманитарным образованием, всё же удалось глубоко погрузиться в техническую тему и понять структуру действительно сложных проектов по разработке firmware, моделирования и др.? Насколько мне известно, вы достаточно успешно справляетесь со своей работой.
Татьяна: В этом и состоит наша цель: понять, как работает firmware, и изложить это так, чтобы нашей документацией могли пользоваться разработчики при решении своих задач. А для этого необходимо, как минимум, правильно провести интервью с самими инженерами.
Вероника: Наличие гуманитарного образования, в особенности лингвистического или филологического, может стать хорошим подспорьем в нашей профессии. Понимание же технических аспектов приходит с опытом, при условии, что есть выраженный интерес к сфере высоких технологий.
— Что должен изучить технический писатель, чтобы быть успешным?
Вероника: Мне помогло то, что я читала очень много дополнительной литературы. Кстати, на русском языке её почти нет. Также базовое представление о специфике работы в ИТ я получила на курсах тестировщика.
Татьяна: Прежде всего, слово писатель предполагает хорошее владение языком или языками, на которых создаются документы (в нашей компании это прежде всего английский). И, конечно же, необходимы заинтересованность и базовые знания в области ИТ, поэтому я прошла курсы тестировщика и получила начальные знания по программированию на курсах по PHP. Само собой разумеется, как и в любой области, важное значение имеет непрерывное самообразование: изучение специализированной литературы (желательно аутентичной — на английском языке), общение со специалистами в данной области, и даже просто чтение «чужих» документов.
Дина: Конечно же, необходимо читать профессиональную литературу: книги, блоги, статьи. Для получения дополнительных знаний в сфере ИТ я бы порекомендовала прослушать курсы по основам программирования, тестированию. Для меня одними из самых полезных были курсы «Introduction to Computer Science and Programming Using Python»:
Татьяна Богдевич
— То есть можно сказать, что технический писатель — это гуманитарий и технарь в одном лице?
Дина: Я бы сказала, что это смежная профессия, но важно понимать, что техническому писателю нужно уметь определять, какая степень понимания предмета достаточна для написания качественного документа. Здесь очень помогает аналитический склад ума.
Вероника: Также необходимо освоить навыки журналиста и дизайнера. Важно уметь задавать правильные вопросы, направлять ход дискуссии и внимательно относиться к деталям. Полученную информацию следует подавать в лёгком для восприятия виде, а это предполагает обширное использование иллюстраций и диаграмм. Дизайнерские способности пригодятся также для выбора подходящего шрифта, цветового сочетания и т.д.
— Вероника, знаю, что ты была «техрайтером» в игровых проектах. Есть ли разница?
Вероника: Разительных отличий нет. Просто приходилось делать разные типы документов. В целом, всё то же самое: интервьюирование, составление текстов, их оформление. Разница только в атмосфере. В игровых командах цена ошибки ниже и рабочая атмосфера более непринуждённая, подстёгивающая креативность. Программисты же Softeq Flash Solutions — это зрелые специалисты, которые погружены в работу настолько серьёзно, что времени на большое веселье у них нет.
— Давайте перейдём к рекомендациям тем, кто мечтает о профессии технического писателя. Насколько для этого важно образование?
Татьяна: Образование здесь не играет ключевой роли. Важно желание быть «техрайтером»: если написание инструкций, руководств пользователей приносит удовольствие — возможно, это как раз то, что вы ищете. И, конечно же, без знаний языка и интереса к предметной области здесь не обойтись. Например, техническому писателю в компании, разрабатывающей медицинскую аппаратуру, должно быть интересно разобраться в работе этой аппаратуры. Соответственно, в ИТ-области необходим интерес именно к тому узкому направлению индустрии, в котором работает компания.
— Какие книги было бы полезно прочитать и освоить будущиму техническому писателю?
Вероника: Я рекомендую:
- Microsoft Manual Style — то, с чего следует начинать.
- Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation, Second Edition.
- Developing Quality Technical Information: A Handbook for Writers and Editors.
- Grammar, Punctuation, and Capitalization: a Handbook for Technical Writers and Editors, Mary K. McCaskill.
— А какими программными продуктами должен владеть каждый технический писатель?
Дина: Всё зависит от организации, где вы будете работать, и системы по созданию и управлению документами, которая там принята. Для наших технических писателей полезны:
- MS Office (Word, PowerPoint)
- Atlassian Confluence
- Visio
- SnagIt
- Camtasia Studio
Вероника: При написании документации на игровых проектах необходимо также овладеть графическими инструментами для создания скетчей. Я использовала Balsamiq Mockups для иллюстрации будущего интерфейса мобильных приложений и Photoshop для того, чтобы показать игровой процесс (чаще всего это была совместная работа с художниками).
— И напоследок, существует ли личностный портрет технического писателя? Какими качествами он должен обладать?
Дина: Коммуникабельность, доброжелательность, умение работать в команде, желание учиться.
Татьяна: Любознательность не менее важна, не обойтись без умений структурировать и систематизировать информацию, лаконично излагать свои мысли. А также пригодятся качества, которыми обладают тестировщики: внимательность, въедливость, терпение.
Вероника: Ну, и любовь к тому, что ты делаешь. Без неё и здесь никуда.
*Официального праздника у технических писателей нет. Мы выбрали этот день четыре года назад, так как 17 декабря 1998 года была принята резолюция Совета Европы, в которой говорится о необходимости профессии технический писатель «для обеспечения потребителям доступа к адекватной эксплуатационной документации, гарантирующей корректное и полноценное использование продукта». Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси.
Релоцировались? Теперь вы можете комментировать без верификации аккаунта.