знакомьтесь — ТЕХНИчЕСКИЙ ПИСАТЕЛЬ

IT-CAREER
TEST-DRIVE
Знакомьтесь —
технический писатель
Для многих уже не секрет, что сфера IT-технологий является одной из наиболее развивающихся
в современном мире. И никто не сомневается, что эта сфера продолжит свое развитие, поскольку
мы живем в век колоссальных технических достижений и любой механизм или аппарат будет
совершенствоваться, чтобы отвечать запросам требовательного времени.
ОБ АВТОРЕ
Сергей Нехай
2004 — закончил МГЛУ,
факультет английского языка
С 2004 по 2007 —
ИП «Лаппа», программист-писатель
2007 — сотрудник Epam,
технический писатель
2007 — проект Reuters
Оглянитесь, и вы обнаружите множество устройств, без которых уже не
можете представить свою жизнь, устройств,
которые уже стали неотъемлемой частью
нашей жизни. Когда мы впервые сталкиваемся с каким-нибудь девайсом, первое, что
мы хотим сделать, — это «потрогать» его,
чтобы понять, как он работает. Некоторые
приходят к познанию нового предмета в их
жизни методом проб и ошибок, некоторые
просят о помощи своих родных и знакомых,
кто-то предпочитает открыть инструкцию
либо раздобыть книгу. Вот здесь пользователи и сталкиваются с представителем
новой профессии — техническим писателем
(technical writer). За рубежом эта профессия
насчитывает уже несколько десятков лет,
но у нас она достаточно молода: появилась
вместе с первыми минскими компаниями,
специализирующимися на контрактной разработке программного обеспечения. Порой
заказы включали в себя пакет технической
документации, касающейся выпущенного
софта, а для ее создания компании были
вынуждены нанимать нового специалиста
— технического писателя.
Who is ТЕХПИС?
Так кто же такой технический
писатель (сокр. техпис)? Это тот человек, призвание которого — помогать нам
овладевать новыми технологиями, будь то
модное устройство либо новая программа.
От этих людей отчасти зависит успех
новинки, ведь именно их задача — убедить
аудиторию в ее полезности и показать, как
ей пользоваться. Некоторые из читателей
могут возразить, что вообще никогда не
открывали никаких книг либо же инструкций и при этом прекрасно овладели нужным девайсом или программой.
28
Мой Компьютер №3(46) Февраль 2008
Во многом это определяется дизайном
устройства: насколько он удобен, понятен
и интуитивен. В идеале было бы неплохо,
чтобы разработчики уделяли ему максимальное внимание и пользователю с первого
взгляда было понятно, с чем он имеет дело
и как с ним совладать. Но к идеалу можно
стремиться и так никогда его и не достичь.
Потому пока потенциальному пользователю
будет что-нибудь неясно, профессия технического писателя останется востребованной
на рынке труда, ведь его задача — донести
техническую (часто сложную) информацию
рядовому пользователю, который не желает
или не хочет узнавать все технические
нюансы устройства или программы. Иными
словами, техпис — своеобразный посредник
или переводчик между техническими специалистами и пользователями.
Если говорить научным языком, технический писатель — профессиональный
писатель, который разрабатывает, составляет, поддерживает и обновляет различные
виды технической документации, онлайн
справочников, руководств пользователя,
инструкций, «белых бумаг», различных
«ЧАВО» (авт. — часто задаваемые вопросы),
спецификаций и т.д. Сферы деятельности,
где могут понадобиться услуги техписателя,
— машиностроение, приборостроение, медицинское оборудование и др. Но больше всего
в услугах технических писателей нуждаются
в сфере информационных технологий.
В зависимости от проекта, техпис может
выполнять следующие роли:
переводчик, который переводит технические идеи, концепты и процессы на
доступный язык;
хозяин, который встречает гостей в «новом,
страшном, сложном мире» и дает им возможность почувствовать себя комфортно;
друг, который помогает своим друзьям
освоить что-то новое;
сосед, который все знает и к которому
можно обратиться с любым вопросом;
учитель, который зажигает в вас искру и
вызывает желание изучить предмет;
исследователь, который уже побывал на
неизвестной территории и теперь облегчает путь своему читателю;
гид, который увлекательно рассказывает
читателям-туристам о неизвестной стране.
Писатель vs техпис
Поскольку техпис обычно работает
с объектами, процессами, системами или
абстрактными идеями, то язык, который он
использует — утилитарный, с упором на точность до мелочей, а не на стиль. Техпис сосредоточен главным образом на техническом
содержании, а не авторском стиле или своих
чувствах. Однако различие между прозой и
творениями технического писателя заключается не только в содержании, но и в цели.
Главной целью техписа является как можно
более точная передача читателю технической
информации, а цель прозаика — вызвать у
читателя эмоции и мысли. И зачастую техпису
приходится жертвовать стилем и изяществом
для того, чтобы передать информацию четко,
ясно и структурно.
Техническое писательство может считаться хорошим, если оно:
технически точно;
полезно;
лаконично;
закончено;
ясно;
последовательно;
правильно с точки зрения грамматики,
орфографии и пунктуации;
направлено на соответствующую аудиторию;
хорошо оформлено и структурировано;
интересно.
Быть техническим писателем
Сам процесс написания документации
вовсе не предполагает засиживание на рабочем
месте и написание томов. Этот многоэтапный
процесс включает ряд иных задач, среди которых:
1. Определение, какая документация должна
сопровождать проект. Это может быть
мануал, онлайн справочник и т.д.
2. Составление плана для каждого документа,
который будет включен в пакет.
3. Составление проектного плана со списком
всех задач и примерный срок их выполнения.
Задачи могут включать написание плана, создание самой документации, редактирование,
создание скриншотов, графики и т.д.
4. Разработка шаблонов документации или
запрос их у дизайнера. Шаблоны включают в
себя графическое оформление документации,
форматирование, расположение текста и т.д.
5. Составление всей документации.
6. Создание графики либо помощь дизайнеру.
7. Передача документации техредактору (если
такой есть в штате) или менеджеру проекта
(директору) для проверки.
8. Внесение предложенных замечаний, исправление обнаруженных неточностей.
9. Составление индексации документов.
10. Подготовка и сдача документации в печать.
Приведенный список задач лишь
отчасти затрагивает процесс написания документации, поскольку в реальной жизни вы
едва ли дойдете до шестого пункта, так как
узнаете до этого, что разработчики добавили кучу нововведений в продукт. А потому
придется возвращаться назад, документировать их, проверять. К тому же вы вскоре
обнаружите, что программисты удалили часть
функций в
Инструменты Техписа
описываемом тво Microsoft Word
рении, не
Adobe FrameMaker
предупреAdobe PageMaker
ждая вас.
QuarkXPress
InDesign
И вот изAdobe Acrobat
за таких
AuthorIT
сюрпризов
Adobe Photoshop
приведен Paint Shop Pro
ный спиAdobe Illustrator
сок задач
Microsoft Visio
техписа
RoboHelp
только
Doc-To-Help
примерно
Help-and-Manual
отражает
его работу.
Остановимся подробнее на процессе
написания документации. Главной задачей,
как уже было сказано, является передача
читателю информации, способной помочь
освоить новую технологию. И порой процесс
«добычи» этой информации является самой
тяжелой из задач: зачастую приходится искать
нужную информацию во множестве порой
невразумительных источников.
Одним из них может служить спецификация, которая пишется разработчиками продукта
и объясняет назначение продукта. Зачастую ее
недостатком являются наличие неточных данных, отсутствие всей необходимой информации
и вносимых в продукт изменений.
Другим источником информации могут
быть прототипы и ранние версии продукта.
Прототипы очень полезны для техписа,
поскольку он может видеть, как на самом
деле выглядит продукт, каким он предстанет
перед пользователем. Поскольку продолжается разработка, не стоит ожидать многого от
первых версий продукта. И нередки случаи,
когда программисты или дизайнеры полностью меняют интерфейс — вам приходится
полностью переписывать главы документов.
Важнейший источник точной информации о создаваемом софтвере для технических писателей — программисты, поскольку
именно они создают продукт и всегда в курсе
всех изменений, как текущих, так и предстоящих. Потому первым делом в начале работы
над проектом стоит подружиться с ними и
заручиться их поддержкой. Поскольку у них
много своей работы, важно не переступить
черту и не стать слишком навязчивым: коллеги будут избегать встречи с вами — необходимо быть дипломатом и детективом, чтобы
раздобыть необходимые сведения.
Карьера
У вас есть два пути, которые можно
выбрать, если вы решите стать техническим
писателем: быть фрилансером (англ. freelancer
IT-CAREER
TEST-DRIVE
Типичный процесс создания технической документации
Программисты пишут код
Три группы начинают работу над проектом
Достигнута точка, когда продукт болееменее готов, и объявляется первая,
Альфа-версия продукта
Но группы все еще продолжают
работать над продуктом
Дизайнеры разрабатывают
интерфейс пользователя
Техписы приступают
к написанию документации
Альфа-версия
Программисты добавляют/
редактируют функциональности
Продукт проходит тщательную проверку
перед тем, как перейти к следущей фазе
Появление новых требований, возврат
к Альфе. Повторяется пока Бета-версия
не будет принята, будет выполнен заказ или отменен
— внештатный сотрудник) либо же записаться
в ряды какой-нибудь софтверной компании
— каждый из путей не лишен своих минусов.
Не следует рассчитывать на быстрый
карьерный рост, поскольку в Беларуси есть
всего несколько компаний, у которых имеется
свой отдел писателей. Если вы окажетесь в
штате подобной организации, скорее всего,
вас ожидает карьерный рост, кстати, очень
схожий с таковым у программистов Junior
Technical Writer, Technical Writer, Senior
Technical Writer, Lead Technical Writer, Chief
Technical Writer. Если же вы единственный
представитель этой профессии в своей компании, также нет причин унывать: в случае
успеха вас тоже ждет своеобразный рост —
повышение заработной платы, шанс получить
другую профессию или возглавить команду,
отдел, а в перспективе даже компанию. Здесь
все зависит от вас, ваших способностей,
целей и путей их реализации.
Техпис — нахлебник или
ценный работник?
Мне довольно часто доводилось слышать от знакомых, что многие IT-специалисты считают техписа ненужным работником.
Некоторые также убеждены, что с обязанностями техписа в компании вполне могут
справляться сами девелоперы. С этой точкой
зрения нельзя согласиться, поскольку я еще
не встречал ни одного технического специалиста, который бы грамотно писал документы.
Также приходится слышать от программистов,
что они больше всего не любят составлять
документацию к тому, что сами создают.
Как писатель, полагаю, что наша работа
невероятно важна, что документация является
жизненно важной частью любого продукта:
она — часть пользовательского интерфейса,
именно от нее может зависеть впечатление
заказчика о выполненной работе.
Очевидны преимущества наличия среди
сотрудников техписа: всегда рядом специалист, способный подсказать решение проблем
с переводом (и не только с английского),
снять часть ваших обязанностей (написание
документов) и самое приятное — есть умный
собеседник, за разговором с которым можно
коротать время, обсуждая проект и делясь
дружелюбными критическими замечаниями.
Критический взгляд
Очень часто приходится слышать, что
никто не читает документацию, написанную
техписами: зачем тогда лезть из кожи вон,
чтобы сделать ее первоклассной?
К сожалению, это правда. Люди часто не
уделяют ей внимание, потому что она не доступна, написана не для той аудитории или же
слишком скучна. Согласитесь, многие, увидев
инструкции в несколько сот страниц, удивленно
восклицают: «Вы что, шутите?!», а затем откла-
Дизайнеры редактируют
элементы оформления
Техписы обновляют документацию,
чтобы та соответствовала
требованиям Альфы
Бета-версия
Нет
Принятие Бета-версии
дывают ее в сторону, надолго или навсегда.
Но не все так безнадежно: на данный
момент некоторые журналы (PC Magazine,
Software Magazine и др.) при рассмотрении
игр, программного обеспечения оценивают и
документацию к ним, тем самым повышая ее
значимость. Даже если ваш продукт не будет
участвовать ни в каких конкурсах, то, по крайней мере, единицы покупателей прочтут всю
прилагаемую документацию — стоит постараться и не «подмочить» репутацию компании
и собственную: в тексте присутствует ваше
имя, и, если он хорош, то может послужить
отличным дополнением для вашего портфолио или резюме.
В целом, мне сложно сказать, как стоит
относиться к профессии техписа. Я своей работой горжусь, она мне очень нравится: люблю
вникать в технические вопросы каждого процесса, выпытывать у программистов важные
мелочи, чтобы затем перевести это на язык
рядового пользователя, вкладывать частичку
себя в каждый документ, видеть затем на нем
свое имя и особенно — получать положительные отзывы от заказчика и менеджеров.
Техник + гуманитарий = техпис
Чтобы стать первоклассным техписателем, нужны знания, и лингвистические, и
технические. Таких мало, так как одинаково
хорошо овладеть обширными знаниями в
обеих сферах труднодостижимо, и именно
поэтому любой потенциальный работодатель
будет согласен выложить кругленькую сумму
за такого сотрудника.
Я считаю, что лингвистическое образование должно быть обязательным для
технического писателя, поскольку никакие
языковые курсы не помогут хорошо овладеть
языковой стороной процесса и отлично писать
документацию, учитывая все особенности
синтаксиса, стилистики иностранного языка.
С другой стороны, далеко не каждый лингвист
сможет стать превосходным техписом, ведь
им очень сложно разобраться в технической
специфике того или иного процесса.
Какими же знаниями, умениями и
качествами нужно обладать, чтобы преуспеть в этом? Можно выделить несколько
групп способностей.
Языковые способности:
хорошее знание языка (грамматика, орфография, пунктуация);
способность к написанию различных
текстов;
навыки редактирования.
Технические знания:
знание ОС (Windows, Macintosh, Linux);
навыки программирования;
навыки дизайна.
Личные качества:
самомотивация;
навыки работы с людьми;
Да
умение распоряжаться временем;
навыки проведения интервью;
чувство юмора;
умение быстро изучать новые программы и
инструкции;
умение доводить дело до конца.
Но обладать всеми перечисленными
умениями недостаточно, нужно постоянно
совершенствоваться. Помимо чтения профессиональной литературы, изучения новых
программ, общения с хорошим редактором,
можно привести еще несколько действенных
методов: читайте и анализируйте техническую документацию, хорошую фантастику,
сценарии, детскую литературу; развивайте
навыки проведения интервью и изучайте
интерфейс-дизайн.
Если вы закончили языковой ВУЗ или
все еще учитесь в нем, или же получили
техническое образование и считаете, что
хорошо владеете английским, у вас есть
шанс овладеть интересной профессией
— желаю вам удачи в достижении поставленной цели. Дерзайте!
Полезно прочитать
The Elements of Technical
Writing by Gary Blake, Robert W. Bly
Handbook of Technical
Writing by Gerald J. Alred
Technical Writing 101: A Real-World
Guide to Planning and Writing
Technical Documentation
by Alan S. Pringle
Untechnical Writing - How to
Write About Technical Subjects
and Products So Anyone Can
Understand
by Michael Bremer
Microsoft Manual of Style
for Technical Publications
Help. Разработка справочных систем: Учебный курс
А. К. Гультяев.
PhiloSoft Technical
Communications
Ю. В. Кагарлицкий. MetaGuide. - М.:
Интернет-ресурсы
Society for Technical Communications
(http://www.stc.org ). Международная
профессиональная ассоциация,
объединяющая специалистов в области
технических коммуникаций
Портал «Все для проектировщиков
и разработчиков технической
документации» (http://www.authorit.ru )
Сообщество технических писателей
в ЖЖ (http://community.livejournal.
com/ru_techwriters)
ВАКАНСИИ EPAM’А
job@epam.by
Data architect (Data Analyst)
уверенные знания и навыки работы с
одной из перечисленных СУБД: Informix/
Oracle/MS SQL server;
опыт построения аналитических отчетов с применением OLAP на Business
Objects, SAS, Cognos или любой другой
репортинговой системы;
хороший уровень разговорного и письменного английского языка.
Разработчик баз данных
хороший уровень разговорного и письменного английского языка;
уверенные знания и навыки работы с
одной из перечисленных баз данных:
MS SQL, Oracle, DB2;
знакомство с идеологией и методологией
OLAP на концептуальном уровне (опыт
практической работы крайне желателен).
Разработчики
для платформы Microsoft .NET
опыт работы в реальных проектах
более 2 лет;
желателен опыт разработки веб-ориентированных приложений;
глубокие знания платформы Microsoft .NET;
способность общаться на английском языке.
Системный аналитик
(функциональный дизайнер)
опыт создания функциональных требований, функционального дизайна
проекта;
опыт работы с различными существующими стандартами (UML, use cases и т.д.);
уверенное знание SQL. Знание и практический опыт использования языков
программирования;
знание английского языка (upperintermediate и выше).
Специалисты по поддержке
сложных технических проектов
опыт решения нестандартных задач на
стыке программной и аппаратной части,
желателен опыт участия в проектах по
разработке ПО (веб-ориентированных
приложений);
уверенный технический английский
(письменный и разговорный);
коммуникабельность, ответственность,
терпение.
UI Designer
уверенное владение разговорным и
письменным английским языком;
глубокие аналитические способности,
быстрая обучаемость;
опыт работы в качестве веб-дизайнера
и/или дизайнера пользовательских
интерфейсов (наличие портфолио);
опыт разработки пользовательских
интерфейсов;
опыт в сфере веб-разработок;
глубокие знания в области веб-технологий: XHTML/CSS, XML/XSD/XSLT, VBS/JS;
опыт в анализе бизнес-процессов.
Переводчик/
технический писатель
профессиональное владение английским языком;
технический склад ума;
усидчивость, внимание к деталям,
высокая обучаемость.
Резюме высылать по адресу job@epam.by
Все вакансии можно найти на сайте
www.epam.by
Мой Компьютер №3(46) Февраль 2008
29