Разработка технической документации
 

Знакомьтесь - профессия Технический писатель

Знакомьтесь - профессия Технический писатель

Для многих сейчас уже не секрет, что сфера IT-технологий является одной из наиболее развивающихся сфер в современном мире. И никто не сомневается, что эта сфера  продолжит свое развитие, поскольку мы живем в век высоких технологий, и любой механизм и устройство будут совершенствоваться, чтобы отвечать запросам своего времени. Осмотрите вашу комнату, и вы обнаружите множество устройств, без которых вы уже теперь не можете представить свою жизнь, устройства, которые уже стали частью нашей жизни.
Но, когда мы впервые сталкиваемся с каким-нибудь новым устройством, первое, что мы хотим сделать - это потрогать его, чтобы понять, как оно работает. Некоторые приходят к познанию нового предмета в их жизни методом проб и ошибок, некоторые просят помощи у своих друзей, родных или знакомых, а другие предпочитают открыть инструкцию по пользованию, которая идет в комплекте, либо же раздобудут книгу, объясняющую как пользоваться тем или иным прибором. Вот здесь мы и встречаем представителей новой профессии - технические писатели (technical writer). За рубежом этой профессии уже несколько десятков лет, но у нас она появилась относительно недавно, когда в Минске начали появляться компании, специализирующиеся на контрактной разработке программного обеспечения. Некоторые заказы включали в себя пакет технической документации по выполненному продукту, поэтому компании были вынуждены набирать себе в штат нового специалиста - технического писателя.

Кто такой технический писатель?


Так кто же такой технический писатель (сокр.техпис)? Технические писатели - это те люди, которые призваны помогать нам овладевать новыми технологиями, будь то модное устройство, либо же какая-нибудь новая программа. От этих людей отчасти зависит успех новинки, ведь именно им нужно убедить читателя в пользе этой новинки и объяснить, как ей пользоваться. Некоторые из читателей могут возразить, что вообще никогда не открывали никаких книг либо же инструкций, и прекрасно научились пользоваться нужным им девайсом или программой. Еще стоит добавить, что многое зависит от дизайна новинки, насколько он дружелюбен, понятен и интуитивен. В идеале было бы неплохо, чтобы разработчики уделяли дизайну первостепенное значение, и пользователю с первого взгляда было понятно как пользоваться устройством. Но, к идеалу можно стремиться всю жизнь  и никогда не достичь его. Поэтому  пока пользователю будет что-нибудь неясно, профессия технического писателя будет востребована на рынке труда. Ведь задача техписа - донести техническую (часто сложную) информацию простому пользователю, который не желает или не хочет узнавать все технические нюансы устройства или программы. Иными словами можно сказать, что техпис это своеобразный посредник или переводчик между техническими специалистами и обычными пользователями.
Говоря научным языком, технический писатель - это профессиональный писатель, которые разрабатывает, составляет, поддерживает и обновляет различные виды технической документации, он-лайн помощи, руководств пользователя, инструкций, «белых бумаг», различных «ЧАВО» (авт. - часто задаваемые вопросы), разнообразных спецификаций и т.д. Сферы деятельности, где могут понадобиться услуги техписателя: машиностроение, приборостроение, медицинское оборудование и др. Но больше всего услугами технических писателей пользуются в сфере информационных технологий.
В зависимости от проекта, техпис может выполнять следующие роли в нем:
  • Переводчик, который переводит технические идеи, концепты и процессы на «нормальный, человеческий» язык;
  • Хозяин, который встречает гостей в новом, страшном и сложном мире, и дает им почувствовать себя как дома;
  • Друг, который помогает своим друзьям освоить что-то новое;
  • Сосед, который все знает, и к которому можно обратиться с любым вопросом;
  • Учитель, который зажигает какую-то искру в вас, и делает так, чтобы вы захотели изучить предмет;
  • Исследователь, который уже побывал на неизвестной территории и теперь расставляет всевозможные знаки и подсказки, чтобы облегчить путь своему читателю;
  • Гид, который увлекательно рассказывает читателям-туристам об иностранной стране;

Писатель VS Техпис


Поскольку техпис обычно работает с объектами, процессами, системами или абстрактными идеями, то язык, который он использует - утилитарный, с упором на точность, точность до мелочей, а не на стиль. Техпис сосредоточен главным образом на техническом содержании, а не авторском стиле или своих чувствах. Однако, различие между прозой и техническим писательством заключается не только в содержании, они различаются еще и целью. Главной целью техписа является как можно точнее передать читателю техническую информацию, а целью прозы является развлечение читателя. И зачастую, техпису приходиться жертвовать стилем, изяществом и техникой, для того, чтобы передать информацию четко, ясно и структурно.
Техническое писательство может считаться хорошим, если оно:
  • Технически точно
  • Полезно
  • Лаконично
  • Закончено
  • Ясно
  • Последовательно
  • Правильно с точки зрения орфографии, грамматики, пунктуации
  • Направлено на соответствующую аудиторию
  • Хорошо оформлено и структурировано
  • Интересно

Что делает технический писатель?

Сам процесс написания документации не значит, что технический писатель только и делает, что сидит на своем рабочем месте и пишет романы. Этот процесс включает ряд других задач, которые вам, как техническому писателю, придется выполнять. Процесс создания технической документации можно разбить на следующие этапы:
  1. Определить, какая документация должна сопровождать проект. Это может быть мануал, он-лайн помощь и т.д.
  2. Составить план для каждого документа, который будет включен в пакет документации.
  3. Составить проектный план со списком всех задач, и примерный срок их выполнения. Задачи могут включать написание плана, создание самой документации, редактирование, снятие скриншотов  (снимков экрана), рисование графики, и т.д.
  4. Разработать шаблоны документации или запрашивает шаблоны у дизайнера. Шаблоны включают в себя графическое оформление документации ,форматирование, расположение текста, и т.д.
  5. Собственно создать документацию (фактически сам процесс написания).
  6. Создать графику, либо же работа в тесном сотрудничестве с дизайнером.
  7. Отдать документацию техредактору (если такой есть в штате сотрудников) или менеджеру проекта (директору) на проверку.
  8. Внести предложенные замечания, исправить обнаруженные неточности.
  9. Сделать индексацию документов.
  10. Подготовить документацию к печати и отдать ее в печать.
Приведенный список задач, лишь отчасти затрагивает процесс написания документации, поскольку в реальной жизни вы едва ли дойдете до шестого пункта, как узнает, что разработчики добавили кучу новых функциональностей в продукт. Поэтому вам приходится возвращаться назад, документировать эти функциональности, проверять их в продукте, а затем вы можете обнаружить, что программисты также удалили несколько функций, не предупреждая вас. И вот из-за этих «приятных» сюрпризов, приведенный список задач техписа только дает некую общую идею того, с чем сталкивается обычно техпис.
Остановимся подробнее на самом процессе написания документации. Главной задачей техписа, как уже было сказано раньше, является передача читателю информации, которая ему нужна для того, чтобы освоить новую технологию. И порой, процесс «добычи» этой информации, является самой тяжелой задачей техписа. Из-за этого техписа можно назвать «добытчиком» информации - нам зачастую приходится добывать нужную информацию из различных, порой даже невразумительных источников.
Одним из источников информации может служить спецификация (сокр. - спека), которая пишется разработчиками продукта и которая объясняет назначение продукта и как он должен работать. Недостатком спек является то, что зачастую они не содержат всей необходимой информации, которая вам нужна, содержат неточную информацию, и зачастую их не обновляют, чтобы они отражали изменения, появляющиеся в процессе разработки.
Другим источником информации могут быть прототипы и ранние версии продукта. Прототипы очень полезны для техписа, поскольку он может видеть, как на самом деле выглядит продукт, т.е. каким его увидит пользователь. Но поскольку продукт находится в стадии разработки, то не ожидайте многого от первых версий продукта. И нередки случаи, когда программисты или дизайнеры полностью меняют интерфейс, и вам приходится начистую переписывать целые главы ваших документов.
Но самый главный источник информации для технических писателей - это программисты, поскольку именно они, не только создают продукт, они также в курсе всех функций продукта, а также текущих или предстоящих изменений в продукте. Поэтому первым для вас делом на проекте будет подружиться с программистами и заручиться их поддержкой. Но у программистов есть своя работа, зачастую они могут быть заняты, и тут главное не перешагнуть черту и не стать слишком навязчивым, ведь тогда они запросто могут начать избегать встречи с вами. Поэтому, вам нужно быть своего рода дипломатом и одновременно детективом, для того, чтобы раздобыть нужную информацию и передать ее обычному пользователю. 
Карьера
У вас есть два пути, которые вы можете выбрать, когда решите стать техническим писателем и зарабатывать себе этим ремеслом себе на жизнь - стать фрилансером (авт. - freelancer - внештатный сотрудник) - либо же записаться в ряды какой-нибудь софтверной компании. У каждого пути есть свои плюсы и минусы. Однако не следует рассчитывать на какой-то быстрый карьерный рост, поскольку в Беларуси всего лишь несколько компаний, у которых есть свой целый отдел писателей. Если же вы попадете в компанию со штатом техписов, то скорей всего вас ожидает карьерный рост, схожий с ростом программиста - Junior Technical Writer, Technical Writer, Senior Technical Writer, Lead Technical Writer, Chief Technical Writer. Если же вы единственный представитель этой профессии в своей компании, то не стоит унывать - вас тоже ждет своеобразный рост - повышение з/п, плюс шансы перейти в другую профессию (QA, BA, etc) или даже возглавить всю команду, целый отдел, а в перспективе, может, даже и компанию. Здесь все зависит от вас и только от вас и ваших способностей, и то, какую вы себе цель поставите, и как вы будете к ней продвигаться и будет определять ваш рост.

Техпис - разгильдяй или ценный работник?


Мне довольно часто доводилось слышать от знакомых, что многие IT-специалисты считают, что техпис это ненужный работник, что зачастую техпис ничего не делает на работе, кроме того, как общается с друзьями, или серфит по нету. Некоторые также считают, что с обязанностями техписа в компании вполне могут справляться сами девелоперы. Я с этой точкой зрения не согласен, поскольку еще не встречал ни одного технического специалиста, который бы грамотно писал документы. Также мне приходилось слышать от знакомых программистов, что они больше всего ненавидят писать документацию к тому, что они разрабатывают.
Как писатель, я полагаю, что наша работа неизмеримо важна, и что документация является жизненно важной частью любого продукта. Она является частью пользовательского интерфейса, и именно от нее может зависеть то, какое будет у заказчика впечатление от выполненного продукта.
Подумайте о преимуществе того, что у вас в офисе будет работать техпис - у вас всегда рядом будет специалист, который сможет проконсультировать вас по языку (и не только английскому), перевести что-нибудь, снять часть ваших обязанностей (написание документации) и самое приятное - у вас появится умный собеседник, с которым можно будет коротать рабочее время, обсудить ваш проект и услышать дружелюбную критику.:)

Критический взгляд на технического писателя


Очень часто приходится слышать, что никто не читает документацию, написанную техписами, зачем тогда лезть из кожи вон, чтобы сделать ее первоклассной?
К сожалению, это правда. Люди не читают документацию, потому что она не помогает, написана не для той аудитории, или же она слишком скучная. Или же люди просто не умеют читать. Многие, когда видят инструкции в несколько сот страниц, целью которых является научить пользоваться какой-нибудь программой, делают большие глаза и говорят: «Вы что шутите?» Потом они откладывают инструкцию в сторону, предпочитая разбираться во всем методом проб и ошибок.
Но не все так безнадежно, поскольку, может, именно вы сможете изменить данную точку зрения. На данный момент некоторые журналы (PC Magazine, Software Magazine и др.), которые выставляют оценку играм, программному обеспечению,  также оценивают и документацию к этим продуктам, тем самым повышая значимость документации. Даже если ваш продукт не будет участвовать ни в каких конкурсах, то, по крайней мере, один из покупателей прочитает всю вашу документацию до конца, так что постарайтесь не «подмочить» свою репутацию и репутацию вашей компании. В документации присутствует ваше имя, и, если она хорошая, то она может послужить отличным примером для включения ее в портфолио при составлении резюме.
Я не могу сказать, как должны относиться к нашей профессии техписа - это все-таки личное дело каждого человека. Я могу немного рассказать, как я отношусь к своей работе. Я горжусь своей профессией, и мне очень нравится быть техписом. Мне нравится вникать в технические вопросы каждого процесса, выпытывать из программистов самые мелочи, для того, чтобы перевести это на язык обычного пользователя, чтобы он смог понять суть того или иного продукта или процесса. Еще мне нравится писать, нравится вкладывать частичку себя в каждый документ с помощью букв, нравится, когда на документах я вижу свое имя, но больше всего нравится получать положительные отзывы о своей работе, будь то заказчик, или менеджер. Хотя кому не нравится получать их! 

Технарь +гуманитарий = технический писатель


Для того, чтобы стать первоклассным техписателем, нужны знания, как лингвистические, так и технические. Только очень тяжело найти такого специалиста, который бы одинаково хорошо владел обширными знаниями в обеих сферах. Расхожее мнение о разделении на «технарей» и «гуманитариев» подтверждает это.  Тем выше ценится такой «универсальный» специалист - любой потенциальный работодатель будет согласен выложить кругленькую сумму за такого сотрудника.
Лично я считаю, что лингвистическое образование должно быть обязательным для технического писателя, поскольку считаю, что никакие языковые курсы не помогут «технарю» хорошо овладеть языковой стороной процесса и отлично писать документацию, учитывая все особенности синтаксиса, стилистики английского языка. К тому же, спешу заявить, что далеко и не каждый лингвист сможет стать превосходным техническим писателем, ведь как ни крути, лингвист, в первую очередь, это гуманитарий, а гуманитарии, как всем известно, мыслят немного по-другому, чем те же «технари», и некоторым из них очень тяжело дается техническая специфика того или иного процесса.
Какими же знаниями, способностями, умениями и качествами нужно обладать, чтобы стать хорошим техническим писателем и преуспеть в этом? Можно выделить несколько групп знаний и умений, но это не означает, что для того, чтобы стать писателем, вам нужно овладеть ими всеми.
Языковые способности:
  • Хорошее знание языка (грамматика, орфография, пунктуация)
  • Способность сочинения различных текстов
  • Навыки редактирования
  • Технические знания:
  • Знание ОС (Windows, Macintosh, Linux)
  • Навыки программирования
  • Навыки дизайна
  • Личные качества:
  • Самомотивация
  • Навыки работы с людьми
  • Умение распоряжаться временем
  • Навыки проведения интервью
  • Чувство юмора
  • Умение быстро изучать новые программы и инструкции
  • Умение доводить дело до конца
Но обладать всеми перечисленными навыками и умениями недостаточно, для того чтобы быть хорошим писателем и расти как специалист, вам нужно постоянно совершенствоваться. Помимо чтения профессиональной литературы, изучения новых программ, общения с хорошим редактором, можно привести еще несколько действенных методов: читайте и анализируйте техническую документацию; читайте хорошую фантастику, сценарии, хорошую детскую литературу; развивайте навыки проведения интервью; изучайте интерфейс-дизайн.
Так что, если вы закончили языковой ВУЗ или все еще учитесь в нем, или же у вас техническое образование, и вы считаете, что у вас довольно хороший уровень языка, и вы загорелись желанием стать техническим писателем, то я хочу пожелать вам удачи в достижении поставленной цели. Дерзайте!

Инструменты Технического писателя


  • 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
Полезно прочитать:
  1. The Elements of Technical Writing by Gary Blake, Robert W. Bly
  2. Handbook of Technical Writing by Gerald J. Alred
  3. Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation by Alan S. Pringle
  4. Untechnical Writing - How to Write About Technical Subjects and Products So Anyone Can Understand by Michael Bremer
  5. Microsoft Manual of Style for Technical Publications
  6. А. К. Гультяев. Help. Разработка справочных систем: Учебный курс.
  7. Ю. В. Кагарлицкий. MetaGuide. - М.: PhiloSoft Technical Communications, 1998
По материалам http://it-job.by

Возврат к списку


Это нравится:2Да/0Нет
Анна
Большое спасибо автору за статью.
Я очень хотела стать программистом, но не сложилось. Зато у меня никогда не было проблем с грамотным письмом. В этой профессии как раз всё пригодилось - и технические знания, и гуманитарные способности.
Имя Цитировать Это нравится:2Да/0Нет
Это нравится:0Да/0Нет
Ольга
Я верю, что данный сервис безумно полезен для людей, интересующихся технологиями и писательством, но писать "IT-технологии" в первом же абзаце ознакомительной статьи - это кощунство какое-то.
"Сфера IT-технологий" = "Сфера информационных технологий технологий"  :D
Имя Цитировать Это нравится:0Да/0Нет
Это нравится:0Да/0Нет
'''''writer''''' Zakharenko
Цитата
Ольга написал:
Я верю, что данный сервис безумно полезен для людей, интересующихся технологиями и писательством, но писать "IT-технологии" в первом же абзаце ознакомительной статьи - это кощунство какое-то.
"Сфера IT-технологий" = "Сфера информационных технологий технологий"  
Это уже давно вошло в обиход и не выглядит кощунством
Имя Цитировать Это нравится:0Да/0Нет
Это нравится:0Да/0Нет
Гость
IT-технологии = масло масляное
тавтология, плеоназм, со всеми вытекающими  :D  
Имя Цитировать Это нравится:0Да/0Нет
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Отправить Отменить