В этой небольшой статье мы постараемся максимально развёрнуто ответить на основные вопросы, которые задают своим будущим коллегам люди, желающие освоить профессию технического писателя или просто расширить кругозор.
Если вы интересуетесь данной профессией, посмотрите также запись вебинара о технических писателях в нижней части этой страницы. Там же вы найдёте информацию о курсе подготовки технических писателей. Может быть, эта профессия — та самая, которая определит всю вашу дальнейшую карьеру?
Кто такой технический писатель?
На этот вопрос ответили три ведущих специалиста компании ПроТекст. Вот что получилось:
1) Технический писатель – профессия востребованная и интересная, но пока редкая. Технические писатели – специалисты, которые технически сложные вещи 
могут объяснить простым человеческим всем понятным языком. Они умеют писать и одновременно разбираются в технике и технологиях.
2) Технический писатель – это человек, который может во всём разобраться и для всех донести. Т.е. профессиональный дилетант, как я люблю говорить. Если технический писатель будет работать так, как он должен работать, он запросто сможет работать на месте руководителя компании. Технический писатель не должен говорить «я не могу написать это» или «я в этом не разбираюсь». От него ждут вопросов совсем иного толка. Технический писатель ищет информацию, которая нужна для работы сам, ищет контакты, которые нужны для того, чтобы разобраться в специфической теме. И решает задачу изложения информации, которая будет удобна для использования целевой аудиторией документа. Задача эта достаточно комплексная, поэтому технический писатель – это разносторонне развитая личность, человек, который не боится трудностей.
3) На мой взгляд, технический писатель, это, прежде всего, переводчик с русского на русский. Он разговаривает с разработчиками и технарями на одном языке, подчас непонятном рядовым пользователям, а потом пишет материалы на другом языке, простом и понятном любому человеку. Хороший разработчик, за редким исключением, не сможет просто и доступно рассказать о своём детище – для него оно всё «элементарное и понятное», тогда как технический писатель, находясь между создателем и пользователем, в состоянии рассказать о любой сложной вещи простым языком. Обратное тоже верно – когда заказчик, знающий свою область, но не знающий программирования, пытается напрямую объяснить разработчику свои задачи – результат непредсказуем. Надо звать кого-то из наших коллег, чтобы он пояснил сторонам, что же им всё-таки нужно.
Какое образование должен иметь технический писатель – техническое или гуманитарное? 
Базовое образование, которым должен обладать человек, желающий стать техническим писателем – вопрос, открытый до сих пор. Если брать статистику, то подавляющее большинство технических писателей – технари, так или иначе связанные с литературой. Многие из них начинали как обычные писатели, сочиняя повести, романы, а то и стихи, и, увязав свои литературные способности с техническими навыками и складом ума, получили на выходе то сочетание качеств, которое необходимо техпису: способность быстро понять механизм или программу любой сложности, и тут же описать это простым и красивым языком. Но и гуманитариям расстраиваться причин нет – если их интересует техника, они смогут достигнуть в профессии не меньших успехов, чем технари.
Есть ли вузы, которые учат именно на технических писателей?
К сожалению, в данный момент этой специальности в вузах не существует, как не существует и самой специальности. Даже выбор курсов для технических писателей очень ограничен, государственную аттестацию и вовсе имеет только курс компании «ПроТекст» (сертифицирован в Новосибирском государственном техническом университете).
Какова глобальная роль технического писателя? 
По сути, технический писатель – это переводчик «с русского на русский», в совершенстве владеющий как «языком пользователя», так и «языком разработчика». Есть два варианта:
1) Технический писатель переводит «от разработчика – клиенту». Техпис (да, так наша профессия сокращается, привыкайте) изучает существующее оборудование или программу и, вникнув в них до уровня разработчика, пишет инструкции различного уровня, вплоть до полностью разжёванной инструкции пользователя, по которой сложной программой без проблем сможет пользоваться даже новичок.
2) Технический писатель «от клиента к разработчику» – это уже больше аналитик, его задача – правильно оценить потребности клиента, общаясь с ним, понять, что именно ему требуется, всё это тщательно записать, согласовать с клиентом и после этого донести его мысли до разработчиков в понятной им форме.
В каких областях может работать технический писатель?
Области работы технического писателя перечислить трудно – это вся IT-отрасль, кроме того, наука, журналистика (да-да, хороший, схватывающий на лету технический писатель после нескольких лет практики сможет описать что угодно), любая сфера, связанная с применением электронного оборудования, энергетикой. Зачастую ставятся задачи аналитического характера, а значит, частенько приходится залезать в экономику и бизнес-планирование. Что интересно, многие аналитики выросли именно из технических писателей, после длительной работы в качестве фрилансеров, журналистов или штатных техписов – писали обзоры, выполняли анализ рынков и прочее. Короче, умелец тот ещё, чем и ценен.
Какие задачи приходится выполнять техническому писателю?
Здесь мы не будем упоминать атавизмы типа «принести чай» и «настроить принтер», а рассмотрим типовые задачи, с которыми работают техписы.
— Создание руководств – техпис пишет руководства для пользователей, администраторов, установщиков (актуально для оборудования, когда имеет место отдельная инструкция по установке, подключению и запуску оборудования. Делается, чтобы не лепить туда же руководство пользователя или администратора, так как при этом полученный талмуд будет весить пуд). На руководства приходится основная масса задач и рабочего времени технического писателя.
— Создание статей – аналитические, обзорные и описательные статьи. Аналитика может быть как «с осмыслением», т.е. где много авторского мнения и текста «от себя», и может быть «строго фактическая», где анализируются имеющиеся материалы и делаются краткие выводы, которые, при должном качестве изложения, должны возникать у читателя сами по себе.
— Создание технических заданий – здесь есть два основных подвида: создание ТЗ по ГОСТ, как части общей документации на разработку (чаще всего при гос. контрактах). Второй вид – создание ТЗ на разработку для самих разработчиков. Оно может быть гораздо менее формальным и более подробным.
— Создание презентационных материалов – сюда можно отнести написание пресс-релизов, создание презентаций, текстов различных брошюр, рекламных буклетов и т.д.
— Переводы – локализация текстов, поступающих из-за рубежа. Как правило, речь идёт о переводе материалов разработчика для продвижения и продажи товара в России. Реже встречается ситуация, когда нужно изначально русские тексты транслировать на английский и другие языки. В этом случае уровень владения иностранным языком должен быть очень высоким.
— Видеопрезентации – создание видеоматериалов, зачастую со звуком, посвящённых продукции компании или какой-либо акции (могут повесить задачу на писателя, если нет маркетологов или им лень учиться делать это).
— Корректура и редактура – вычитка существующих текстов, их исправление и, при необходимости, дополнение и актуализация.
Написание руководств и инструкций – основная часть работы. А какие руководства бывают?
— Руководство пользователя – руководство для рядовых пользователей. Описывается всё просто и понятно. Главное – функциональность, описания настроек может не быть.
— Руководство администратора – документ для тех, кто ковыряется на уровне администратора в крупных комплексах. Пишется только для крупных систем, требующих специалиста, который будет контролировать их.
— Руководство разработчика – это описание кода, баз данных, элементной базы и физических принципов. Делается для обучения новых сотрудников, чтобы организовать преемственность в коллективе и устранить проблему незаменимости, когда от конкретного специалиста зависит, по сути, вся компания, так как полностью разобраться в коде без него будет практически невозможно.
В каком режиме может работать технический писатель?
В отличие от специалистов многих других профессий, техпис может работать не только как офисный сотрудник, но и как удалённый работник, при этом не теряя
свою функциональность. Здесь важно понять, когда реально необходимо работа в офисе (например, если работы всегда много и идёт непрерывное консультирование с сидящими в соседнем кабинете программистами), а когда это просто формальность и работать можно дома. Перечислять плюсы работы дома можно долго, а минусов существует всего два: может сузиться круг общения и, порой, трудно заставить себя работать. Дом – наша зона комфорта и ассоциируется прежде всего с отдыхом и расслаблением, а потом уже с работой. Плюс, при таком ритме вы «всегда на работе». Выбрать работу в офисе или удалёнку – решение каждого, но учитывать надо все указанные выше факторы. Можно одичать, можно залениться и провалить работу, можно взвалить на себя слишком много и сидеть не отрываясь. Нужен баланс.
Профессия технический писатель
Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений. В отличие от копирайтинга, здесь меньше творчества и больше регламентов. В данной статье мы расскажем, кто такой технический писатель и что входит в его обязанности, как стать таким специалистом и где искать работу, в том числе удаленно.
Содержание статьи:
- Кто такой технический писатель и что он делает?
- Плюсы и минусы профессии
- Сколько зарабатывают технические писатели?
- Что должен знать и уметь специалист?
- Как стать техническим писателем с нуля?
- Где искать работу?
-
Где найти технического писателя?
Кто такой технический писатель и чем он занимается?
Технический писатель – это специалист, который создает документацию к программам, интернет-сервисам, оборудованию и устройствам. Это могут быть как документы для инженеров и разработчиков, так и руководства для пользователей. Например, инструкция к смартфону, ноутбуку, метеостанции.
В функции технических писателей входит подготовка ТЗ, руководств, инструкций и других документов. По ним люди, которые будут пользоваться программами или оборудованием или участвовать в их доработке, смогут разобраться, что и как устроено и как работает. Технический писатель – это профессия, которая требует ответственности.
В должностные обязанности технического писателя входит:
- Сбор, анализ и систематизация данных о программе и ином продукте, для которого создается документация.
- Взаимодействие с разработчиками, проведение с ними интервью для получения необходимой информации.
- Подготовка технической документации, отвечающей требованиям нормативных документов. Например, ГОСТ.
- Редактирование и обновление технической документации, руководств и инструкций. Например, при обновлении ПО, выходе новых версий программ.
- Создание внутренних справочно-информационных систем, баз знаний для разработчиков.
-
Подготовка отчетов о проделанной работе.
Иногда в обязанности технических писателей включают работу над интерфейсами, локализацию. Например, необходимо перевести интерфейс программы с английского языка. Технический писатель подбирает термины на русском языке, которые наиболее близки к оригиналу, чтобы пользователи поняли, где и какие функции находятся.
Также в функции технических писателей включают подготовку простых графиков и диаграмм, скриншотов, учебных видео материалов. Иногда им поручают создание статей и рекламных материалов, хотя эту работу должен выполнять копирайтер.
Плюсы и минусы профессии технического писателя
|
Плюсы: |
Минусы: |
|
|
Сколько зарабатывают технические писатели?
Зарплата начинающего технического писателя начинается от 40 тыс. руб. в месяц. Средняя зарплата специалиста с опытом 2-3 года – 60-80 тыс. руб. в месяц. Специалисты, создающие документацию на английском языке, могут получать больше 150 тыс. руб. в месяц. Например, так платят в ИТ-компаниях, которые создают софт для западных рынков.
Технический писатель может работать как в офисе, так и удаленно, а также быть фрилансером. Средние цены на создание технической документации – от 500-1000 руб. за страницу (1800 знаков с пробелами). Например, разработка технического задания у фрилансера может стоить от 20 тыс. рублей, руководства для администратора – от 25 тыс. рублей. При заказе в компаниях эти документы будут стоить в 2 раза дороже.
Что должен знать и уметь технический писатель?
- Необходимо иметь высшее образование, желательно техническое.
- Знать предметную область, в которой ведется работа. Например, если вакансия открыта в веб-студии или ИТ-компании, потребуется знать языки программирования и разбираться в процессах разработки софта.
- Знать нормативные документы и требования, в частности, ГОСТ.
- Знание специализированного софта для разработки документации. Список ПО зависит от отрасли, в которой трудится специалист.
- Нужно уметь работать в команде, общаться с разработчиками и понимать пользователей, которые будут использовать продукт.
-
Желательно знать английский язык.
Как стать техническим писателем с нуля?
В эту профессию приходят двумя путями. Первый – человек с техническим образованием понимает, что разработка и проектирование – это не его. Решает вместо работы инженером попробовать себя в новой сфере. Второй путь – человек с гуманитарным образованием желает работать в технической сфере, но не программировать. Тогда он становится писателем.
Если вы новичок, то можете поискать вакансии с минимальными требованиями на HH.ru. Например, для создания онлайн-справок могут взять человека без технического образования и опыта. Так вы сможете постепенно погружаться в предметную область, осваивать новые задачи и профессионально расти.
Бесплатные курсы для технический писателей проводятся в Академии Гипербатона от компании Яндекс. Обучение занимает 1 месяц. Для поступления необходимо справиться с тестовым заданием. Лучшим выпускникам могут предложить работу.
Будет полезно читать книги, например, «Разработка технической документации» Вадима Глаголева. Это справочник, в котором собраны ссылки на ГОСТы и выдержки из них.
Много информации для начала карьеры в профессии можно найти на форуме технических писателей Techwriters.ru и на YouTube.
Где искать работу?
- Можно искать вакансии на сайте HH.ru. Советуем просматривать предложения из разных регионов, т.к. порой московские компании набирают сотрудников на удаленную работу.
- Предложения удаленной работы встречаются в компании Яндекс. Например, периодически в эту компанию ищут дистанционных авторов.
-
Посмотрите открытые вакансии в местных ИТ-компаниях, интеграторах, разработчиках софта. Часто они набирают стажеров, которых потом могут брать в штат.
Где найти технического писателя?
- Добавьте объявление на сайты для поиска удаленной работы. По ссылке вы найдете обзор ресурсов, где можно искать ИТ-специалистов.
-
Если вам нужен удаленный сотрудник или человек для разового проекта, добавьте вакансию на биржу Kadrof.ru. Сервис бесплатный для работодателей.
Рекомендуем
Бытует мнение, что профессия ретушера фотографий появилась одновременно с графическими редакторами, то есть относительно недавно. Однако это не …
Дизайнер интерфейсов – это перспективная и востребованная профессия, спрос на которую растет. Специалисты участвуют в разработке сайтов, мобильных …
Технический писатель
ПрофГид
Обновлено
Технический писатель (technical writer), еще одно название профессии – технический коммуникатор (technical communicator), составляет руководства по эксплуатации, инструкции, мануалы, журнальные статьи и другие вспомогательные документы для передачи сложной технической информации в понятной пользователям форме. Профессия подходит и гуманитариям, и технарям. Кстати, недавно центр профориентации ПрофГид разработал точный тест на профориентацию, который сам расскажет, какие профессии вам подходят, даст заключение о вашем типе личности и интеллекте.
Профессия подходит тем, кого интересует русский язык и литература и информатика (см.
выбор профессии по интересу к школьным предметам).
Содержание:
- Краткое описание: кто такой техрайтер
- Обязанности
- Технический писатель в ИТ
- Место работы
- Особенности профессии
- Важные качества
- Знания и навыки
- Обучение на технического писателя
- Вузы
- Оплата труда
- Зарплата технического писателя на ноябрь 2023
- Карьера
- Курсы алгоритмов программирования для новичков
- Примеры компаний с вакансиями технического писателя
Краткое описание: кто такой техрайтер
Технический писатель (техрайтер, techwriter) разрабатывает документацию для решения разного рода технических задач. Он может создавать руководства пользователя к приборам или разрабатывать и поддерживать документацию к компьютерным программам. Главная задача технического писателя – объяснить, как лучше использовать функции гаджета, оборудования или программы. Важно, чтобы текст легко читался и был понятен после первого прочтения.
Технические писатели создают бумажные и цифровые инструкции по эксплуатации, руководства по сборке и страницы «часто задаваемых вопросов», чтобы помочь сотрудникам технической поддержки, потребителям и другим пользователям в компании или отрасли. Также техрайтер разрабатывает, собирает и распространяет техническую информацию через каналы внутренней связи организации. После выпуска продукта технические писатели могут работать с менеджерами по обслуживанию клиентов.
Обязанности
Типичные задачи технического писателя:
- Определить потребности пользователей технической документации, понять, что именно нужно подробно разъяснить.
- Изучить образцы продуктов, проконсультироваться с их дизайнерами и разработчиками.
- Уточнить детали у технического персонала, непосредственно создающего продукт, чтобы сделать инструкции максимально понятными и простыми.
- Разработать и написать мануал, руководство пользователя, инструкцию и т. д.
- Написать или отредактировать вспомогательную документацию (информационный контент и др.).
- Редактировать материалы, подготовленные другими авторами или сотрудниками.
- Стандартизировать контент на разных платформах и носителях.
В работе технические писатели используют графические редакторы, чтобы сделать свои пояснения наглядными. В качестве иллюстраций используются не только статичные картинки, но и анимация, видеоролики.
Технические писатели также отвечают за согласованность технического контента и управление его использованием отделами компании, включая разработку продукта, производство, маркетинг и отношения с клиентами.
Технический писатель в ИТ
Если технический писатель работает с программными продуктами, то он может подключиться еще на стадии их разработки. Он принимает в ней участие, обсуждая возможные варианты дизайна программы, действия функций. Также он участвует в написании технического задания, документа «Программа и методика испытаний», которым пользуются тестировщики при приемке системы.
В ИТ технический писатель – это посредник между разработчиками продукта и конечными пользователями. Он составляет техническую документацию (руководства по эксплуатации для пользователей, ТЗ для разработчиков, описания админки и т. д.) на всевозможные программы и автоматизированные системы.
Основная часть работы техрайтера – написание руководств, которые бывают трех видов:
- Для пользователя. В них все описывается понятно, без деталей. Главное – функциональность продукта, описания настроек необязательны.
- Для администратора. Это уже более подробный документ для тех, кто на уровне администратора занимается крупными комплексами.
- Для разработчика. Это описание кода, баз элементов и данных, физических принципов. Пишется для новых сотрудников, чтобы обеспечить преемственность в коллективе и решить «проблему незаменимости»: это когда от одного-единственного специалиста зависит вся компания, потому что без него будет невозможно разобраться в коде.
Технические писатели часто работают с инженерами по компьютерному оборудованию, специалистами по компьютерной поддержке и разработчиками программного обеспечения для управления потоком информации между рабочими группами проекта во время разработки и тестирования. Поэтому технические писатели должны быть в состоянии понять и обсудить сложную информацию с людьми разных профессий.
Место работы
Технические писатели работают:
- в компаниях, разрабатывающих программные продукты, бытовую технику и аппаратуру для профессионального использования в медицине, науке и технике;
- в командах, которые проводят исследования юзабилити для улучшения дизайна продукта;
- на фрилансе и, например, помогают писать грантовые предложения для ученых-исследователей и учреждений или ведут блоги, аккаунты технологических компаний в соцсетях, используя интерактивные технологии для смешивания текста, графики, многомерных изображений, звука и видео.
Вообще, сферы, в которых может работать техрайтер, очень разные – от ИТ-отрасли, энергетики и производства электроники до журналистики.
Особенности профессии
Получив задание, технический писатель должен сначала проанализировать целевую аудиторию, чтобы выяснить, что ей потребуется и в каком ключе писать. Точный анализ определит, каким будет дизайн и содержание документа, его тональность (может понадобиться официально-деловой или понятный профессионалам стиль, иногда даже нужен беззаботно-юмористический – для соцсетей, например).
Анализ целевой аудитории также помогает определить глубину изложения. Например, документация по программному обеспечению, как правило, очень ясна и проста, чтобы неопытные пользователи могли легко справиться без посторонней помощи, в то время как инструкции к медицинским приборам, которыми пользуются врачи, могут быть написаны более сложным языком, поскольку предполагается, что читатель уже обладает знаниями в области медицины и в целом представляет, зачем нужен аппарат.
Еще один важный компонент технического письма – дизайн документа. Техрайтер должен решить, как использовать изображения, списки, диаграммы и заголовки, чтобы повысить удобство прочтения. Нужно сделать акценты на таких разделах, как «полезные советы» или «предупреждения», используя различные цвета, выделение стилями и размерами шрифта. При этом всегда нужно помнить, что слишком сложные графики, витиеватость, обилие заголовков, неразборчивый шрифт и так далее будут мешать пониманию текста. В общем, нужно найти баланс между краткостью и наглядностью, чтобы избежать визуальной громоздкости – это основная стратегия дизайна, которой должен придерживаться технический писатель.
Важные качества
Технический писатель должен сочетать в себе качества технаря и гуманитария. Знания «матчасти» у технического писателя могут быть неглубокими – ему не обязательно уметь паять или программировать, но от слов «осциллограф» или SQL он не должен впадать в ступор. Интерес к технике и программированию, усидчивость и внимательность должны в нем сочетаться с желанием осваивать новое и делиться своими знаниями.
Техрайтер должен уметь быстро разобраться в незнакомом продукте или технологии и изложить сложные вещи простыми словами. Ему нужно уметь поставить себя на место пользователей, посмотреть на продукт их глазами, увидеть проблемы, с которыми они могут столкнуться, и показать им, как их можно решить.
Чтобы стать техническим писателем в ИТ-компании, надо быть:
- любознательным;
- усидчивым;
- внимательным;
- терпеливым.
Кроме того, очень важно уметь работать с полученной информацией и раскладывать ее по полочкам, быстро разбираться в технических аспектах и описывать их в форме, подходящей для понимания конкретной аудиторией (рядовыми пользователями или профи). Навыки общения нужны не меньше, чем аналитическое мышление. Надо уметь задавать правильные вопросы программистам, чтобы досконально изучить возможности ПО.
Знания и навыки
- Необходимы технические знания в объеме, который позволяет разобраться в новом продукте, системное видение документирования как инженерной дисциплины, понимание процессов документирования.
- В работе над новой программой нужны базовые навыки программирования. Для создания иллюстраций требуется знание графических программ (Adobe PhotoShop и др.) .
- Часто требуется владение письменным техническим английским, знание ГОСТов оформления технических проектов.
- Очень важно уметь ясно выражать свои мысли в тексте.
Обучение на технического писателя
В учебных заведениях технических писателей не готовят. Начать карьеру техрайтера можно, получив высшее техническое образование, но обычно техническими писателями становятся люди с лингвистическим или филологическим образованием. Очень ценятся те, кто умеет отлично писать на английском языке, или «технари» с превосходным знанием английского (но их мало, они уходят в разработку, тестирование). Профессию техрайтеры осваивают самостоятельно и на практике.
Что нужно сделать для начала тем, кто хочет работать техрайтером в ИТ:
- Прочитать Microsoft Manual of Style, изучить стили составления документации крупных технических компаний, чтобы научиться грамотно, последовательно, доходчиво и стилистически правильно излагать информацию.
- Тем, кто хочет работать в аутсорсинговых компаниях, нужно отлично владеть иностранным языком (английским в первую очередь).
- Получить базовые знания по HTML, XML, CSS, SQL.
- Хотя бы поверхностно ознакомиться с системной и программной инженерией, чтобы иметь о них представление (это будет большим плюсом).
- Освоить основные инструменты, которые используют технические писатели: Microsoft Word, Microsoft HTML Help Workshop, Help&Manual, AutorIT, RoboHELP, MadCapFalre, MadCap Software (разработка электронной справки), DocBook/XML, DITA, SiberSafe (автоматизация документирования), Adobe FrameMaker.
Оплата труда
Зарплата технического писателя зависит не только от его квалификации, но и от масштаба компании, в которой он работает. На рынке есть предложения от небольших компаний с зарплатой 40–50 тысяч рублей. В них можно начинать карьеру, чтобы потом перейти, скажем, в SberTech и получать уже 200 тысяч.
Карьера
Направления карьерного развития технического писателя:
- горизонтальный рост – совершенствоваться как techwriter, углубляться в специальность;
- вертикальный рост – должности руководителя подразделения технических писателей, начальника отдела технической документации;
- переход в смежные сферы; есть разные векторы:
- переквалифицироваться в бизнес-аналитика, дата сайентиста, тестировщика, верстальщика (если больше нравится техническая сторона работы);
- двигаться в маркетологи или PR-менеджеры (если больше по душе творческая составляющая).
Многие техрайтеры уходят в бизнес-анализ: писателям часто ставят аналитические задачи, и им приходится залезать в экономику и бизнес-планирование, так что они успевают все это глубоко изучить. Еще из бывших технических писателей получаются отличные проект-менеджеры.
Курсы алгоритмов программирования для новичков
Примеры компаний с вакансиями технического писателя
Кто такой технический писатель?
Технический писатель (technical writer) — это специалист, который преобразует сложные и технически трудные письменные материалы в четкую и лаконичную документацию, которую будет читать целевая аудитория. Они собирают и разрабатывают техническую информацию для создания инструкций по обслуживанию и эксплуатации, технических и инструктивных руководств, журнальных статей и другой документации для производителей, проектировщиков и клиентов. Технические писатели также могут писать техническое задание (ТЗ).
Что делают технические писатели и чем занимаются?
Обязанности на примере одной из вакансий:
- разработка технической эксплуатационной документации и конструкторской документации на существующую и новую продукцию компании (ТУ, ТО, руководства по эксплуатации, паспорта, формуляры, чертежи, схемы и пр.);
- подготовка документации в соответствии с требованиями ЕСКД, проверка КД на соответствие требованиям ЕСКД;
- анализ требований проекта, требований ТЗ;
- разработка/доработка ТЗ;
- согласование технических решений с представителями разных подразделений компании, с заказчиком.
Что должен знать и уметь технический писатель?
Требования к техническим писателям:
- Собирать требования к задаче
- Декомпозировать задачи
- Проводить интервью с техническими специалистами
- Передавать работу на вычитку и работать с правками
- Планировать работу над задачей в Trello
- Собирать данные по задаче
- Разрабатывать техническую документацию
- Разрабатывать техническое задание
- Использовать языки разметки Markdown, RST, asciidoc, XML
- Изучать целевую аудиторию продукта
- Работать с чертежами, таблицами, графиками, блок-схемами
Востребованность и зарплаты технических писателей
На сайте поиска работы в данный момент открыто 1 010 вакансий, с каждым месяцем спрос на технических писателей растет.
Количество вакансий с указанной зарплатой технического писателя по всей России:
- от 70 000 руб. – 271
- от 120 000 руб. – 142
- от 175 000 руб. – 68
- от 225 000 руб. – 26
- от 275 000 руб. – 17
Вакансий с указанным уровнем дохода по Москве:
- от 85 000 руб. – 122
- от 130 000 руб. – 82
- от 180 000 руб. – 42
- от 230 000 руб. – 15
- от 275 000 руб. – 11
Вакансий с указанным уровнем дохода по Санкт-Петербургу:
- от 70 000 руб. – 65
- от 105 000 руб. – 37
- от 140 000 руб. – 22
- от 175 000 руб. – 18
- от 210 000 руб. – 9
Как стать техническим писателем и где учиться?
Варианты обучения для технического писателя с нуля:
- Самостоятельное обучение – всевозможные видео на YouTube, книги, форумы, самоучители и т.д. Плюсы – дешево или очень недорого. Минусы – нет системности, самостоятельное обучение может оказаться неэффективным, полученные навыки могут оказаться невостребованными у работодателя;
- Онлайн-обучение. Пройти курс можно на одной из образовательных платформ. Такие курсы рассчитаны на людей без особой подготовки, поэтому подойдут большинству людей. Обычно упор в онлайн-обучении делается на практику – это позволяет быстро пополнить портфолио и устроиться на работу сразу после обучения.
Ниже сделали обзор 15+ лучших онлайн-курсов.
15+ лучших курсов для обучения технического писателя: подробный обзор
Стоимость: разная стоимость
- Программа из 3 курсов
- Упор на практику напишете 3 работы
- Разбор кейсов
- Бонусный курс по системе контроля версий Git.
Технический писатель — это профессионал, который умеет простым языком описать сложные процессы. Например, как пользоваться техническим оборудованием на заводе или CRM-системой в компании. Он составляет руководства, документацию, инструкции, пишет технические задания (ТЗ) для исполнителей.
Кому подойдёт этот курс:
- Новичкам
Познакомитесь со всеми этапами работы технического писателя. С нуля научитесь взаимодействовать с заказчиками, писать технические тексты и сможете брать заказы на фрилансе. - Тем, кто учится писать технические тексты
Опытный преподаватель поделится универсальными знаниями о профессии, которые позволят вам работать над широким кругом задач, а не ограничиваться отдельной нишей.
Чему вы научитесь:
- Планировать рабочий процесс
Будете оценивать, сколько времени требуется для работы над документацией в различных жанрах. Организуете рабочий процесс в Trello. - Пользоваться инструментами
Познакомитесь с важными для писателя функциями Microsoft Word, освоите OneDrive, Google Документы, языки разметки. Получите технические навыки: познакомитесь с HTML, CSS и git. - Работать с фактурой
Узнаете, как подготовиться к интервью с техническими специалистами, правильно задавать вопросы и вести конспекты. Научитесь собирать информацию из чертежей, таблиц, графиков. - Писать грамотные тексты
Познакомитесь с правилами стилистики, типографики и будете структурировать текст так, чтобы неподготовленный читатель всё понял. Облегчите общение между разработчиками ПО и нетехническими специалистами в компании. - Разрабатывать и адаптировать документацию
Будете создавать технические задания, паспорта, технические условия, руководства по эксплуатации и онлайн-справки. Оформлять проекты по стандартам ГОСТ, ISO, IEC и IEEE. - Презентовать себя как специалиста
Добавите в портфолио работы, которые сделаете на курсе. Сможете доказать свою ценность и полезность работодателю.
Программа
Вас ждут онлайн-лекции и практические задания на основе реальных кейсов.
23 модуля, 54 урока
Основные курсы
- Технический писатель. Базовый уровень
- Введение в профессию.
- Типовой сценарий работы технического писателя.
- Microsoft Word и другие инструменты написания.
- Работа с техническим текстом.
- Зарубежные и отечественные стандарты.
- Создание документа: техническое задание (ТЗ).
- Создание документа: паспорт (ПС).
- Создание документа: технические условия (ТУ).
- Создание документа: руководство по эксплуатации (РЭ).
- Создание онлайн-справки.
- Управление знаниями.
- Как получить работу технического писателя.
- Технический писатель-дизайнер
- Введение.
- Базовый HTML.
- Базовый CSS. Часть 1.
- Базовый CSS. Часть 2.
- Подготовка к верстке.
- HTML-разметка.
- Flexbox.
- Стилизация.
- Технический писатель PRO
- Освоение инструментов визуализации.
- Освоение технологий и средств для автоматизации документирования.
- Technical documentation.
- Дипломные проекты
- Руководство по эксплуатации
Дополнительные курсы
- Система контроля версий Git
- Версии программного кода.
- Установка Git.
- Индекс и частичные коммиты.
- Сравнение версий.
- Отмена изменений и откат версий.
- Репозитории и коллективная работа.
- Ветки — создание и управление.
- Слияние и разрешение конфликтов.
- Полезные инструменты.
- Правила работы с Git.
Дипломные проекты
- Руководство по эксплуатации
- Оформите документ по ГОСТу с применением оглавления, стилей, сквозной автонумерации, перекрёстных ссылок.
Диплом Skillbox
Подтвердит, что вы прошли курс, и станет дополнительным аргументом при устройстве на работу.
Цели семинара/курса:
- Получить знания методик и приемов подготовки технической документации;
- Применять существующие стандарты документирования;
- Использовать программные инструменты для технических писателей;
- Грамотно вести переговоры с техническими специалистами;
- Разрабатывать различные виды технических документов.
Профессиональный стандарт «Технический писатель»: содержание и требования:
- Техническая документация и технический писатель: основные термины и понятия. Введение в проблему.
- Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика.
- Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
- Навыки и умения технического писателя.
- Задачи технического писателя. Группы читателей.
- Варианты занятости и сферы деятельности технического писателя.
- Единые стандарты документирования.
- Отечественные и зарубежные стандарты.
- Классификация ГОСТов.
- Зарубежные стандарты ИСО в области системной и программной инженерии.
- Назначение стандартов.
- ГОСТ 7.32-2001.
- Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
- Система стандартов ГОСТ 19 и ГОСТ 34.
- Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД).
- Система стандартов по информации, библиотечному и издательскому делу (СИБИД).
- Единая система конструкторской документации (ЕСКД).
- Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов.
- Управление документированной информацией в контексте требований МС ISO 9001:2015.
- Виды и стили технических текстов.
- Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия.
- Стили технической документации.
- Средства и методы создания технических текстов.
- Блок целеполагания: цель, задачи, методы и средства.
- Определение аудитории и уровня разъяснения материала.
- Об описании БД, кодов. Создание руководств пользователя.
- ПРАКТИКА: Корректировка имеющихся текстов: основы редактирования и корректуры.
- Приёмы работы с техническими текстами.
- Терминология в технической документации: правила применения единых терминов.
- Визуализация и графическое сопровождение технических документов.
- Работа над ошибками и лексические тонкости в технических документах.
- Создание векторных изображений и контроль ошибок в объемных документах.
- Векторные изображения в документе.
- Иллюстрации в MS Word.
- Фотография и векторная иллюстрация в документах.
- Методика отрисовки векторной графики в PowerPoint.
- Специальная вставка изображений в MS Word.
- Контроль ошибок в объемных документах.
- Базовые процессы по контролю документации.
- Версионирование. Системы баг-трекинга ПО — помощники технического писателя.
- Организация контроля за ошибками и доработками в документах.
- Процесс перевода технической документации (на примере английского языка).
- Сложности перевода на другой язык, основные подводные камни.
- Грамматика и лексика в техническом переводе.
- Правила и способы перевода технических текстов.
- Применяемое программное обеспечение и приёмы его корректного использования.
- Понятие локализации в технических переводах.
- Практика: Перевод и редактирование технического текста.
- Программное обеспечение в работе технического писателя.
- Базовые форматы документации: HTML, DOC(X), CHM, PDF.
- HTML Help Workshop.
- Средства MS Office.
- Средства Adobe.
- Платформа DocBook/XML.
- Wiki-системы.
- Облачные технологии (Google Docs, Evernote, Dropbox и др.).
- Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin.
Цель курса:
- Получить знания методик и приемов подготовки технической документации;
- Применять существующие стандарты документирования;
- Использовать программные инструменты для технических писателей;
- Грамотно вести переговоры с техническими специалистами;
- Разрабатывать различные виды технических документов.
Программа курса:
Техническая документация и технический писатель: основные термины и понятия. Введение в проблему.
- Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика.
- Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
- Навыки и умения технического писателя.
- Задачи технического писателя. Группы читателей.
- Варианты занятости и сферы деятельности технического писателя.
Единые стандарты документирования.
- Отечественные и зарубежные стандарты.
- Классификация ГОСТов.
- Зарубежные стандарты ИСО в области системной и программной инженерии.
- Назначение стандартов.
- ГОСТ 7.32-2001.
- Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
- Система стандартов ГОСТ 19 и ГОСТ 34.
- Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД).
- Система стандартов по информации, библиотечному и издательскому делу (СИБИД).
- Единая система конструкторской документации (ЕСКД).
- Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов.
- Управление документированной информацией в контексте требований МС ISO 9001:2015.
Виды и стили технических текстов.
- Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия.
- Стили технической документации.
Средства и методы создания технических текстов.
- Блок целеполагания: цель, задачи, методы и средства.
- Определение аудитории и уровня разъяснения материала.
- Об описании БД, кодов. Создание руководств пользователя.
- ПРАКТИКА: Корректировка имеющихся текстов: основы редактирования и корректуры.
Приёмы работы с техническими текстами.
- Терминология в технической документации: правила применения единых терминов.
- Визуализация и графическое сопровождение технических документов.
- Работа над ошибками и лексические тонкости в технических документах.
Создание векторных изображений и контроль ошибок в объемных документах.
- Векторные изображения в документе.
- Иллюстрации в MS Word.
- Фотография и векторная иллюстрация в документах.
- Методика отрисовки векторной графики в PowerPoint.
- Специальная вставка изображений в MS Word.
- Контроль ошибок в объемных документах.
- Базовые процессы по контролю документации.
- Версионирование. Системы баг-трекинга ПО — помощники технического писателя.
- Организация контроля за ошибками и доработками в документах.
Процесс перевода технической документации (на примере английского языка).
- Сложности перевода на другой язык, основные подводные камни.
- Грамматика и лексика в техническом переводе.
- Правила и способы перевода технических текстов.
- Применяемое программное обеспечение и приёмы его корректного использования.
- Понятие локализации в технических переводах.
- Практика: Перевод и редактирование технического текста.
Программное обеспечение в работе технического писателя.
- Базовые форматы документации: HTML, DOC(X), CHM, PDF.
- HTML Help Workshop.
- Средства MS Office.
- Средства Adobe.
- Платформа DocBook/XML.
- Wiki-системы.
- Облачные технологии (Google Docs, Evernote, Dropbox и др.).
- Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin.
Для кого:
Для специалистов, ответственных за разработку и сопровождение технической документации, технических писателей, IT-специалистов.
Программа:
- Профессиональный стандарт «Технический писатель»: содержание и требования.
- Единые стандарты документирования.
Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам. Система стандартов. Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов. Управление документированной информацией в контексте требований МС ISO 9001:2015. Мастер-класс: «Сложности написания руководства пользователя по ГОСТ 34». - Методы и приемы работы с техническими текстами.
Методы аналитико-синтетической переработки, используемые в техническом писательстве. Этапы создания технического текста. Изучение целевой аудитории: метод сценариев. Создание плана технического текста: интеллектуальное картирование, определение структуры текста. Техническое аннотирование и реферирование. Оформление цитирования. Читабельный текст: функциональность стиля, информативность и дизайн. Виды функциональных стилей в технической коммуникации. Терминология в технической документации. Информационный дизайн технического документа. Визуализация информации и применение инфографики в техническом документе. Особенности создания и использования деловой графики. Мастер-классы: структурирование информации при создании технической документации. Создание инфографики для визуализации научно-технической информации. Создание и оформление технического задания, отчета, руководства пользователя. - Техническая коммуникация и техническое писательство.
Особенности технического документирования. Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления. Навыки, необходимые техническому писателю. Формат и структура технического документа. Методы копирайтинга научно-технической рекламы, используемые в техническом писательстве. Принципы популяризации научно-технического текста. - Промышленный подход к разработке документации.
Разработка документации на основе принципа единого источника. Стандарт DITA. Особенности внедрения технологии DITA на предприятии, целесообразность использования XML-подобных документов. Разработка структурированного контента разных типов, смысловая разметка документов, формирование документа из карты и топиков, профилирование. Oxygen. Практическое занятие. - Принципы создания технических текстов.
Целевое назначение технической документации: определение целей обращения пользователей к техническим документам. Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов. Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации. Мастер-класс: создание научно-технического рекламного текста. - Оформление текста по ГОСТ 2.105 «ЕСКД.
Общие требования к текстовым документам». Параметры для оформления текста в электронном виде. Правила оформления таблиц. - Документация, ориентированная на пользователя:
Help и онлайн-справка. Confluence. Создание профессиональных справочных файлов. Формирование справки с помощью Robohelp. - Документирование программного обеспечения, программно-аппаратных изделий.
Предмет документирования: программный продукт, документация пользователя и ее характеристики. Документы, используемые при эксплуатации программного продукта. - Создание векторных изображений и контроль ошибок в объемных документах.
Векторные изображения в документе. Технический писатель или дизайнер? Иллюстрации в MS Word. Фотография и векторная иллюстрация в документах. Методика отрисовки векторной графики в PowerPoint. Специальная вставка изображений в MS Word. Контроль ошибок в объемных документах. Базовые процессы по контролю документации. Страхи при написании объемной документации. Версионирование. Системы баг-трекинга ПО помощники технического писателя. Организация контроля за ошибками и доработками в документах. - Секреты мастерства.
Инструменты, используемые техническими писателями. Microsoft Word — секреты мастерства для технического писателя. Шаблоны. Применение, создание и изменение стилей. Форматирование абзацев заголовка, текста, списка, таблицы. Многостраничные таблицы. Формирование оглавления. Создание многоуровневой нумерованной структуры документа. Добавление названий к объектам. Перекрестные ссылки. Специальные поля в документе. Автозаполнение типовых документов с помощью полей слияния. Автозамена и автотекст. Расширенные возможности поиска и замены. Регулярные выражения. Макетирование. Связанные надписи. Печать брошюры. - Программное обеспечение в работе технического писателя.
HTML Help Workshop, средства Adobe, платформа DocBook/XML. Облачные технологии (Google Docs, Evernote, Dropbox и др.). Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin. Практика: ознакомление с возможностями отдельных программных комплексов.
Стоимость: нет информации
Краткое описание курса:
Сам курс состоит из текстового материала и заданий по определенным темам. Видео нет, зато есть куратор, которому можно задать интересующие вопросы.
Задания идут от простых к сложному. Сначала учишься писать деловое письмо, но очень быстро материал усложняется. Большая часть курса посвящена правильному написанию мануалов «от» и «до»: т.е. как описание всей функциональности продукта, так и описание FAQ.
Следующий большой раздел посвящен юзабилити тестированию написанного руководства пользователя, подготовке отчета по тестированию и улучшению мануала на основе полученных результатов.
Последнее задание — это написание технического отчета по выбранной теме.
Почти все задания надо выполнять в xml редакторе, поэтому параллельно тебе необходимо изучить курс по использованию таких редакторов в тех.писательстве.
Стоимость: нет информации
Краткое содержание курса:
Модуль 1 — Профессия технический писатель
- Основные обязанности технического писателя
- Маркетинговые и технические тексты
- Технический писатель + Аналитик
- Основные профессиональные навыки технического писателя
- Дополнительные задачи технического писателя
Модуль 2 — Поиск работы технического писателя
- Поиск вакансии
- Составление резюме
- «Хорошее» собеседование
- Определение текущих навыков
- Составление плана профессионального развития
Модуль 3 — Техническая документация
- Структура технического документа
- Программный продукт и программное средство
- Стили технической документации
- Единые стандарты документирования
- Написание статей
Модуль 4 — Этапы документирования
- Место технической документации в проекте
- Постановка задачи для технического писателя
- Интервью
- Работа технического писателя в команде
- Вычитка, тестирование и размещение документации
Модуль 5 — Английский язык в работе технического писателя
- Особенности перевода
- Техническая документация на английском языке
- Названия основных элементов интерфейса на английском языке
Модуль 6 — Инфостиль
- Инфостиль в технической документации
- Основы инфостиля
Модуль 7 — Особенности организации процесса документирования
- Оценка сроков документирования
- Вёрстка документа
Модуль 8 — Текст в интерфейсе
- Правила написания текста в интерфейсе
- Психология пользователей
Модуль 9 — Видео-инструкции
- Текст или видео
- Процесс создания видео-инструкции
Модуль 10 — ПО в работе технического писателя
- Список ПО технического писателя
- Особенности работы в Confluence.
Стоимость: нет информации
Технический писатель — это специалист, который занимается составлением и управлением документов, необходимых во время и для разработки различных IT-программ и автоматизированных систем. К технической документации относят: задания и инструкции для специалистов, руководства по эксплуатации для пользователей, техническое задание (ТЗ), технические условия (ТУ), технический паспорт, прочие описания продукта.
- Выбор темы для видео инструкции
- Запись видео инструкции в виде скринкаста
- Размещение видео инструкции на видео хостинге
- Отправка задания на общественную экспертизу
- Дополнительные ресурсы.
Технический писатель (technical writer) в IT составляет техническую документацию к программам и поддерживает ее в актуальном состоянии. Его задача – донести до пользователя информацию об особенностях работы программы, ее основных функциях и проблемах, которые могут возникнуть.
Курс научит создавать техническую документацию, находить релевантную информацию, определять конечного пользователя документации, лаконично доносить контент и грамотно структурировать текст.
Для кого этот курс:
- для студентов с хорошим знанием английского языка (уверенный Intermediate и выше);
- для копирайтеров, у которых есть навыки письма на английском, но нет опыта подготовки технической документации;
- для специалистов, которые занимаются написанием документации и сталкиваются с проблемой лаконичного изложения, грамотного структурирования и оформления текста;
- для всех, кто владеет английским на уровне Intermediate и выше и планирует попробовать себя в сфере IT.
Вы узнаете
Основа курса – получение теоретических и практических навыков создания документации:
- анализ продукта;
- поиск конечного пользователя;
- определение типа документов, подходящих для продукта;
- составление плана активностей;
- создание документов;
- использование лексики, которая соответствует стандартам;
- использование инструментов для создания документов.
Программа курса:
- Вводное занятие
- Работа на IT проектах
- Техническая документация в IT-проектах
- Описание пользовательского интерфейса
- Организация документа на микроуровне
- Организация документа на макроуровне
- Task-oriented documentation Часть 1
- Task-oriented documentation Часть 2
- Concept topic, reference topic, troubleshooting topic
- Визуализация информации
- Оформление и редактирование
- Инструменты управления проблемами, задачами, проектами и wiki software на примерах программ Jira и Confluence
- Инструменты создания пользовательской справки, статических сайтов
- Итоговое занятие
- Экзамен. Подготовка итогового проекта (2 недели)
- Защита итогового проекта.
Курсы для технических писателей, проводимые компанией «ПроТекст», являются первым в России полноценным образовательным проектом в области документирования. Курс разработан техническими писателями-практиками с большим стажем и одобрен Новосибирским государственным техническим университетом в 2012 году. В 2014 году курс также одобрил Белорусский государственный университет.
Цель курса: Подготовка специалистов в области разработки технической документации и аналитики в IT-сфере.
Стоимость: 16 800 ₽ — 21 100 ₽
Цель курса: Повышение квалификации специалистов в области разработки технической документации и аналитики в IT-сфере.
Темы курса:
- Введение в специальность
- Как стать техническим писателем
- Юридические и территориальные аспекты работы
- Типы текстов и их пользователей
- Форматы документации и статей
- Стили технических текстов
- Основы написания технических текстов
- Методика написания документации на ПО и оборудовании
- Методика написания технических и аналитических статей
- Методика разработки видеодокументации
- Методика разработки презентаций
- Методика описания программного кода, баз данных и принципиальных схем оборудования
- Методика разработки технических заданий
- Методика разработки маркетинговых текстов
- Работа с переводной документацией.
- Технические переводы
- Эргономика в сети. Как оформлять сайты
- Применяемое программное обеспечение
- Специфика работы технического редактора
- Производственные процессы
- Обзор дополнительных областей
- Стандарты в документировании
- Что можно освоить самостоятельно?
- Тестирование документации
- Итоговая практическая работа
- Итоговая работа включает в себя несколько заданий: документация на программное обеспечение; статья-обзор или аналитическая статья; презентация продукта для представления на публичном мероприятии или «продающий» текст.
Данный курс позволит вам освоить востребованную и высокооплачиваемую профессию технического писателя. И получить все знания и навыки, необходимые для успешной карьеры:
- Правовые основы профессиональной деятельности;
- Профессиональные стандарты и компетенции;
- Техническая документация, этапы документирования, инфостиль, текст в интерфейсе;
- Разработка и оформление инженерной технической документации в соответствии с заданным стандартом;
- Английский язык в работе технического писателя, презентация сложной технической продукции и т.д.
В результате обучения вы получаете диплом о профессиональной переподготовке установленного образца, который даёт право на ведение профессиональной деятельности.
Стоимость: 11 200 ₽ — 14 490 ₽
Компетенции, которые вы приобретёте в процессе обучения:
- использование методик и приёмов подготовки технической документации в профессиональной деятельности;
- выделение подготовки технических текстов в самостоятельную функциональную область;
- развитый навык письменной коммуникации в сфере технического документирования;
- навык постановки задач пред техническими специалистами.
Вы научитесь:
- разрабатывать различные виды технических документов;
- применять существующие стандарты документирования;
- использовать программные инструменты для технических писателей;
- грамотно вести переговоры с техническими специалистами.
Программа курса:
- Модуль 1. Техническая документация и технический писатель: основные термины и понятия. Введение в проблему (1 ак. ч.)
- Модуль 2. Виды и стили технических текстов (2 ак. ч.)
- Модуль 3. Средства и методы создания технических текстов (3 ак. ч.)
- Модуль 4. Единые стандарты документирования (2 ак. ч.)
- Модуль 5. Приёмы работы с техническими текстами (1 ак. ч.)
- Модуль 6. Процесс перевода технической документации (на примере английского языка) (2 ак. ч.)
- Модуль 7. Программное обеспечение в работе технического писателя (2 ак. ч.)
- Модуль 8. Текущая аттестация (3 ак. ч.)
Стоимость: 10 900 ₽ — 12 900 ₽
Технический писатель – это специальность, являющаяся весьма востребованной. Технический писатель занимается написанием документации для решения технических задач, поэтому работают такие специалисты в компаниях, разрабатывающих программные продукты, бытовую технику и аппаратуру для профессионального использования в медицине, науке и технике.
Особенностью данной профессии является то, что автор должен уметь создавать технические тексты разных стилей, сочетая в себе задатки «лирика» и «физика».
Пройдя обучение, слушатели получат знания, необходимые для работы с документацией, научатся писать тексты различных стилей на техническую тематику (технические статьи, технические задания, руководства пользователей, руководства по технической эксплуатации, формуляры и др.) на основе отечественных и зарубежных стандартов документирования, а также легко смогут применить приобретенные умения и навыки в реальных рабочих условиях.
Успешное окончание обучения по программе курса позволит специалистам:
Знать:
- существующие виды и стили технических документов
- основные принципы и единые стандарты технического документирования
- этапы и тонкости разработки технической документации
Уметь:
- разрабатывать техническую и программную документацию разного типа от технических статей до руководств пользователя
- работать с технической документацией на иностранном языке
- использовать программное обеспечение для разработки техдокументации
- создавать обучающие видеоролики
Владеть:
- терминологией и грамотным подходом при разработке технических документов различного стиля
- навыками верстки технической документации
- навыками оформления скриншотов.
Содержание:
- Профессия технический писатель
- Особенности написания технической документации. Основные принципы написания технической документации
- Этапы документирования. Работа с задачей на документирование
- Особенности разработки ГОСТовой документации
- Разработка внутреннего руководство по стилю
- Типы программных продуктов
- Предмет документирования. Способы чтения документации пользователем
- Детальность изложения в технической документации
- ГОСТ 19. ГОСТ 34. Структура ТЗ
- Структура Руководства пользователя
- Международные стандарты документирования. Особенности написания документации на английском языке
- Правила вёрстки. Основные ошибки в вёрстке технической документации. Плюсы и минусы различных программ для вёрстки
- Основные принципы дизайна
- Роль скриншотов в документе. Правила оформления скриншотов. ПО для создания и оформления скриншотов
- ПО для планирования рабочего времени. ПО для написания документации
- ПО для создания иллюстраций и схематических изображений. ПО для работы с виртуальными машинами
- Создание обучающих видеороликов. ПО для создания обучающих видеороликов
- Практические задания:
- Обсуждение фрагментов инструкции.
- Написание простой инструкции.
- Поиск необходимого документа и чтение необходимого ГОСТа.
- Оформление Руководства пользователя по ГОСТу.
- Сверстать документ.
- Найти 3 некорректных и 3 корректных скриншота.
- Написать инструкцию и вставить в неё скриншоты.
Стоимость: разная стоимость
Дистанционные курсы:
- Профессиональная разработка документа «Пояснительная записка» по ГОСТ
Курс предназначен для технических писателей, разработчиков документации на программные продукты, программистов, руководителей проектов и IT-специалистов, занятых в области проектирования автоматизированных систем и программных продуктов для государственных и коммерческих заказчиков.
В курсе подробно рассматривается процесс создания одного из самых сложных документов технического проекта — Пояснительной записки. - Разработка и оформление эксплуатационной документации на техническое устройство согласно требованиям ГОСТ ( ЕСКД)
Данный курс посвящен вопросам разработки, оформления и согласования эксплуатационной документации (ЭД) для технических устройств. Рассмотрены основные виды ЭД, комплектность ЭД, принципы формирования обозначения документа.
Приведены правила согласования ЭД и примеры оформления документа. На примерах показана последовательность разделов документа.
Объясняется структура и содержание разделов конкретных ЭД (паспорт, формуляр, руководство по эксплуатации, ведомость эксплуатационных документов и др.), правила оформления графической и текстовой информации. Приведены ссылки на стандарты, в соответствии с которыми разрабатывается ЭД.
И др.
Курсы:
- Открытый онлайн-курс по технической документации в IT-проектах
Расскажем обо всем понемногу: о типах технических документов, об управлении документационными процессами и о документационном инструментарии. - Technical Writing 101, базовый курс по документированию
Курс будет интересен как будущим профессионалам в области документирования (мы помогаем нашим студентам с трудоустройством), так и компаниям: мы можем целевым образом подготовить вам сотрудников на целый документационный отдел. - Advanced Technical Writing
Семинар для практикующих техписателей.
Расскажем тонкости и хитрости, интересные для специалистов с опытом.
И др.
Курс введения в техническое писательство подойдет тем, кто любит разбираться в работе программного обеспечения, устройств и описывать свой опыт в форме доступных и лаконичных инструкций на английском языке.
В рамках курса узнаете специфику работы технического писателя, инструменты, используемые для создания документации, подходы к написанию пошаговых процедур и технических описаний.
Успешное прохождение курса позволит претендовать на позицию стажера или младшего технического писателя в Центр разработки Orion Innovation (ранее MERA).
Содержание курса:
- What is the job of a technical writer?
- Technical writing for IT products.
- Technical writing tools: overview.
- Technical writing style.
- Content development process.
- Planning documentation.
- Topic-based writing.
- Document review.
- Practice — Working with MS Word.
- Practice — Working with graphical tools.
- Practice — Writing task topics.
Когда IT-продукт готов, нужно сделать так, чтобы им было удобно пользоваться – специалистам, которые будут его поддерживать, вносить в него изменения и пользователя. Для этого нужна техническая документация – она дает ответы на часто задаваемые вопросы и позволяет не тратить лишнего времени на поиск нужной информации. Технические писатели и есть те люди, кто раскладывает всю эту информацию по полочкам.
Главная задача технического писателя – четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть. Такого рода инструкции как правило читают:
- инженеры, которые поддерживают программы или дорабатывают их;
- пользователи разного уровня подготовки, для которых эти программы и создаются.
Инженеру может быть непонятно, как именно работает код, почему систематизация данных происходит именно по предложенным алгоритмам и как автоматизирован процесс. Обычным пользователям может быть трудно разобраться с последовательностью действий, понять, можно ли отменить операцию и как это сделать, как настроить быстрый доступ к самым нужным функциям, какие кнопки для этого созданы. Инженеры найдут ответы в сопровождающей технической документации, пользователи посмотрят инструкцию, написанную к программе, или зайдут в раздел «Помощь» или FAQ.
Часто люди обращаются к инструкциям только тогда, когда становится совсем непонятно или что-то идет не так. Хорошо, если это произойдет до того, как что-нибудь будет сломано, иначе скажут – продукт плохой. Технический писатель должен предусмотреть такие ситуации: предупредить о возможной поломке, описать ее, предложить решение.
Что делает технический писатель
Профессиональные знания, умения и навыки технических писателей конкретизированы и уточнены сообразно отраслевой и профессиональной специфике в Профстандарте технического писателя.
В каждой организации, где в штате есть технический писатель, обязанности его зависят от того, какие задачи стоят в ближайшей перспективе:
- составление документов, описывающих производственный процесс (пояснительные записки к проектам и чертежам, технические задания, инструкции, паспорта к готовым изделиям);
- поддержание инженерной документации в актуальном состоянии;
- редактирование технических текстов;
- описание правил, стандартов работ, алгоритмов выполнения действий;
- анализ, систематизация, группировка инженерной документации;
- оформление составленных текстов, при необходимости – верстка материала для печати;
- составление речей для докладов, презентаций сложной технической продукции;
- написание рекламных статей;
- перевод технической документации с одного языка на другой;
- ведение корпоративного сайта компании;
- описание методик работы организации;
- подготовка пособий для обучения новых сотрудников;
- участие в составлении контрактов (при необходимости);
- составление описаний и инструкций к программным продуктам;
- ведение справочных ресурсов
Технические писатели делают документацию либо на уже готовый продукт, либо на определенное решение внутри него. Проекты разные, и набор того, что и для кого задокументировать, не всегда одинаковый. Одному проекту достаточно подробной инструкции для технических специалистов, другим потребуется пакет документов и для поддержки, и для обычных пользователей.
Технические тексты считаются хорошими, если написаны точно, последовательно, но при этом кратко и понятно. В таких текстах важно, чтобы информация была структурированной, чтобы в них были списки, таблицы, схемы. Часто именно небольшой список помогает пользователю быстрее, чем длинное описание на двадцати страницах. В технических текстах обычно много иллюстраций, скриншотов интерфейсов, видео. Это нужно, чтобы человек сравнил картинку на инструкции с тем, что видит на мониторе, понял, что действует правильно, и настроил систему по шагам на картинках
«В моей работе главное ориентироваться на конечного потребителя: как с помощью технической документации он будет решать свои задачи, какой у него уровень подготовки и насколько подробно все должно быть заложено в инструкции. К примеру, я сейчас работаю над частью внутренней информационной системой, которой будут пользоваться технические специалисты. Поэтому основные требования – подробная и длинная инструкция с множеством скриншотов и примеров, которые позволят пользователю решить разные задачи. А в другом проекте я пишу небольшую часть документации по функциональности продукта для обычных пользователей. Здесь тексты простые, информативные и доступные.
Моя основная задача – сделать так, чтобы и системный администратор, и обычный пользователь нашли в инструкции то что ищут и этот поиск не занял много ресурсов».
Павел, технический писатель Службы технического заказчика ФОИВ
Источники информации для технического писателя.
Приступая к написанию любой инструкции, технический писатель анализирует многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Самый главный источник — это технический проект (ТП), которые пишут бизнес-аналитики ещё до начала разработки. Технический проект — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание (ТО), которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии (тест-кейсы). Этот источник незаменим для написания руководств по настройке.
Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация.
Процесс работы технического писателя.
Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать.
Вот как строится процесс работы:
- Определение главных задач документации и ее аудиторию.
- Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик.
- Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров.
- Поиск и подготовка иллюстрации к тексту.
- Наполнение документа текстами и отправка его на проверку экспертам.
- Внесение правок от разработчиков и экспертов.
- Презентация документации заказчику.
- Передача документации команде.
Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено.
«Есть очень тонкий момент в работе технического писателя с заказчиком: договориться о том, что именно может править заказчик. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться».
Елена, технический директор IT-компании
Что должен знать и уметь технический писатель.
Профессии технического писателя в российских вузах не учат. Есть курсы, где можно научиться писать технические тексты, но их немного. Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других.
Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений. В отличие от копирайтинга, здесь меньше творчества и больше регламентов.
Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли.
Технический писатель должен сочетать в себе свойства технаря и гуманитария. Интерес к технике и программированию, усидчивость и внимательность должны в нём сочетаться с желанием осваивать новое и делиться своими знаниями.
Из основных требований к знаниям и навыкам технического писателя можно выделить:
- умение составить понятный, грамотный, подробный, логичный технический текст;
- понимание процесса документирования и его взаимосвязи с другими процессами;
- знание инструментов для разработки электронных справок (Microsoft HTML Help Workshop, Help&Manual, RoboHELP);
- знание технологий и средств для автоматизации документирования (AuthorIT, DocBook/XML, DITA, SiberSafe);
- знание языков разметки (HTML, XML и его приложения) и навыки работы с ними;
- знание языков программирования, позволяющих автоматизировать разработку технической документации (VBA, XSLT);
- представление о методологии и языках моделирования (IDEF0, DFD-диаграммы, ER-диаграммы, UML).
Очень важно знать предметную область, в которой ведется работа. Например, если вакансия открыта в ИТ-компании, потребуется знать языки программирования и разбираться в процессах разработки софта.
Большинство организаций, в том числе ГосIT предъявляют жесткие требования по знанию нормативных документов и требования, в частности, ГОСТ ( ГОСТ 5, ГОСТ 19 и ГОСТ 34). Для международных компаний необходимо знание ISO, IEEE
Знание специализированного ПО для разработки документации очень важно. Список ПО зависит от отрасли, в которой трудится специалист. Нужно уметь работать в команде, общаться с разработчиками и понимать пользователей, которые будут использовать продукт.
На некоторых проектах техническим писателям требуется знание специфических программ: AutoCAD, Visio, Corel Draw, Confluence, Jira, UML, SysML, IDEF. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями.
В некоторых IT-компаниях требуется, чтобы технический писатель знал языки разметки текста или один из языков программирования на уровне чтения кода, другим важны навыки работы с базами данных или в системах управления запросами. То, что пригодится точно – интерес к той сфере, о которой технический писатель работает.
Некоторые работодатели требуют, чтобы образование у технического писателя было техническим. Другим нужно просто высшее образование. Еще одно требование – знание иностранного языка, потому лингвисты, филологи, переводчики тоже востребованы. Хорошо пишут тексты и коммуникабельны, как правило, выпускники гуманитарных направлений: литераторы, журналисты. Если человеку с таким образованием понравится разбираться в новой для себя области, то, скорее всего, ему подойдет эта профессия.
Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа технического писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации.
Кому нужен технический писатель.
«Зачем мне технический писатель, если есть разработчик продукта, который запросто сможет создать документацию к нему?» – такой вопрос часто задают себе руководители компаний по разработке программного обеспечения. Если проект небольшой, то возможно, технический писатель совсем не нужно. Но есть огромные преимущества, когда в проекте есть технический писатель.
– Более четкие коммуникации.
Технические писатели четким языком излагаю информацию. Большинство технических специалистов являются экспертами в своей области, они формируют описание продукта для равной себе аудитории. Для конечных же пользователей нужны совершенно другие инструкции. Технические писатели по своей сути являются переводчиками с языка разработчиков на простой язык, который требуется пользователям продукта. Особенно важно сочетание слов и графики – именно такой формат позволяет создать инструкцию, понятную всем участникам проекта. Кроме того, технические писатели смогут оказать помощь в изменении пользовательского интерфейса продукта, что позволит снизить потребность в документации. Документация хорошего качества положительно влияет на продукт.
– Снижены затраты на техническую поддержку.
Грамотные и понятные инструкции уменьшают количество обращений в отдел технической поддержки: Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию. Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле. В это время они часто обнаруживают баги или проблемы с удобством использования. Устранив эти проблемы до релиза продукта, можно быть уверенным, что пользователи никогда не столкнутся с ними. К тому же, технические писатели часто формируют более целостный взгляд на продукт, чем может получиться у разработчиков, которые должны сосредотачиваться каждый на своей небольшой части продукта. Технические писатели накапливают полезный опыт, работая с пользовательскими интерфейсами – это то, что большинство разработчиков никогда формально не изучали. Предлагая рационализированный, более эффективный вариант интерфейса, технический писатель освобождает время разработчиков, которое они смогут потратить на более трудоёмкие задачи по созданию корректно работающего кода.
– Сниженные затраты на документацию.
Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя – писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно – он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты.
«Если у вас есть продукт, которым пользуется кто-то снаружи — значит пора искать технического писателя. Даже если «этот снаружи» сидит в соседней команде. Любое погружение посторонних в проект или продукт уже подразумевает документацию, а, следовательно, и позицию технического писателя.
Но у меня в практике был проект, когда документации нет и это не создаёт никаких реальных проблем. Вот тогда и писатель не нужен. Или к примеру, у меня в команде был такой разработчик, что он прекрасно пишет документацию и ему проще сделать это самому – вот такое у него хобби)»
Максим, директор департамента разработки ИТ-компании
Какую карьеру может построить технический писатель?
Технический писатель может выбрать для себя разные пути развития. Очень многое зависит от проекта, над которым работает технический писатель.
Если брать сферу IT, ближе всего к техническому писателю профессия бизнес-аналитика. Там требуются схожие качества: внимание к деталям, аналитический склад ума, стремление разложить все по полочкам. Из технического писателя получаются прекрасные специалисты по тестированию. Технический писатель может стать менеджером проектов, попробовать себя в тестировании. Если человек писал много документации о программах на Java, заинтересовался и решил изучить этот язык программирования, он может стать разработчиком.
Некоторые технические писатели уходят в сферу маркетинга или продаж, особенное если это направление по продвижению IT-продуктов: умение структурировать информацию и наглядно представлять её помогает готовить презентации для потенциальных клиентов, а умение понимать нужды клиента или пользователя, предугадывать его вопросы, незаменимо в этой области.
Многие технические писатели предпочитают работать на различных проектах: являясь фрилансерами, они вольны выбирать для себя наиболее интересные проекты, совершенствуя свои навыки в разных направлениях. Развиваясь, они становятся незаменимыми специалистами на биржах по поиску специалистов. Это интересно как самому техническому писателю, так и работодателю: специалист задействован на определенные задачи и трудовых отношений часто не возникает.
«Свой карьерный путь я начала с журналистики, по образованию филолог. Я всегда мечтала путешествовать, поэтому очень много время уделяла изучению иностранных языков. Журналистика не пошла, хотя очень нравилось писать технические тексты. Знакомые предложили попробовать себя в IT – необходимо было разобраться с высокотехнологичным продуктом в помощь основному техническому писателю. Вот с этого началось мое погружение в IT. Несколько лет я работала в компании, пока наконец не поняла, что хотела бы совмещать мою любовь к путешествиям и любимую работу. Сейчас я фрилансер, заказы есть всегда, иногда даже привлекаю молодых специалистов к решению задач».
Марина, технический писатель-фрилансер
Заработная плата технических писателей.
На июль 2021 года на известном ресурсе по поиску работы были найдены 335 вакансии по Москве и Московской области. С примером описания вакансии можно ознакомиться здесь.
Средний размер заработной платы: от 100 000 до 150 000 рублей.
Если технический писатель принял решение работать как фрилансер, то ежемесячный уровень дохода примерно 150 000 – 200 000 рублей при наличии опыта от 3х лет.
Первые заработки начинающих технических писателей начинаются от 5 000 – 10 000 рублей за проект.
Заключение:
В России профессия технический писатель является востребованной в основном на крупных проектах. Благодаря этим специалистам упрощается процесс коммуникаций и снижаются затраты на документацию и техническую поддержку.
В ВУЗах России такой профессии не обучают и в нее можно попасть как имея техническое так и другое образование. Необходимо обладать определенным набором soft skills и активно совершенствовать профессиональные навыки.
Спрос на технических писателей неуклонно растет и многократно превышает предложение: раньше технических писателей не было вообще, а теперь они нужны почти каждой IT-компании.
Наталья Карташева,
Эксперт центра
Технический писатель – кто ты?
Время на прочтение
6 мин
Количество просмотров 13K
Написать данный материал меня побудила статья «Нам он и нафиг не нужон, технический писатель ваш!» (с) или для чего он вам всё-таки нужен» (далее – Статья) и он является отчасти ответом на некоторые мысли, озвученные в ней, а также содержит информацию о моем видении работы технического писателя (далее – ТП). Поэтому также приглашаю автора Статьи @champ_7777777к прочтению.
Сначала я хотел написать комментарий к Статье, но передумал. Во-первых, он был бы очень длинный. Во-вторых, возможное обсуждение сделало бы многие мысли обрывистыми и разрозненными. И еще я люблю марать бумагу писать.
Не претендую на единственно верный подход к вопросу о том, кто такой ТП, а также на полноту освещения данного вида деятельности. Наверняка есть отдельные области, где изложенное ниже малоприменимо. В тоже время уверен, что для многих описанное является в значительной степени точным, и конечно надеюсь будет полезно.
Более 10 лет занимаюсь написанием всего и вся, а примеряться к этой деятельности стал намного раньше, еще во время учебы в университете. Львиная доля материалов относится к техническим и около техническим текстам, хотя грань между ними весьма размытая. Степень «техничности» текстов зависит от пожеланий заказчиков и конечно моей погруженности в тематику. Берусь только за задачи, где обладаю компетенциями или могу разобраться и выполнить работу в срок. Последние 5 лет занят в проектировании систем информационной безопасности. В своей работе большую часть времени занимаюсь тем, что собираю информацию, обрабатываю ее и разбираюсь, что написать и меньшую часть непосредственно пишу. Пожалуй, в этом главное отличие профессии ТП от других, связанных с написанием чего-либо – технический писатель – это больше про «технический», чем про «писатель». Это же является и критерием того, как понять, ТП или не ТП:).
Зачем нужен ТП?
В Статье сказано:
Разные компании до сих пор не очень осознают, что это вообще за человек. Многие даже по-разному называют: копирайтер, автор статей, специалист по документообороту.
Компания в целом как раз очень хорошо понимает, для решения каких задач именно им нужен ТП. На разных уровнях по-разному, но понимают.
Простой пример. Компания разрабатывает оборудование. Директор хочет, чтобы к нему было разработано руководство. При этом его представление о разрабатываемом оборудовании несколько общее, на уровне основных решаемых задач и важных функций. Директор ставит задачу сотруднику, который понимает, какие основные и вспомогательные функции должны быть описаны в руководстве, чтобы его смогли успешно применять и поменьше беспокоили разработчика. Данный сотрудник ставит задачу ТП, предоставляет данные, необходимые для разработки руководства и консультирует его. ТП разбирается и определяет, как это должно выглядеть на бумаге. С учетом определенных правил (ГОСТы и здравый смысл) все в его власти.
В Статье сказано:
К сожалению, важность технического писателя осознается только когда компания набила кучу шишек, давая писать документацию аналитикам или разработчикам, менеджерам/рп, административному отделу. В итоге клиент скажет, что ничего не понимает и перейдёт к вашему конкуренту.
Видел качественные руководства, написанные заместителем директора. Понятно, что целесообразность таких маневров быстро пропадает. В целом привлечение к написанию технических текстов непрофильных действующих сотрудников или ввод в штат отдельной должности ТП вопрос ситуативный.
Основная проблема
Основная проблема в том, что те, кто в идеале должен писать технические тексты не делают этого. Руководство к устройству должны писать разработчики или те, кто его непосредственно эксплуатирует и понимает, как оно работает. По разным причинам на практике они этого почти никогда не делают.
Видел, как люди, досконально знающие свою работу и готовые в режиме диалога объяснить и показать работу устройства теряются при попытке переложить все это из головы на бумагу. А еще могут послать с такими запросами, потому что у них нет на это времени. Помимо самого написания требуется придерживаться правил, о чем разработчики могут не иметь представления, а пытаться их этому научить нерационально.
Конечно, можно предложить вариант, что один сотрудник подготовит текст, а другой выполнит оформление. Но человек, занимающийся оформлением и не понимающий того, о чем написано легко может наделать ошибок. Итоговый смысл текста будет совсем не тем, что нужно. Даже если использовать такой подход и отправлять после оформления текст на проверку тому, кто его написал, получается опять же не рационально, а если говорить совсем прямо – дорого. В конечном итоге наиболее оптимальным является вариант, когда человек объясняет и показывает работу устройства ТП, а он разрабатывает документацию.
Тренировать удары
В Статье сказано:
«Однако, тут нужно любить «тренировать 10 тысяч раз один удар, а не 10 тысяч различных ударов», как говорил Брюс Ли. Полировать, оттачивать себя. Тогда придёт профессиональный успех.».
Про это хочется сказать отдельно. Для ТП важно и то и другое. Тренировать 10 тысяч раз один удар, чтобы постоянно совершенствовать уже написанную документацию (простор здесь бесконечен). Тренировать 10 тысяч различных ударов, чтобы описать то, с чем еще не сталкивался. И то и другое во многом ведет к росту заработной платы ТП. Впрочем, оба эти аспекта актуальны для большинства профессий.
Ищу тебя
Здесь скажу про поиск ТП, чего автор Статьи коснулся в разделе «Основная боль».
С одной стороны, все просто. Нужно взять человека, понимающего в достаточной степени определенный стек технологий, связанный с тем, что ему нужно будет описывать в документации, а также имеющего опыт написания технических текстов. Если такого нет или зарплатный бюджет ограничен, нужно выбрать наиболее оптимальный вариант в части необходимых знаний и опыта.
С другой стороны, могут быть сложности. Можно сознательно взять человека, не обладающего в полной мере необходимыми знаниями, с расчетом, что он их освоит самостоятельно или пройдя обучение. В случае с ТП вероятность, что это не сработает несколько выше. Человек, знающий нужные технологии, но не имеющий опыта разработки документации, может оказаться не совсем расположен к такой работе и ему понадобится время, чтобы начать писать на достаточно качественном уровне. В каком-то смысле лотерея. В итоге придется расстаться с ним или подождать.
Оформление
Из рассмотрено в Статье примера (раздел «Драма и проблематика») коснусь кириллицы в англицизмах.
В Статье сказано:
«Биг дата» — большая натяжка, «жира, гугл почта, иксолла» — совсем не то. Вы спросите, а как понять, как можно, а как нельзя? Честно, я и сам уже многие годы задаюсь вопросом, почему «USB» мы пишем так, а не «ЮСБ», а «СМС» допускается писать кириллицей.
Самый простой способ избежать ошибки – гуглить на предмет используемости.
Можно также использовать Reverso Context или Microsoft Language Portal — здесь можно найти перевод терминов в контексте. Как на русском, так и на английском. Просто можно брать самый употребляемый вариант того или иного термина.
В соответствии с ГОСТ 34.602-2020 техническое задание содержит раздел «Требования к документированию». Хорошим тоном считается указать в нем хотя бы минимальные требования к документации. Они в том числе включают то, что документация разрабатывается на русском языке. Допускается использованием в тексте общепринятых названий технологий, продуктов иностранного производства и т.п. на английском языке. Даже если у вас нет ТЗ по данному ГОСТу или его нет вообще настоятельно рекомендую придерживаться данного правила.
Только «USB» и не смотря на широко распространенное «СМС» – только «SMS». Позволю себе побыть занудой в данном случае. Из Википедии: SMS (сокр. от англ. Short Message Service – «служба коротких сообщений») – технология приёма и передачи коротких текстовых сообщений с помощью сотового телефона. Поэтому «SMS» в технических текстах не должно применяться в качестве синонима этих самых «коротких сообщений» (рука-лицо). Считаю допустимым: «SMS-сообщение». При этом изначально нужно ввести данное понятие, например, так: двухфакторная аутентификация осуществляется посредством ввода имени пользователя и пароля условно постоянного действия с последующим вводом одноразового кода, направляемого пользователю с использованием технологии приема и передачи коротких текстовых сообщений (далее – SMS-сообщения) на телефонный номер, указанный при регистрации. Кроме того, даже не смотря ввод понятия в тексте, оно вносится в список определений. После этого можно смело применять данное определение.
В целом про оформление скажу, что вопрос весьма болезненный. Кровь из глаз, при виде документа с оформлением «кто в лес, кто по дрова», в виде разношерстных шрифтов, отсутствием адекватной структуры и т.п.
Как вам каждый абзац в виде заголовка в 200-страничном документе? И такое бывает. Я не придираюсь и все это вполне допустимо, если человек занимается документами время от времени. Но если вы связали свою профессиональную деятельность с разработкой документов, то изучить основы форматирования просто необходимо. Это не займет много времени. Это также важно, как и само содержание ваших текстов. К тому же значительно упростит жизнь в первую очередь вам.
Заключение
Не затронул некоторые вещи, озвученные в Статье. Одни не связаны с работой ТП или слишком очевидны. Другие потянут на целую статью. Например, вопрос особенностей и перспектив развития ТП – возможно как-нибудь напишу о том, чем я занимаюсь помимо непосредственной разработки документации, как к этому пришел, а также что нужно знать ТП и какие навыки прокачивать, чтобы получить возможность выйти за рамки разработки документации.