Типовой сценарий работы технического писателя

Разработка типовых сценариев работы с системой

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters чат для технических писателей в Telegram

 Зарегистрируйтесь

Новая роль в команде: технический писатель

Привет! Я Катя, руководитель группы технических писателей в Ozon. Сейчас нас уже 9 человек и целая платформа документации, но коллеги всё ещё не всегда понимают, чем мы занимаемся.

Из непонимания появляются запросы вида: “Хотим себе собственного техписателя в команду, но не знаем, чем именно он будет заниматься”. В итоге команда подстраивается под тренды и заводит себе документацию, но через пару месяцев оказывается, что доку не читают, а техписатель плавно превратился в аналитика.  

Поэтому пришло время делиться опытом и рассказывать о каких-то концептуальных штуках ​ 

Кто вообще такие технические писатели?

Встречала разные ответы, от «ребята, которые пишут никому не нужные талмуды по ГОСТам» до вполне близких к моей реальности определений. 

В Ozon технические писатели занимаются глобально тремя направлениями: 

• пользовательской документацией (Помощь, База знаний, FAQ), 

• документацией внешних API, 

• описанием внутренних систем — от онбордингов до сложных архитектурных взаимодействий. 

Какое в итоге «правильное» занятие для техписа — поле для холивара — в Ozon вот так, в других компаниях может быть иначе. Когда я работала в Яндексе, например, конкретно моя команда не сильно занималась внутренними документами. 

Ещё к нам часто приходят просто за качественными текстами — для лендингов, постов, обучающих курсов. Нам интересно, и мы не отказываем, но не могу сказать, что это попадает под именно техническое писательство. 

При желании мы можем писать в принципе любые тексты, но будьте готовы, что от техписателя текст получится с уклоном в техническую часть, без завлекающих и рекламных заголовков. 

Технические писатели описывают, как устроены какие-то системы и как с этими системами работать. Это может быть пользовательская инструкция по оформлению возврата или схема взаимодействия методов API — но это всегда ответ на вопрос «как что-то сделать». 

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

Если у вас есть продукт, которым пользуется кто-то снаружи — час пробил. Даже если «снаружи» сидит в соседней команде. Любое погружение посторонних в ваш продукт или проект уже подразумевает документацию, а, следовательно, и позицию технического писателя. 

 Но есть нюансы: 

1. Документации нет и это не создаёт никаких реальных проблем — техписатель не нужен.  

2. Документацию уже кто-то пишет и ему проще делать это самостоятельно, чем объяснять техписателю — у вас уже есть технический писатель, только называется он «инициативный разработчик» или «ответственный аналитик». 

3. В системе часто что-то меняется — чаще, чем приходится систему кому-то объяснять — проще рассказать на словах, чем поддерживать все изменения. Часто можно сказать: «Ребята, сейчас используем вот эту штуку, документация на официальном сайте», а не расписывать подробные инструкции, которые через пару месяцев уже будут не нужны. 

Подумайте о документации как о продукте — оцените её потенциальную аудиторию и задачи, которые она должна решать. Возможно, вам нужна не документация а вебинар, скринкаст. Или даже стикерпак.  

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

Я пришла в техписательство после бакалавриата компьютерных наук в Иннополисе, года автоматизированного тестирования и академии от Яндекса. 

Кто-то приходит из лингвистов и филологов со стремлениями уйти в аналитику или разработку. Я стараюсь искать (особенно стажеров) по техническим вузам; там довольно много ребят, осознавших, что кодить 24/7 — не их стезя. А вот что-то рядом, но чуть гуманитарнее — наш идеальный кандидат. 

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

Если это ваш первый технический писатель на проекте, дайте что-то про описание процесса или архитектуры. Оцените полноту описания, структуру и термины, которые использует кандидат. Прочитайте Ильяхова или подпишитесь на рассылку о текстах, чтобы примерно понимать, где хорошо, а где не очень. Но важнее, чтобы устраивало конкретно вас и попадало в формат компании, чем полное соблюдение концептов информационного стиля и 10 баллов по Главреду. 

Как выстроить процесс?

Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача техписателя — определить, реальна ли проблема и в каком формате её нужно решать. 

 В общем виде документация создаётся по такому сценарию: 

1. Определить цель документа и его аудиторию.  

2. Набросать структуру, согласовать с заказчиком. Скорее всего, изменения будут, здесь важнее понять какие вопросы хочет покрыть заказчик. 

3. Понять, кому и по каким темам можно задавать уточняющие вопросы — найти экспертов и договориться о формате работы с ними. 

4. Наполнять документ и параллельно отдавать на вычитку коллегам-техписателям и экспертам. 

5. Финализировать структуру и тексты — обязательно отдать кому-то на вычитку и после этого презентовать заказчику. 

Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. 

Ещё один тонкий момент — что именно может править заказчик. Оговорите это сразу, при постановке задачи: важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать. 

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

Моя формула найма: 1.5 техписателя на проект. За половинку может считаться стажер или техписатель из другой команды — так есть и с кем экспертизой обменяться, и кто на время отпуска-болезни подхватит проекты. 

Нужен ли вам техписатель: чеклист 

Чтобы понять, действительно ли вам нужен технический писатель, задайтесь вопросами: 

• Кому может понадобиться документация к моему проекту? Моим же разработчикам, внешним пользователям? 

• Как проблема отсутствия документации решается сейчас? Система понятна и без дополнительного описания? Может, кто-то уже снял обзор по этой теме на YouTube? 

• Если документация всё же нужна, в каком виде её будет удобно потреблять? Всплывающие подсказки, вебинары, отдельный URL с базой знаний? 

• Чем будет заниматься технический писатель, когда напишет документацию? Продолжит её актуализировать? Перейдёт на соседний проект? 

Начинайте поиски технического писателя, только если у вас сложилась общая картинка о месте документации в вашем проекте. Отнеситесь к документации как к полноценному продукту. 

Что дальше?

Дальше — проверять полезность и качество документации, создавать и дополнять стайлгайды, развивать техписателей и повышать общую осознанность компании по теме текстов. 

И, конечно же, ждать подробностей в следующих статьях ​:)

Мы, технические писатели, частенько задаемся вопросом: а читает ли кто-нибудь нашу документацию? Для кого мы, собственно, стараемся?

Недавно я нашла ответ на этот вопрос:

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

Большинство читательской аудитории технического писателя в IT – это пользователи компьютерных программ. Аудитория это разношерстная: от новичков, для которых Интернет – это синенькая буковка “е” на рабочем столе, до продвинутых пользователей, способных обойтись без GUI и работать с программой через командную строку. Угодить им всем – не такая простая задача. Но в целом для конечных пользователей стараются писать попроще и попонятнее. Простой текст будет понятен и начинающему, и продвинутому пользователю.

Чтобы писать для конечного пользователя, обычно достаточно уметь внятно и грамотно выражать свои мысли и более-менее разбираться в предметной области, не бояться углубиться в нее. Многие из технических писателей даже не имеют специального (технического) образования. Среди нас много гуманитариев: лингвистов, филологов, психологов, педагогов – да кого угодно.

Те из писателей, кто посмелее (или кого заставило начальство), пишут уже более адресно для продвинутой аудитории: системных администраторов или специалистов по внедрению, например. Тут нужно действительно разбираться в предмете, дилетантизм недопустим. Даже если у вас нет технического образования, придется почитать и разобраться.

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

В целом, для кого бы вы ни писали, вам, конечно, придется общаться с создателями того чуда инженерной мысли, о котором нужно что-то написать. В моем случае – с программистами, системными аналитиками, проектировщиками интерфейса, тестировщиками. Нужно уметь общаться с ними на понятном им языке. И не только задавать правильные вопросы, но и понимать полученные ответы. Так что, как я уже писала выше, знание предметной области на уровне “выше среднего” совершенно необходимо техническому писателю.

Приветствуем вас, дорогие друзья!

Согласитесь, что зачастую мы обращаемся к инструкциям и другой различной документации, когда уже перепробовали все остальное. А ведь эти тексты создаются как раз таки для того, чтобы нам было проще пользоваться товарами.

Техническая документация помогает обычным людям разобраться, как правильно пользоваться тем или иным продуктом, чаще всего из сферы IT. Но она нужна и разработчикам, вносящим изменения в готовую продукцию.

А технический писатель – это и есть тот самый человек, который создает “текстовых помощников”: руководства, инструкции, технические задания, инструктажи, памятки, своды правил и т. д. Эта непростая профессия подходит для людей, которые хотят и могут работать сразу в двух противоположных направлениях: гуманитарном и техническом.

Сегодня мы узнаем, кто такой технический писатель, чем занимается, что должен знать и уметь, уровень его заработной платы, плюсы и минусы направления деятельности.

Особенности профессии

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

Пользователем может быть другой специалист, например, веб-разработчик или инженер, сотрудник техподдержки, простой покупатель без технического образования, которому надо разобраться с правилами пользования приобретенным продуктом.

Говоря кратко, техническая документация должна помочь потребителю пользоваться товаром, а специалистам должна дать понимание внутреннего устройства продукции и правил работы.

Документация, созданная для пользователей, называется внешней, а для коллег – внутренней. Особенно она необходима для других сотрудников, когда проект рассчитан на долгий период и работа над ним может передаваться от одних специалистов к другим.

Примеры результатов работы технического писателя:

• стандарты документирования;
• инструкция к смартфону или ноутбуку;
• руководство по эксплуатации метеостанции;
• сценарии для обучающих видео;
• документация для внутренних систем по информационной безопасности;
• раздел “Помощь” или FAQ на официальном сайте;
• руководство по пользованию микроволновой печью или стиральной машиной;
• технические задания для других специалистов;
• описание архитектуры программных решений;
• учебные материалы для новых сотрудников компании;
• документация к компьютерным программам;
• инструкция по сбору мебельной продукции и пр.

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

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

При разработке текстов для простых потребителей автор является посредником между покупателем и товаром, а также он выступает коммуникатором между заказчиками и исполнителями, если речь идет о написании документации для работников и создателей продукта.

Технический писатель может работать в различных сферах. Например:

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

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

Тем не менее вакантное место можно найти в крупных производственных и IT-компаниях, фабриках, заводах и т. д. Там эта специальность не менее важна, чем, к примеру, инженер или разработчик.

Автор технических статей, в отличие от копирайтера, менее погружен в творчество и больше пользуется регламентами, специфичными терминами и алгоритмами. Он должен предусмотреть всевозможные ситуации, предупредить о возможной поломке, описать ее, предложить решение, напомнить правила работы.

Часто, чтобы лучше понимать устройство, принципы работы или особенности использования товара, специалист начинает свою деятельность еще на стадии разработки. Так он может уточнять непонятные моменты, обсуждать возможные варианты дизайна, проводить тестирования, искать причины поломок и т. д.

В этих случаях писатель работает вместе с другими специалистами: бизнес-аналитиками, разработчиками, инженерами, учеными, строителями, тестировщиками, владельцами продукта и т. д.

Обязанности технического писателя

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

А у покупателя могут возникнуть трудности со сборкой или использованием. Ему непонятно, как отменить действие на аппарате, что нужно нажать, чтобы вообще включить устройство, как настроить быстрый доступ к определенным функциям.

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

В список задач технического писателя входит:

• создание руководств, инструкций, правил пользования и др.;
• сбор, анализ и систематизация информации о продукте;
• создание простых графиков и диаграмм, скриншотов, учебных видеоматериалов;
• беседа с разработчиками, менеджерами проекта, заказчиками, тестировщиками и другими специалистами для получения дополнительных данных;
• подготовка и проведение аудита технических заданий, руководств, инструкций и других документов;
• редактирование, обновление и актуализация документов и внесение правок в уже имеющуюся документацию;
• создание внутренней базы знаний;
• отправление документов на проверку, получение обратной связи и внесение коррективов при необходимости;
• подготовка отчетов о проделанной работе;
• перевод технической документации с иностранного языка, чаще английского;
• подготовка материалов для технических презентаций;
• написание технических статей или заполнение раздела “Помощь” и FAQ для официального сайта компании.

Если говорить об алгоритме работы специалиста, то он включает в себя следующие шаги:

1. Определить цель, задачи и целевую аудиторию документа.
2. Составить план и структуру будущего документа, согласовать их с заказчиком.
3. Внести изменения при необходимости и снова отправить на проверку.
4. Разобраться с особенностями продукта, расспросить о нем специалистов, задействованных в создании.
5. Заняться написанием текста.
6. Подготовить иллюстрации, схемы, диаграммы и скриншоты.
7. Отправить готовую работу на вычитку и проверку.
8. Внести правки при необходимости.

О документации необходимо думать как о продукте: зачем и кому она нужна, какие функции выполняет, можно ли вообще без нее обойтись.

Что должен знать и уметь

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

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

1. Умение составлять понятные, четкие и структурированные инструкции, технические задания, руководства и другие виды документации.
2. Умение искать и собирать информацию, анализировать и структурировать ее.
3. Грамотная устная и письменная речь.
4. Умение составлять таблицы, графики и схемы.
5. Владение иностранным языком на высоком уровне.
6. Знание специфических компьютерных программ, необходимых для работы в конкретной области деятельности.
7. Умение работать с большими объемами информации.
8. Знание языков разметки текста.
9. Навыки работы с базами данных.
10. Понимание процессов документирования.
11. Умение наглядно демонстрировать информацию.
12. Знание языков программирования.
13. Знание нормативных документов, ГОСТов.
14. Копирайтерские навыки.
15. Умение понимать, что нужно заказчику.
16. Знание графических программ.
17. Хорошее знание объекта, о котором пойдет речь в документе, а также высокий уровень понимания своей профессиональной области в целом.
18. Навыки работы с профессиональными текстовыми редакторами.
19. Наличие интереса к техническим наукам и технике.
20. Уверенное владение компьютером.
21. Навыки самоорганизации и планирования режима работы.
22. Умение упрощать сложные термины и писать более простым языком для обычных потребителей.
23. Умение быстро “схватывать” новые данные.
24. Навык быстрого переключения между несколькими задачами.
25. Умение работать в команде.

Для того чтобы стать профессионалом в своем деле, техническому писателю необходимо также обладать определенными личными качествами, которые тоже важны, как и знания, умения и навыки. В работе поможет:

• ответственность;
• наблюдательность;
• настойчивость и целеустремленность;
• перфекционизм;
• трудолюбие;
• организованность;
• усидчивость;
• активность и инициативность;
• аналитический склад ума;
• внимательность к мелочам.

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

Доход, поиск вакансий и карьерные перспективы

Как правило, есть три варианта, как специалисты попадают в эту профессию. Первый – когда человек трудится в смежной области, а потом решает сменить специальность.

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

И третья версия – человек с гуманитарным образованием не хочет программировать или что-либо разрабатывать, но при этом у него есть желание трудиться в технической сфере.

Найти вакансии можно на веб-площадках по поиску работы, например, HeadHunter. Также отыскать предложения о работе можно на официальных сайтах различных компаний.

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

Часто в вакансиях указывается договорной заработок. Он зависит от конкретных обязанностей и условий работы. В среднем заработная плата российского специалиста находится на уровне от 40 до 80 тыс. руб. В Москве оплата труда может доходить и до 150 000 руб., но это редкость.

Зарабатывать можно в качестве штатного технического писателя в компании или же можно трудиться в сфере фриланса. Во втором случае специалист может сотрудничать сразу с несколькими заказчиками. А некоторые авторы совмещают оба способа заработка.

Развивать карьеру можно через повышение квалификации и уровня навыков и умений или можно переквалифицироваться в другого специалиста. Технический писатель может стать:

• руководителем рабочей группы;
• руководителем отдела или департамента технической документации;
• UX-писателем;
• инженером по документированию;
• инженером по локализации;
• менеджером проектов;
• тестировщиком;
• разработчиком;
• бизнес-аналитиком.

Кроме этого, опытный специалист может “натаскивать” новичков, создавая различные обучающие программы. А может изучить иностранные языки и после уйти работать в иностранные компании.

Плюсы и минусы

Чтобы подытожить все сказанное, рассмотрим достоинства и недостатки профессии, которые были затронуты в предыдущих пунктах.

Положительные стороны:

• высокий уровень заработной платы;
• есть возможность работать в удаленном формате;
• специальность развивает системное мышление;
• есть карьерные перспективы.

И значительные минусы специальности:

• сложность профессии из-за двойной направленности;
• монотонность работы;
• высокая ответственность.

Обучение: онлайн-курсы и литература

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

Второй негативный момент – это отсутствие в открытом доступе достаточного количества обучающего материала. Часто это поверхностная информация, не дающая сведений об особенностях профессии в достаточной мере.

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

Чтобы самостоятельно не собирать сведения и данные о профессии, можно просто пройти онлайн-курсы технического писателя. Приведу примеры таких дистанционных обучающих программ:

• UX-писатель – Нетология
• Технический писатель – Академия АйТи
• Технический писатель – Профессиональный стандарт
• Разработка технических текстов и документации – ПроТекст
• Technical writing – IT-Academy
• Технический писатель: создание технической документации – Специалист.ru

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

Претенденты на должность должны иметь опыт работы 1–3 года, но часто работодатели пренебрегают этим правилом и берут специалистов без какого-либо опыта, чтобы он учился сразу на практике. Но портфолио у человека, откликнувшегося на вакансию, быть должно.

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

Для правильного составления технического документа советую прочитать пару-тройку полезных книг:

• В. Глаголев “Разработка технической документации”
• Н. Галь “Слово живое и мертвое”
• А. Орлов “Джедайские техники конструктивного общения”
• М. Логачев, О. Семенова “Информационные системы и программирование. Технический писатель”

Заключение

Сегодня мы рассмотрели достаточно сложную и ответственную профессию, к представителям которой предъявляется внушительный список требований.

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

Но при этом технический писатель может похвастаться хорошей зарплатой, которая иногда доходит и до 100 000 руб. Кроме того, можно зарабатывать на фрилансе, работая в компании удаленно.

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

На этом мы хотели бы попрощаться. Всего доброго и удачи!

13.09.2013

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

Работа технического писателя может быть тяжёлой, если у вас мало опыта или его нет. Но есть вещи, которые вы можете делать, чтобы увеличить свои шансы получить работу.

Вступите в STC

Прежде всего, если вы уже этого не сделали, вступите в Сообщество для технических коммуникаций (STC), профессиональную организацию для технических коммуникаторов.

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

Технические писатели в Индии могут предпочесть вступить в Сообщество технических писателей Индии (TWIN), которое содержит огромный список предложений работы.

Поиск работы онлайн

Многие работодатели никогда не рекламируют вакансии. Вместо этого они нанимают людей посредством сарафанного радио или пользуются услугами агентств, которые набирают им сотрудников. В свою очередь, эти агентства часто публикуют карьерные предложения в системах поиска работы онлайн. Чтобы их найти, наберите «поиск работы город» (где город – это название расположения, которое вам нужно) в поле для поиска вашей любимой поисковой системы. Один из самых хороших сайтов для поиска работы для северо-американских технических писателей – Dice.

Напишите резюме без ошибок

Убедитесь, что ваше резюме не содержит ошибок. Даже если у вас отличные навыки правописания, например, сделайте проверку орфографии вашего документа, прежде чем отправите его кому-либо. Также поищите слова, которые прошли проверку орфографии, но тем не менее, написаны неправильно. Например, постоянно все пишут «form» вместо «from» и «manger» вместо «manager». Убедитесь, что с точки зрения грамматики всё верно и обратите внимание на пунктуацию, особенно в конце отправляемых документов.

Существует множество веб-сайтов, посвящённых созданию резюме. Если ваши попытки добиться интервью по поводу работы оказались тщетными, вы можете проконсультироваться на одном из них. Так или иначе, покажите своё резюме другу или родственнику. Этот человек, вполне вероятно, увидит проблемы, которые вы упустили.

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

Пишите грамотно

Если у вас проблемы с грамотностью, вам техническое писательство может показаться скучным и неинтересным. К слову сказать, не у многих авторов идеальная грамматика; поэтому, как и во всём другом, не позволяйте небольшой неуверенности и незначительному чувству неполноценности отбить охоту от достижения собственных целей. Кроме того, хорошая грамматика – это навык, не талант. Вы можете улучшить свою грамматику! К сожалению, тексты по грамматике обычно ужасно скучные, и я бы лучше прочитал сотни других книг. Однако, весьма приятно читать книгу «Элементы стиля». «Современное использование английского языка Фоулера» также интересно читать, только, возможно, не от корки до корки. В «Правильно выставленных словах» помимо других достоинств, содержатся забавные примеры неправильного написания. Наконец, веб-сайт «Руководство по грамматике и стилю Линча» – и развлекательный, и информативный.

Принимается во внимание весь ваш писательский опыт

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

(продолжение следует)

Источник: Getting a Technical Writing Job, Even If You Have No Experience

Тэги: профессия, советы

По данным zarplan.com, средняя зарплата технических писателей в октябре 2022 года — около 100 000 рублей. Неудивительно, почему все больше людей собирается освоить эту специальность.

Действующие лица

Команда Документерры решила разобраться, как студенты учатся работать с документацией. Об этом нам рассказал Игорь Олегович Ситников — кандидат технических наук, преподаватель курса по технической документации в Уральском федеральном университете (УрФУ).

Технический писатель — кто это?

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

Допустим, ваша компания производит стиральные машины. Чтобы покупатели быстрее разобрались с функциями нового устройства, нужна инструкция. При помощи документации клиенты узнают, как правильно выбрать режим стирки, какие неисправности у устройства могут появиться и не только.

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

Как долго учиться на технического писателя?

В университетах на профессию «технический писатель» не учат, есть только курсы. У них разная продолжительность: от пары дней до нескольких месяцев. Например, Игорь Олегович как раз ведет курс для студентов УрФУ.

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

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

Во-первых, профессиональный технический писатель хорошо знает русский и английский языки. Во-вторых, он умеет структурировать информацию так, чтобы читателю было легко читать инструкции. В-третьих, специалист владеет профессиональным инструментом — таким, как Документерра.

Игорь Олегович уделяет особое внимание технологии единого источника, которая позволяет использовать один фрагмент контента сразу в нескольких местах.

Представьте ситуацию, когда в конце каждой страницы инструкции нужно указать актуальную версию ПО. В этом случае технический писатель может создать общую переменную и использовать ее на каждой странице. Без технологии единого источника специалисту пришлось бы обновлять всю документацию вручную при выходе обновления ПО и изменении номера версии.

В итоге техническому писателю необходим профессиональный инструмент для того, чтобы:

Документерра как инструмент для обучения технических писателей

Документерра — российская разработка, поэтому мы предоставляем бесплатную лицензию для УрФУ. Мы понимаем, насколько важна практика для начинающих технических писателей, которые потом будут работать в России.

Вот почему Документерра идеально подходит для обучения студентов:

Какие перспективы у профессии «технический писатель»?

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

Появляется закономерный вопрос: а что ждёт IT-область в общем и технических писателей частности? Кажется, что генерировать текст не сложнее, чем изображения. Насчёт этого мы спросили нашего эксперта.

Заключение

Мы поговорили с Игорем Олеговичем об обучении технических писателей и поняли следующее:

Игорь Олегович и его студенты способствуют развитию профессии «технический писатель» в России. Мы очень рады помогать им, предоставляя бесплатную лицензию Документерры, ведь для начинающих специалистов важен опыт работы с профессиональным инструментом.

Мы желаем Игорю Олеговичу успехов в преподавании, а нашим читателям — в освоении профессии «технический писатель».