Технический писатель: Кто такие технические писатели и зачем они нужны IT-компании

Содержание

Кто такие технические писатели и зачем они нужны IT-компании

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

Как строится работа технического писателя? Что ему нужно знать и уметь? Какими бывают технические тексты? Что сложнее всего в их написании? Об этом мы поговорили с Ольгой Шабановой, которая пишет технические тексты в EPAM.

Что это за специалисты и зачем они нужны

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

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

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

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

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

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

Ольга Шабанова: «Как и в работе с любым текстом, главное – ориентироваться на конечного пользователя: какие проблемы с помощью документации он будет решать, какой у него уровень подготовки, насколько подробно всё должно быть описано. Сейчас я работаю над документацией для внутренней системы EPAM по информационной безопасности. Пользоваться ей будут технические специалисты. Требование к такой документации — чтобы она была подробной, пусть и длинной, чтобы в ней было много скриншотов и примеров, которые показывают, как решить ту или иную проблему. Когда системный администратор изучит такую инструкцию, у него не должно остаться вопросов, как пользоваться программой. На другом проекте я пишу небольшие части документации, связанные с конкретной функциональностью и изменениями в ее работе. Здесь тексты не такие большие и подробные. И там, и там главная задача – чтобы человек быстро нашел в инструкции то, что ищет, и поиск не отнял у него слишком много сил».

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

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

На некоторых проектах техническим писателям требуется знание специфических программ: AutoCAD, Visio, Corel Draw, Confluence, Jira, UML, SysML, IDEF. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями.

Ольга Шабанова: «В моей работе важно хорошо знать иностранный язык. Я умею писать на трех: немецком, испанском и английском, но в EPAM мне требуется только английский. На собеседовании проверяют, как ты переводишь с английского на русский и наоборот. В этой профессии важна любовь к деталям – замечать мелочи, быть внимательным к пользователю: если, например, в одном пункте изменилась ссылка, нужно найти все места, где еще она была указана, и исправить везде. Еще одно важное умение — поставить себя на место конечного пользователя и задать те вопросы, ответы на которые он будет искать в документации».

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

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

С кем взаимодействует технический писатель и как устроена его работа?

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

Ольга Шабанова: «Я получаю заявку на документацию и сначала пытаюсь самостоятельно разобраться, как работает то, что описываю. Вопросы, которые возникают практически неизбежно, я собираю и задаю специалисту, который знает всё о продукте. Обычно это разработчик или менеджер проекта. Иногда бывают типовые документы и простые обновления документации. В этом случае я вначале самостоятельно составляю документацию или вношу правки в имеющуюся, а потом отправляю её на проверку. Затем получаю обратную связь и вношу правки».

Вот как строится процесс работы:

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

Ольга Шабанова: «Частая проблема, с которой я сталкиваюсь в работе – получить нужную информацию. У инженеров много других задач, и ответить мне – не приоритетная. Если не отвечают, а сроки горят, приходится напоминать разработчику о себе, а если это не срабатывает – обращаться к менеджеру и просить ускорить процесс. Ещё одна проблема – разработчик всё объяснил подробно и хорошо, но ряд терминов тебе как человеку с гуманитарной подготовкой просто непонятен. В этом случае нужно задать уточняющие вопросы сразу, по горячим следам, или поискать в интернете точные значения терминов».

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

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

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

Ольга Шабанова: «Я закончила бакалавриат по международным отношениям, где выучила иностранные языки, и магистратуру по журналистике, где прокачала навык написания текстов. Поработала журналистом, поняла, что это не мое, затем занималась связями с общественностью, тоже не подошло. Затем была переводчиком, постепенно пришла к техническим текстам – переводила на испанский инструкции на вооружение. Помимо документации на танки и самолеты, там попадались тексты и по управлению информационными системами. Затем я переводила на немецкий документы для IT-компании, а потом нашла вакансию технического писателя со знанием английского».

Тем, кто хочет стать техническим писателем, рекомендуем обратить внимание на эти ресурсы:

Какую карьеру может построить технический писатель?

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

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

Источники фото: unsplash.com

#Кем стать: Техническим писателем

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

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

Некоторые скажут, что они, дескать, и не писатели вовсе, так – просто инструкции составляют. И будут неправы. «Техническим писателям придется работать на стыке нескольких областей – технической, естественно-научной и гуманитарной, а также лингвистической, если документацию придется переводить или составлять на иностранном языке, – поясняет руководитель программы Татьяна Юрьевна ВОЛОШИНОВА. – Конечно, им вовсе не обязательно блистать оригинальными метафорами и сочными эпитетами. Но они должны много знать и доходчиво излагать свои мысли, уметь писать и одновременно разбираться в технике и технологиях, чтобы сложные вещи объяснить простым и понятным языком».

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

«За рубежом этой профессии уже несколько десятков лет, но у нас она появилась относительно недавно, – продолжает Татьяна Юрьевна. – Сегодня хороший технический писатель стоит дорого, и найти его сложно, потому что вузы, за редкими исключениями, не готовят специалистов этого направления, и пока их крайне мало». У тех же, кто позаботится получить соответствующее образование, есть хорошая перспектива устроиться на работу в компании-разработчики IT и производители бытовой техники, фармацевтические компании и промышленные производства, агентства, оказывающие услуги по созданию технической документации и специализированные СМИ, пишущие о технике и технологиях. Из обязательных навыков дипломированного технического писателя – умение работать с большими объемами информации и структурировать ее, знание иностранного (прежде всего, английского) языка и понимание профессионального сленга разработчиков, умение описывать процессы и формулировать понятным языком сложные технические термины, понимание и умение трактовать нормативно-правовые документы.

Материал подготовлен Медиа-центром СПбПУ. Текст: Инна ПЛАТОВА

Технический писатель: создание технической документации

Высшее образование онлайн

Федеральный проект дистанционного образования.

Я б в нефтяники пошел!

Пройди тест, узнай свою будущую профессию и как её получить.

Химия и биотехнологии в РТУ МИРЭА

120 лет опыта подготовки

Международный колледж искусств и коммуникаций

МКИК — современный колледж

Английский язык

Совместно с экспертами Wall Street English мы решили рассказать об английском языке так, чтобы его захотелось выучить.

15 правил безопасного поведения в интернете

Простые, но важные правила безопасного поведения в Сети.

Олимпиады для школьников

Перечень, календарь, уровни, льготы.

Первый экономический

Рассказываем о том, чем живёт и как устроен РЭУ имени Г.В. Плеханова.

Билет в Голландию

Участвуй в конкурсе и выиграй поездку в Голландию на обучение в одной из летних школ Университета Радбауд.

Цифровые герои

Они создают интернет-сервисы, социальные сети, игры и приложения, которыми ежедневно пользуются миллионы людей во всём мире.

Работа будущего

Как новые технологии, научные открытия и инновации изменят ландшафт на рынке труда в ближайшие 20-30 лет

Профессии мечты

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

Экономическое образование

О том, что собой представляет современная экономика, и какие карьерные перспективы открываются перед будущими экономистами.

Гуманитарная сфера

Разговариваем с экспертами о важности гуманитарного образования и областях его применения на практике.

Молодые инженеры

Инженерные специальности становятся всё более востребованными и перспективными.

Табель о рангах

Что такое гражданская служба, кто такие госслужащие и какое образование является хорошим стартом для будущих чиновников.

Карьера в нефтехимии

Нефтехимия — это инновации, реальное производство продукции, которая есть в каждом доме.

Чем занимается технический писатель: опыт IT-компании Lad

Рассказывают технические писатели IT-компании Lad Екатерина Каляева, Анна Назолина, Ксения Скорынина

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

Технические писатели и knowledge management

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

Так выглядит база знаний Центра Разработки. Слева — проекты и дерево статей, справа — непосредственно тексты статей.

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

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

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

«Классический» технический писатель в компании занимается написанием не только внутренней документации на проекте, но и внешней — для заказчиков.

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

О том, почему документация — это непросто

При написании документации мы используем множество источников информации: это и собственные знания, и знания коллег, код, вся ранее написанная документация, если такая есть, и требования заказчиков. Самая важная задача здесь — это побывать в роли каждого сотрудника:

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

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

Инструменты must-have

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

Slack. С его помощью мы общаемся внутри нашей команды технических писателей и с членами других команд. Мессенджер удобен тем, что каждую новую тему в деталях можно обсудить в отдельном треде. Ребята из команд добавлены в каналы, соответствующие проектам. Это помогает быть в курсе новостей и обсуждений.
Google Docs. Этот сервис мы используем, во-первых, чтобы продумать структуру статей или написать их целиком. Во-вторых, для написания технической документации верхнего уровня: мануала для заказчика, описания админки или для создания небольшого объема документации для коллег. Обычно даем доступ к нужному документу другому техническому писателю или коллеге в режиме редактирования, если он хочет добавить контент, или комментирования, если он готов проверить то, что мы написали.
YouTrack. Его мы используем в двух случаях. Первый — это доска Agile, где мы пополняем наш бэклог, распределяем задачи между собой, отслеживаем прогресс. Второе — База знаний, куда мы выкладываем наши статьи и проводим ревью статьей от коллег.
Confluence. Его преимущества — гибкость, большой выбор инструментов и древовидная структура, позволяющая сразу видеть новые проекты, релизы или требования. Инструменты Lucidchart и diagrams.net позволяют создавать широкий спектр диаграмм, от простых блок-схем до высокотехнологичных сетевых диаграмм, которые активно используют разработчики при переходе к новой функциональности на проекте.
Технические писатели не остаются в стороне и от традиционно девелоперских инструментов. Так, для просмотра актуальных или выполненных задач мы используем issue-трекер в Gitlab. Там же читаем сам код, потому что иногда нам требуется описание полей и переменных. А с помощью MongoDB/Rancher можно посмотреть на используемые микросервисы, благодаря чему получается создавать более детальное описание.
Последнее, о чем хотелось бы упомянуть, это сервисы Главред и Простым языком, где можно проверить качество своего текста, узнать, есть ли в нем повторы, опечатки, а также уменьшить его «водность».

Как выполнять план без нервов

Каждый день из работы технического писателя — особенный. Иногда мы несколько дней вдумчиво работаем над написанием одной статьи. А порой все горит и появляются новые задачи, которые нужно оперативно решать. Ежедневно мы проверяем доску Agile, оцениваем количество оставшихся задач и их статус. Выбрав приоритетные на день, прописываем их детально в карточке задачи, а затем переносим эти микрозадачи в свой Google-календарь. Так они удобно комбинируются с митингами и другими запланированными мероприятиями. Таким образом удается эффективно распределять свое время и не хвататься за все сразу, а план на день успешно выполняется.

Жизненные циклы задач

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

Задачи обычно приходят по нескольким каналам. В первую очередь, это техлид Центра Разработки или менеджер проекта. Мы практикуем регулярные встречи с ними, обычно в формате видеозвонка, чтобы обсудить прогресс по задачам: какие выполнены, какие сейчас в процессе, а что вызывает трудности. Другой путь формирования задач — это канал #docs в корпоративном мессенджере Slack. Мы используем его как инструмент коммуникации с командами: этой самый быстрый способ для них спросить технических писателей о чем-то или поручить написание статьи. В том же канале мы объявляем последний новости, связанные с базой знаний, и делаем анонсы статей.

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

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

3 сигнала, что задачу можно закрывать

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

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

Следуя своей тактике, технические писатели IT-компании Lad за полгода обработали около 40 документационных задач и создали свыше 100 статей в базе знаний Центра Разработки.

Как думаете, на вашем месте работы пригодились бы технические писатели?

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

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

(буквальный перевод английского названия профессии technical writer) Кстати, в 2021 году центр профориентации ПрофГид разработал точный тест на профориентацию. Он сам расскажет вам, какие профессии вам подходят, даст заключение о вашем типе личности и интеллекте.

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

Читайте также:

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

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

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

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

Рабочее место

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

Читайте также:

Важные качества

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

Знания и навыки

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

В работе над новой программой нужны базовые навыки программирования. Для создания иллюстраций требуется знание графических программ (Adobe PhotoShop, Adobe Flash и др) .

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

Очень важно уметь ясно выражать свои мысли в тексте.

Читайте также:

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

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

Оплата труда

Читайте также:

Технический писатель (technical writer) и технический коммуникатор (technical communicator)

Кто пишет техническую документацию? Правильно, этим занимается технический писатель. Но как появилась и развивалось эта профессия? Вот этот вопрос гораздо интереснее…

Давайте сперва обратимся, как это обычно бывает, к Википедии:

Технический писатель (англ. Technical writer, technical author) — специалист, занимающийся документированием в рамках решения технических задач, в частности разработки программного обеспечения.

Иными словами, Капитан Очевидность вновь в деле. Однако что на самом деле таит за собой эта профессия? Давайте обратимся к истории.

Возникновение и первые шаги

Достоверно неизвестно, но первым официальным техническим документом считается Трактат по устройству астролябии (англ. A Treatise on the Astrolabe), написанный английсим поэтом Джефри Чосером в XIV веке. Далее спустя век было знаменательное событие изобретения технологии книгопечатания Иоганном Гутенбергом, которая позволила публиковать в том числе и технические документы. Затем было время выдающихся ученых и изобретателей: Леонардо да Винчи, Исаак Ньютон и Николай Коперник – все они и многие другие без исключения прибегали к чертежам и описаниям своих исследований и изобретений. Так зародилось и появилось на свет то, что мы сегодня называем технической документацией.

Рассвет

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

Золотой век

Бесспорно, началом золотого века считается появление первых электронных компьютеров в середине XX века. Именно тогда были разработаны и опубликованы первые документы User Guide (Руководство пользователя) в привычном нам понимании, а в газетах появились первые вакансии. Затем появились персональные компьютеры, наступил информационный век и наступил настоящий бум в сфере разработки программного обеспечения, включая и техническую дкоументацию.

Что касается страны за железным занавесом, изначально разрабатывали техническую документацию доблестные советские инженеры. Затем появились знакомые нам ГОСТы, ЕСКД и ЕСПД, а позже появилось и отдельное звание «Разработчик технической документации». Забавно, но даже сейчас можно увидеть на бирже труда вакансии с названием «Инженер (разработчик технической документации)». Так-то!

Сегодня

Так кто же такой технический писатель сегодня? На самом деле, технический писатель – это некое боевое связующее звено между следующими фронтами:

1) заказчиками и исполнителями;
2) производителями и потребителями;
3) менеджерами и разработчиками;
4) гуманитариями и технарями.

Кстати, интересен тот факт, что на западе технических писателей (technical writer) также называют техническими коммуникаторами (technical communicator). Вероятно, в некотором смысле, это даже более корректное название профессии.

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

Закат

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

Технический писатель в ИТ. Роль в команде разработки::Журнал СА 7-8.2017

Рубрика:

Карьера/Образование /
Вектор роста

Facebook

Twitter

Мой мир

Вконтакте

Одноклассники

Google+

ОЛЬГА ТУРЧАНОВСКАЯ, ведущий технический писатель в UNIGINE, г. Томск, разрабатывающей собственную 3D-платформу, [email protected]

Технический писатель в ИТ
Роль в команде разработки

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

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

Технический писатель – связующее звено между разработчиком и конечным пользователем

Еще в девятом классе гимназии я озадачилась вопросом: кто я – технарь или гуманитарий? Дисциплины этих двух направлений мне были одинаково интересны, однако среди всего многообразия выделить что-то одно и уйти в это с головой не получалось. Когда пришлось выбирать направление для последних двух лет обучения, я остановилась на гуманитарном классе. Мне нравилось углубленное изучение иностранных языков и литературы, однако мысль о том, чтоматематика мне интересна не меньше, не давала покоя. В итоге ходила на школьные курсы по математике и физике филиала МГУ, а после поступила в Томский университет систем управления и радиоэлектроники на специальность инженер промышленной электроники. Специальность исключительно техническая, так что появилась необходимость поддерживать знания иностранных языков, и я решила получить дополнительное образование по специальности технический переводчик в сфере профессиональных коммуникаций. Что касается профессионального развития, то со второго курса начала работать фрилансером-переводчиком, однако продолжала искать сферу, которая объединила бы стремление работать не только с языками, но и с технологиями. По счастливой случайности, увидела вакансию технического писателя в UNIGINE. Все сошлось – было необходимо владение английским языком и понимание теоретических основ программирования.

UNIGINE – томская ИТ-компания, первостепенная миссия которой – программная разработка реал-тайм-платформы 3D-графики, на основе которой клиенты создают различные индустриальные проекты, требующие реалистичного изображения и интерактивного взаимодействия. Сама платформа представляет собой исходный код на С++, однако разрабатываются также и вспомогательные продукты: визуальный редактор, SDK-браузер для управления проектами, консольные инструменты.

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

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

Кто такой технический писатель, или Технический писатель – не переводчик

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

Рисунок 1. Различия между переводчиком и техническим писателем

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

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

Рабочий процесс

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

Важно понимать, что разработчик может принимать многое как данность и думать, что люди и так все понимают. Он может опускать «ненужные детали» или вообще говорить: «Этого знать никому не надо!»

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

Ответственность за составляющие будущей статьи как раз и ложится на технического писателя. Задав правильные вопросы и узнав все от разработчика, необходимо понять, нужна ли вся полученная информация в документации. Часто бывает так, что смысла документировать нет, так как через месяц точно данная информация будет неактуальна или дополнится. Такие задачи переходят в хранилище задач. Далее, если информация актуальна, техническому писателю надо побыть тестировщиком – воспроизвести функционал в своем окружении, проверить, все ли работает правильно. Часто вместе с программистом или самому необходимо писать примеры кода, обычно это тоже делается до написания статьи. И только изучив все связанные статьи, чтобы изменение было зафиксировано по всей документации, можно переходить к последнему пункту – непосредственному созданию статьи, что по сравнению с предыдущей подготовкой занимает нетак много времени. Если есть возможность, желательно отдать готовую статью на вычитку коллегам, чтобы получить взгляд со стороны. Процентное распределение времени показано на рис. 2.

Рисунок 2. Процентное распределение времени при документировании

Объемы

Хочется упомянуть о фактических объемах работы. На данный момент в компании 13 активных разработчиков (каждый из которых работает за двоих) и три технических писателя. По большому счету, список задач технических писателей можно разделить на две части: это технический долг (функционал, добавленный ранее и не задокументированный или устаревший, но не обновленный) и новая документация. В ней описываются возможности, которые станут доступны только в следующем релизе. Для каждого релиза существует отдельная версия документации, которая включает в себя около 1000 статей (больше половины из них – справочник API с описанием функций и примерами кода). Весь материал всегда пишется для трех языков программирования (C++, C# и UnigineScript). Большая часть статей остается неизменной, однако для каждого релиза так или иначе обновляется или дополняется 30% документации.

Целевая аудитория

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

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

Жанры документации

Ментальная модель

Ментальные модели необходимы для общего развития и знакомства с каким-либо понятием (например, что такое «двойная точность координат»). Стиль написания – повествовательный, похож на стиль Википедии. В такой статье важно ввести понятие, описать базовые сущности и их взаимосвязи, показать, как работает каждая подсистема в отдельности (см. рис. 3).

Рисунок 3. Ментальная модель документации

Руководство пользователя

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

Важно указывать краевые значения параметров и влияние одних параметров на другие, чтобы не запутать читателя (см. рис. 4).

Рисунок 4. Пример руководства пользователя

Справочник API

Если статья предназначена только для программистов (справочник API, включающий в себя описание классов, функций и аргументов), стиль написания будет соответствующий – все важные технические детали будут учтены, приведены примеры кода, описаны ограничения и краевые случаи. К тому же зачастую подразумевается, что многие вещи программисты знают и так, и в базовые подробности вдаваться не нужно. Для такого типа документации важен еще быстрый поиск и удобная структура, так как к справочнику, в отличие от других типов статей, обращаются очень часто (см. рис. 5).

Рисунок 5. Пример справочника API

Туториал

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

Рисунок 6. Пример туториала

Промо-материалы

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

Стандарты

Что касается документации в ИТ-индустрии, в отличие от промышленных предприятий, стандартов как таковых у нас нет. Главное правило – написано должно быть по делу и максимально понятно. Сложных предложений и оборотов мыстараемся избегать. У нас есть негласное правило: при написании статьи надо представлять читателем китайского мальчика, английский у которого – не родной язык. Для консистентности шаблонных статей у нас есть внутренние руководства. Что касается работы с техническим языком – в свое время прочитали Microsoft Manual of Style, много полезного оттуда переняли и внедрили во внутренние стандарты (см. рис. 7).

Рисунок 7. Пример документации

Качество

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

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

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

Повышение квалификации

Ремеслу технического письма в вузах не обучают, по крайней мере в России. В большинстве случаев сотрудники приходят в компанию и учатся у коллег либо по интернет-ресурсам. В UNIGINE было принято решение пройти хотя бы онлайн-курс, и обязательно на английском языке, так как всю документацию мы пишем только на английском. Выбор пал на канадскую бизнес-школу Sprott университета Carleton, которая предлагала четырехмесячный курс обучения азам технического письма и XML-разметки Professional Technical Writing («Профессиональная разработка технической документации»). Мы с коллегой прошли курс от начала до конца, выполнили все задания и даже написали курсовой проект.

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

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

Инструменты

Что касается инструментов, то ничего необычного у нас нет, практически все пишем в XML. Есть собственная система генерации функций из исходников. Однако техническому писателю необходимо много другого софта: программы дляработы с 2D-изображениями (Adobe Photoshop, Illustrator), 3D-контентом (3ds Max и Maya), среда разработки (Microsoft Visual Studio) и т.д.

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

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

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

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

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

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

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

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

Очень часто мне задают вопрос, зачем человеку с техническим образованием, например программисту, идти в технические писатели? Я думаю, что эта профессия подходит людям с широким кругозором, тем, кому интересна сфера в целом, но слишком узконаправленным специалистом становиться не хочется. То есть человеку интересно узнавать новое в разных сферах, а не глубоко изучать одну. Однако при большом желании можно развиваться в разных направлениях самостоятельно, параллельно с работой технического писателя (в нашем случае это программирование и 3D-моделирование). Здесь бы я еще отметила причастность к высоким технологиям, возможность работать в компании мечты небудучи разработчиком, но понимая, как все устроено. Мне кажется, в этом и есть уникальность этой профессии. В любом случае, дальнейший путь специалиста определяется его амбициями – чем больше он выкладывается на работе, развивается, узнает информацию, ищет себя, тем стремительнее будет его карьерный рост в любом направлении.

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

Из желаемых личных качеств при подборе технических писателей мне хотелось бы отдельно упомянуть коммуникабельность и любознательность. Техническому писателю каждый день приходится задавать вопросы разработчикам, просить помощи. Бывает, что всем некогда, на сообщения не отвечают, и приходится быть настойчивее. Зачастую, чтобы о чем-то расспросить, приходится искать нестандартную обстановку, например на кухне за чаем незаметно перевести тему нанужную. В какой-то степени это напоминает работу журналистов. Далеко не всем будет комфортно в таком режиме.

Об идеалах

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

Разработка программного обеспечения типа нашего – бесконечный цикл. Всегда есть планы на будущее: что изменить, что добавить, что переделать полностью. Документация, как спутник продукта, тоже не стоит на месте. Казалось бы, чтонужно для качественной статьи?

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

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

Facebook

Twitter

Мой мир

Вконтакте

Одноклассники

Google+

Чем занимается технический писатель?

Чтобы ответить на этот вопрос, вам нужно развеять некоторые мифы, связанные с техническим письмом, а затем сравнить требуемые характеристики профессии и набор навыков со своими собственными.

Мифы

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

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

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

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

Необходимые характеристики

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

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

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

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

Требуемый набор навыков

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

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

Инструменты документации
Знание инструментов, используемых для создания технической документации, является преимуществом. Некоторые часто используемые инструменты: Adobe FrameMaker, MadCap Flare, RoboHelp, PageMaker и Quark. Но, как уже отмечалось, технические писатели привыкли к обучению — это действительно основа того, что они делают, — и большинство из них способны быстро и эффективно изучить новый инструмент.

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

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

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

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

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

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

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

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

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

Цель технического письма

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

Общий процесс для технического писателя

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

Для большинства проектов технические писатели используют следующие шаги:

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

Перспективы работы для технических писателей

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

По данным Бюро статистики труда США — организации, входящей в состав Министерства труда США, — отрасль технического письма может вырасти на 11 процентов в период с 2016 по 2026 год.Это быстрее, чем в среднем для большинства профессий. Технические писатели обычно нуждаются в степени бакалавра и могут рассчитывать на обучение на рабочем месте и краткосрочное электронное обучение при приеме на работу. В 2017 году средняя заработная плата американских профессиональных технических писателей составляла 70 930 долларов в год (1). Согласно PayScale, старший технический писатель может зарабатывать более 115 000 долларов в год (2). Эти числа могут варьироваться в зависимости от того, где работают технические писатели и насколько они опытны.

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

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

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

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

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

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

Стать техническим писателем

Вы также можете использовать агентство, чтобы найти работу технического писателя.В The Writer Finder мы всегда ищем технических писателей начального уровня и опытных. Зарегистрируйтесь, чтобы присоединиться к нашей базе данных писателей, и мы свяжемся с вами, когда появятся новые возможности. Это означает, что вам не нужно часами просматривать списки вакансий.

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

Источники:

1. https://www.bls.gov/ooh/media-and-communication/technical-writers.htm

2. https://www.payscale.com/research/US / Job = Senior_Technical_Writer / Зарплата

Безопасность | Стеклянная дверь

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

Nous aider à garder Glassdoor sécurisée

Nous avons reçu des activités suspectes venant de quelqu’un utilisant votre réseau internet.
Подвеска Veuillez Patient que nous vérifions que vous êtes une vraie personne. Вотре содержание
apparaîtra bientôt. Si vous continuez à voir ce message, veuillez envoyer un
электронная почта à
pour nous informer du désagrément.

Unterstützen Sie uns beim Schutz von Glassdoor

Wir haben einige verdächtige Aktivitäten von Ihnen oder von jemandem, der in ihrem
Интернет-Netzwerk angemeldet ist, festgestellt.Bitte warten Sie, während wir
überprüfen, ob Sie ein Mensch und kein Bot sind. Ihr Inhalt wird в Kürze angezeigt.
Wenn Sie weiterhin diese Meldung erhalten, informieren Sie uns darüber bitte по электронной почте:
.

We hebben verdachte activiteiten waargenomen op Glassdoor van iemand of iemand die uw internet netwerk deelt.
Een momentje geduld totdat, мы узнали, что u daadwerkelijk een persoon bent. Uw bijdrage zal spoedig te zien zijn.
Als u deze melding blijft zien, электронная почта:
om ons te laten weten dat uw проблема zich nog steeds voordoet.

Hemos estado detectando actividad sospechosa tuya o de alguien con quien compare tu red de Internet. Эспера
mientras verificamos que eres una persona real. Tu contenido se mostrará en breve. Si Continúas recibiendo
este mensaje, envía un correo electrónico
a para informarnos de
que tienes problemas.

Hemos estado percibiendo actividad sospechosa de ti o de alguien con quien compare tu red de Internet. Эспера
mientras verificamos que eres una persona real.Tu contenido se mostrará en breve. Si Continúas recibiendo este
mensaje, envía un correo electrónico a
para hacernos saber que
estás teniendo problemas.

Temos Recebido algumas atividades suspeitas de voiceê ou de alguém que esteja usando a mesma rede. Aguarde enquanto
confirmamos que Você é Uma Pessoa de Verdade. Сеу контексто апаресера эм бреве. Caso продолжить Recebendo esta
mensagem, envie um email para
пункт нет
informar sobre o проблема.

Abbiamo notato alcune attività sospette da parte tua o di una persona che condivide la tua rete Internet.Attendi mentre verifichiamo Che sei una persona reale. Il tuo contenuto verrà visualizzato a breve. Secontini
visualizzare questo messaggio, invia un’e-mail all’indirizzo
per informarci del
проблема.

Пожалуйста, включите куки и перезагрузите страницу.

Это автоматический процесс. Ваш браузер в ближайшее время перенаправит вас на запрошенный контент.

Подождите до 5 секунд…

Перенаправление…

Заводское обозначение: CF-102 / 69e1878d588b13c6.

Технический писатель — Номер вакансии: 1531197

ОПИСАНИЕ

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

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

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

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

ОСНОВНЫЕ КВАЛИФИКАЦИИ

· Степень бакалавра / бакалавра в области информатики, английского языка, технического письма или другой смежной области или эквивалентный опыт
· 3+ года опыта в качестве технического писателя в соответствующей области
· Опыт создания документации для технического аудитория

ПРЕДПОЧТИТЕЛЬНАЯ КВАЛИФИКАЦИЯ

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

Amazon стремится к разнообразному и инклюзивному рабочему месту. Amazon является работодателем с равными возможностями и не допускает дискриминации по признаку расы, национального происхождения, пола, гендерной идентичности, сексуальной ориентации, защищенного статуса ветерана, инвалидности, возраста или другого статуса, защищенного законом. Для людей с ограниченными возможностями, которые хотели бы запросить жилье, посетите страницу https://www.amazon.jobs/en/disability/us.

Следует ли вам получить сертификат технического письма? Лучшие программы для рассмотрения — Heretto

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

Они могут предложить вам шансы улучшить ваши текущие навыки
Они могут помочь вам развить и отточить более специализированные навыки
Они могут помочь выделить вас среди других

Сертификаты

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

Техническое письмо — это не катание на велосипеде. Это не то, чему вы однажды научитесь и к чему время от времени вернетесь.

Техническое письмо похоже на лепку.

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

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

Давайте вместе посмотрим на сертификаты.

Стоит мне это делать или нет?

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

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

Сертификаты

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

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

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

Например:

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

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

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

Лучшие программы сертификации технических писателей

Международный фонд квалификаций в области технической коммуникации (ITCQF)

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

Не только для стандартизации профессии, но и для повышения осведомленности. Их миссия:

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

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

Общество технической коммуникации

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

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

Вы должны заплатить за курс –, но это одна из самых популярных программ сертификации в сфере технического письма. При этом для членов ЮТК ставка снижена.

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

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

Обучение DITA

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

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

Узнайте больше об обучении DITA здесь: Learning DITA: Бесплатное обучение DITA

Программы университетского уровня

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

Национальная ассоциация писателей-ученых

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

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

Узнайте больше о NASW здесь: Национальная ассоциация научных писателей, Inc.

Американская ассоциация медицинских писателей

Американская ассоциация медицинских писателей (AMWA) и Комиссия по сертификации медицинских писателей (MWCC) сотрудничали для создания сертификата медицинского писателя (MWC).

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

Узнайте больше об учетных данных AMWA и MWC здесь: AMWA: Medical Writer Certified

Подводя итоги

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

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

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

Обязанности

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

Требования

У вас есть:
- Опыт планирования, исследования, написания и редактирования документации по программному обеспечению.
- Отличные навыки грамматики, минималистичный дизайн документации и эффективная информационная архитектура.
- Отличные педагогические навыки, которые воплощаются в прекрасную письменную работу.
- Опыт использования оболочки Linux, командной строки Git, HTML / CSS и / или хотя бы одного языка программирования (не обязательно в профессиональном контексте).
- Опыт использования генераторов статических сайтов и управления документами как кодом.
- Опыт работы с некоторыми из следующего:
  - Использование или документирование инструментов DevOps.
  - JavaScript и интерфейсная разработка.
  - Продвинутый уровень программирования или другой технический опыт.
  - Использование GitLab.
  - Быстро масштабируемая среда для стартапов.
  - Удаленная работа, особенно в сотрудничестве с другими пользователями в разных странах и часовых поясах.
Вы:
- Высокоорганизованный и способный отсортировать и расставить приоритеты по многочисленным проблемам и проектам.
- Способен добиться успеха в удаленной, глобально распределенной рабочей среде.
Вы разделяете наши ценности и работаете в соответствии с ними.
У вас есть опыт работы с рабочими процессами и инструментами, используемыми инженерными, производственными и продуктовыми группами.

Уровни

Технический писатель (средний уровень)

Технический писатель (средний уровень) подчиняется менеджеру по техническому написанию.

Технический писатель (средний уровень) Должность

Технический писатель (средний уровень) — 6 класс.

Обязанности технического писателя (среднего уровня)

Содержимое : создание, объединение и ведение документации по продукту и публикация сообщений для назначенных групп продуктов. Сбалансируйте приоритеты.
Структура : Убедитесь, что в недавно разработанном контенте используются типы тем контента, чтобы упростить сканирование документации по продукту.
Организация : Убедитесь, что страницы документации продукта в назначенных вам группах хорошо организованы, используя правильное именование и логические группировки.
Пользовательский интерфейс : Создайте или улучшите текст пользовательского интерфейса, например метки полей или сообщения об ошибках, с акцентом на назначенные вам группы.
Обзоры : Предоставляйте эффективные обзоры контента, созданного другими пользователями, в основном в рамках назначенных вам групп, на основе соответствующих руководств по стилю.
Знание продукта : понимание технологий и функций групп разработчиков, в которые вы назначены.
Процесс : внесите изменения в Справочник, которые помогают организации развивать культуру и передовой опыт.
Связь : Эффективное и профессиональное общение с другими членами команды.
Руководство : Выступать в качестве руководителя технического письма для назначенных групп.

Старший технический писатель

Старший технический писатель подчиняется менеджеру по написанию технической документации.

Старший технический писатель Класс должности

Старший технический писатель — 7 класс.

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

Расширяет обязанности технического писателя (среднего уровня) по сложности и объему.

Контент : Эффективное создание, объединение и ведение документации по продуктам и публикация сообщений для назначенных групп продуктов. Руководство по улучшению запросов на слияние. Предлагайте и сбалансируйте приоритеты.
Структура : Реализуйте типы тем контента как в новом, так и в ранее созданном контенте, чтобы упростить сканирование документации по продукту.
Организация : Убедитесь, что страницы документации по продукту хорошо организованы на назначенном вам этапе, используя правильное именование и логические группировки.
Пользовательский интерфейс : активно создавайте или улучшайте текст пользовательского интерфейса, например метки полей или сообщения об ошибках, с акцентом на назначенную вам стадию.
Обзоры : Предоставляйте эффективные и действенные рецензии на контент, созданный другими людьми на выбранной вами стадии, на основе соответствующих руководств по стилю.
Знание продукта : глубокое понимание технологии и функций групп разработчиков, к которым вы назначены, и общее понимание назначенного вам этапа.
Процесс : внесите изменения в Справочник, которые помогают организации развивать культуру и передовой опыт.
Связь : Эффективное и профессиональное общение с другими членами команды.
Руководство : Выступать в качестве руководителя технического письма для назначенных групп и этапов.
Рекрутинг : Быть доступным для собеседования с потенциальными кандидатами технических писателей.
Наставничество : Обучайте других технических писателей и членов команды относительно передовых методов и других знаний о процессах.

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

Штатный технический писатель подчиняется старшему менеджеру по техническому написанию.

Должность штатного технического писателя

Штатный технический писатель — 8-й класс.

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

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

Расширяет обязанности старшего технического писателя по сложности и объему.

Содержимое : Эффективное создание и ведение документации по продукту и публикация сообщений для назначенных групп продуктов или этапов. Руководство по улучшению запросов на слияние.
Структура : Активно внедряйте типы тем контента как в новый, так и в ранее созданный контент, чтобы упростить сканирование документации по продукту.
Организация : Убедитесь, что страницы документации по продукту хорошо организованы по этапам, используя правильное именование и логические группировки.
Пользовательский интерфейс : Создание модельных примеров текста пользовательского интерфейса, включая метки полей или сообщения об ошибках, с межэтапным фокусом. Активно улучшайте руководство по стилю и контент Pyjamas, связанный с текстом пользовательского интерфейса.
Обзоры : методы проверки моделей, которые со временем улучшают качество вкладов. Поддерживайте и направляйте членов команды по улучшению обзоров в их группах и на этапах.
Знание продукта : понимание технологии и функций как стадии разработки, на которую вы назначены, так и сквозного продукта GitLab, чтобы помочь улучшить информационную архитектуру сайта документации.
Процесс : Активно вносить изменения в Справочник, которые помогают организации развивать культуру и передовой опыт.
Связь : эффективно и профессионально общаться с другими членами команды и быть образцом для сотрудничества.
Лидерство : Определите и возглавьте межэтапные проекты, которые улучшают результаты или процессы группы технического письма.
Рекрутинг : Быть доступным для собеседования с потенциальными кандидатами технических писателей.
Наставничество : Обучайте других технических писателей и членов команды о том, как предлагать и балансировать приоритеты, лучшие отраслевые практики и другие знания о процессах.

Главный технический писатель

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

Должность главного технического писателя

Главный технический писатель имеет 9-й класс. Главный технический писатель имеет большой опыт работы на уровне штата.

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

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

Расширяет обязанности штатного технического писателя по сложности и объему.

Содержимое : Эффективное создание и ведение документации по продукту и публикация сообщений для назначенных групп продуктов или этапов.Руководство по улучшению запросов на слияние. Помогите расставить приоритеты на уровне команды.
Структура : Активно внедряйте типы тем контента как в новый, так и в ранее созданный контент, чтобы упростить сканирование документации по продукту.
Организация : Убедитесь, что страницы документации по продукту хорошо организованы по этапам, используя правильное именование и логические группировки.
Пользовательский интерфейс : предоставление экспертных рекомендаций по тексту пользовательского интерфейса. Активно улучшайте руководство по стилю и содержание пижамы.
Обзоры : Стимулируйте эффективные методы проверки для вкладов команды и сообщества в документацию GitLab и изменения пользовательского интерфейса.
Знание продукта : глубокое понимание технологии и функций этапа разработки, на который вы назначены, и общее представление о сквозном продукте GitLab, чтобы помочь улучшить информационную архитектуру сайта документации.
Процесс : Активно вносить изменения в Справочник, которые помогают организации развивать культуру и передовой опыт, а также руководить усилиями по поощрению других членов команды к внесению вклада.
Связь : Эффективное и профессиональное общение по всем группам продуктов и стадиям, а также создание модели для сотрудничества с участниками сообщества.
Лидерство : Определите и возглавьте проекты между отделами GitLab, которые улучшают результаты или процессы группы технического письма.
Рекрутинг : Быть доступным для собеседования с потенциальными кандидатами технических писателей.
Наставничество : Обучайте других технических писателей и членов команды относительно передовых методов и других знаний о процессах.
Влияние : Обеспечить положительное влияние на принятие этапов в каждой организации за счет более удобной документации, с конечной целью — способствовать более высокому ARR.

Показатели эффективности

Карьерная лестница

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

Процесс приема на работу

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

Кандидатам, которые проявят интерес к этой должности, будет предложено поделиться образцами работ и ответить на вопросы, связанные с написанием технической документации.
Квалифицированным кандидатам будет предложено назначить 30-минутный отборочный звонок с одним из наших международных рекрутеров. На этой телеконференции мы обсудим ваш опыт, поймем, что вы ищете в роли технического писателя, поговорим о вашей работе и подходе к техническому написанию, обсудим ваши ожидания в отношении компенсации и причины, по которым вы хотите присоединиться к GitLab, и ответим на любые ваши вопросы. имеют.
Если вы успешно пройдете отборочный звонок, вам будет предложено назначить 60-минутное собеседование с нашим менеджером по написанию технической документации. В этом интервью мы хотим, чтобы вы рассказали о подходе, который вы использовали в примерах работы, которой вы поделились в рамках своего приложения, о своем опыте до настоящего момента, поняли, что вы ищете в должности технического писателя, и ответили бы на любые вопросы у вас есть.
Следующее интервью будет с одним из наших технических писателей. Мы обсудим ваш опыт, почему вы хотите присоединиться к GitLab, ваш опыт работы с доменом и каково быть техническим писателем в GitLab.Мы оценим ваше соответствие нашим ценностям и ответим на любые ваши вопросы.
Затем вы встретитесь с одним из наших менеджеров по продуктам, инженерами или представителями службы поддержки для 45-минутного собеседования. Мы обсудим ваш опыт и почему вы хотите присоединиться к GitLab. Мы оценим ваше соответствие нашим ценностям и ответим на любые ваши вопросы.
Наконец, вы встретитесь с нашим старшим менеджером по написанию технической документации. На этом этапе мы постараемся понять ваше мнение о том, как документация влияет на взаимодействие с пользователем и ваш опыт до сих пор.Вы обсудите основные правила написания технической документации, и интервьюер ответит на любые ваши вопросы.

Дополнительную информацию о нашем процессе можно найти на нашей странице приема на работу.

Калькулятор компенсации

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

О GitLab

GitLab Inc.- компания, основанная на проекте с открытым исходным кодом GitLab. GitLab — это
общественный проект, в котором приняли участие более 2200 человек со всего мира.
Мы — активный участник этого сообщества, пытаясь удовлетворить его потребности.
и подавать пример. У нас одно видение: каждый может
вносить свой вклад во весь цифровой контент, и наша миссия — изменить все творческие
работать от режима только для чтения до чтения и записи, чтобы каждый мог внести свой вклад.

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

10 главных причин работать в GitLab:

Миссия: каждый может внести свой вклад
Результаты: быстрый рост, амбициозное видение
Гибкие часы работы: планируйте свой день так, чтобы вы были рядом с другими людьми и у вас было время для личных интересов
Прозрачность: более 2000 веб-страниц в справочнике GitLab, нефильтрованный канал GitLab на YouTube
Итерация: Дайте людям возможность быть эффективными и влиятельными, Частота запросов на слияние, Мы проверяем наш собственный продукт, Непосредственно ответственные лица
Разнообразие, инклюзивность и принадлежность: акцент на гендерном равенстве,
Ресурсные группы для членов команды, другие инициативы
Сотрудничество: доброта, благодарность, намеренная организация неформального общения, без эго
Всего вознаграждений: конкурентоспособные рыночные ставки вознаграждения, компенсация акционерного капитала, глобальные выгоды (включая офисное оборудование)
Гармония работы и жизни: гибкий рабочий день, дни друзей и семьи
Remote Done Right: одна из крупнейших в мире полностью удаленных компаний, плодовитый изобретатель передовых методов удаленной работы

См. Дополнительную информацию на нашей странице о культуре!

Работайте удаленно из любой точки мира.Любопытно посмотреть, что это выглядит
нравиться? Ознакомьтесь с нашим удаленным манифестом и руководствами.

Заявление о приеме на работу для технического писателя на GitHub

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

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

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

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

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

Кто мы:

GitHub — компания-разработчик. Мы помогаем разработчикам быть разработчиками: работать вместе, решать сложные проблемы и создавать самые важные в мире технологии.Мы способствуем развитию сообщества, способного сотрудничать — по отдельности и в командах — для создания будущего программного обеспечения и изменения мира к лучшему.

Принципы лидерства:

Одержимость клиентов — Доверие по умолчанию — Отправка, чтобы учиться — Получение результата — Мышление о росте — Глобальный продукт, Глобальная команда — Все возможно — Практикуйте доброту

Почему вам следует присоединиться:

В GitHub мы постоянно стремимся создать среду, которая позволяет нашим сотрудникам (хабберам) выполнять работу наилучшим образом в своей жизни.Мы создали одно из самых крутых рабочих мест в Сан-Франциско (штаб-квартира), где многие хабберы ежедневно работают, перекусывают и творят. Остальные наши хабберы работают удаленно по всему миру. Ознакомьтесь с обновленным списком мест, где мы можем нанять здесь: https://github.com/about/careers/remote

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

GitHub состоит из людей самого разного происхождения и образа жизни. Мы приветствуем разнообразие и приглашаем людей из всех слоев общества. Мы не дискриминируем сотрудников или кандидатов на основании гендерной идентичности или выражения, сексуальной ориентации, расы, религии, возраста, национального происхождения, гражданства, инвалидности, статуса беременности, статуса ветерана или любых других различий. Кроме того, если у вас есть инвалидность, сообщите нам, есть ли способ улучшить для вас процесс собеседования; мы рады разместить вас!

Обратите внимание, что преимущества зависят от страны.

Кто такие технические писатели и зачем они нужны IT-компании

Что это за специалисты и зачем они нужны

Какую карьеру может построить технический писатель?

#Кем стать: Техническим писателем

Технический писатель: создание технической документации

Высшее образование онлайн

Я б в нефтяники пошел!

Химия и биотехнологии в РТУ МИРЭА

Международный колледж искусств и коммуникаций

Английский язык

15 правил безопасного поведения в интернете

Олимпиады для школьников

Первый экономический

Билет в Голландию

Цифровые герои

Работа будущего

Профессии мечты

Экономическое образование

Гуманитарная сфера

Молодые инженеры

Табель о рангах

Карьера в нефтехимии

Чем занимается технический писатель: опыт IT-компании Lad

Технические писатели и knowledge management

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

О том, почему документация — это непросто

Инструменты must-have

Как выполнять план без нервов

Жизненные циклы задач

3 сигнала, что задачу можно закрывать

Как думаете, на вашем месте работы пригодились бы технические писатели?

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

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

Рабочее место

Важные качества

Знания и навыки

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

Оплата труда

Технический писатель (technical writer) и технический коммуникатор (technical communicator)

Возникновение и первые шаги

Рассвет

Золотой век

Сегодня

Закат

Технический писатель в ИТ. Роль в команде разработки::Журнал СА 7-8.2017

Чем занимается технический писатель?

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

Безопасность | Стеклянная дверь

Nous aider à garder Glassdoor sécurisée

Unterstützen Sie uns beim Schutz von Glassdoor

Технический писатель — Номер вакансии: 1531197

ОПИСАНИЕ

ОСНОВНЫЕ КВАЛИФИКАЦИИ

ПРЕДПОЧТИТЕЛЬНАЯ КВАЛИФИКАЦИЯ

Следует ли вам получить сертификат технического письма? Лучшие программы для рассмотрения — Heretto

Стоит мне это делать или нет?

Лучшие программы сертификации технических писателей

Международный фонд квалификаций в области технической коммуникации (ITCQF)

Общество технической коммуникации

Обучение DITA

Программы университетского уровня

Национальная ассоциация писателей-ученых

Американская ассоциация медицинских писателей

Подводя итоги

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

Обязанности

Требования

Уровни

Технический писатель (средний уровень)

Технический писатель (средний уровень) Должность

Обязанности технического писателя (среднего уровня)

Старший технический писатель

Старший технический писатель Класс должности

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

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

Должность штатного технического писателя

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

Главный технический писатель

Должность главного технического писателя

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