Что делает технический писатель в 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) — это специалист, который преобразует сложные и технически трудные письменные материалы в четкую и лаконичную документацию, которую будет читать целевая аудитория. Они собирают и разрабатывают техническую информацию для создания инструкций по обслуживанию и эксплуатации, технических и инструктивных руководств, журнальных статей и другой документации для производителей, проектировщиков и клиентов. Технические писатели также могут писать техническое задание (ТЗ).

Что делают технические писатели и чем занимаются?

Обязанности на примере одной из вакансий:

разработка технической эксплуатационной документации и конструкторской документации на существующую и новую продукцию компании (ТУ, ТО, руководства по эксплуатации, паспорта, формуляры, чертежи, схемы и пр.);
подготовка документации в соответствии с требованиями ЕСКД, проверка КД на соответствие требованиям ЕСКД;
анализ требований проекта, требований ТЗ;
разработка/доработка ТЗ;
согласование технических решений с представителями разных подразделений компании, с заказчиком.

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

Требования к техническим писателям:

Собирать требования к задаче
Декомпозировать задачи
Проводить интервью с техническими специалистами
Передавать работу на вычитку и работать с правками
Планировать работу над задачей в 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-компании 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 статей в базе знаний Центра Разработки.

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

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Сайт www.techwriters.ru,
Сайт https://protext.su/,
Книга «Профессия: технический писатель»,
Книга «Разработка технической документации. Руководство для технических писателей и локализаторов ПО»,
Книга «Документирование сложных программных средств»,
Книга «Разработка документации пользователя программного продукта (методика и стиль изложения)»,
Microsoft Writing Style Guide.

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

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

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

Источник

Статья размещена на сайте Мили Котляровой — фрилансера с 10-летним стажем, монтажера, контент-маркетолога и сценаристки. Если хотите каждый день читать о фрилансе, работе с заказчиками и освоении новой профессии, подписывайтесь на канал Digital Broccoli в Телеграме.

Упоминающиеся в тексте Instagram и Facebook признаны на территории РФ экстремистскими.

Текст Нины Ереминой

Всё больше компаний ищут специалистов на позицию технического писателя: на момент публикации на Хабре 167 вакансий по запросу «технический писатель», а на Upwork — 708. И, по версии Бюро статистики труда США, заинтересованность в профессии будет только расти, потому что на рынке постоянно появляются новые продукты. В среднем технический писатель зарабатывает 91 тысячу рублей.

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

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

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

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

Создание документации

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

Виды документации:

Пользовательская документация

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

Administrator Guide

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

Developer Guide

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

Whitepapers

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

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

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

Техническая коммуникация

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

Например, если в пользовательской документации вы называете админку Admin dashboard, то она не должна внезапно стать Admin panel в одной из статей. Чтобы сохранить единство терминологии и стандартов, технический писатель разрабатывает внутреннюю базу знаний, где всё это прописано, и может обучать новых сотрудников компании.

Смежные области

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

Ещё можно приобрести экспертизу в смежных областях, например, можно стать:

UX-писателем — он помогает улучшить тексты в интерфейсе продукта или приложения;
инженером по документированию (DocOps) — он поддерживает процессы автоматизации документации и переводов;
инженером по локализации — он занимается техническим переводом;
техническим евангелистом (специалистом по Developer Relations) — он скорее технический маркетолог, и продвигает технические решения среди коллег или на рынке. Главное отличие евангелиста от маркетолога — знание всех технических аспектов продукта, и чаще всего технический бэкграунд.

Что нужно знать? Инструменты технического писателя

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

Язык

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

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

Копирайтерские навыки

Вам пригодятся навыки определения целевой аудитории и написания текстов с учётом особенностей ЦА, понимание пользы и болей читателя.

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

Технические знания

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

Профессиональные текстовые редакторы

Инструменты, которыми пользуется технический писатель, зависят от задач и степени сложности. Начинать писать документацию можно и в Google Docs, но с увеличением количества связей и уровней будет сложно её поддерживать. Тогда на помощь приходят профессиональные редакторы для технических писателей: MadCap Flare или Confluence.

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

Руководства по стилю

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

Примеры руководств:

Microsoft Manual of Style
The Guardian and Observer Style Guide
Apple Style Guide
Google Developer Documentation Style Guide

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

Александр Петрович, руководитель отдела технической документации из Macroscop, советует досконально изучать интересующую область:

«Я считаю, что стартовать надо в той области знаний, в которой вы компетентны. Либо прокачать свои знания в той сфере, с которой вы планируете начать свой путь техписателя. Для работы в IT, например, я настоятельно рекомендую освоить как минимум HTML и CSS, а оптимально — ещё и основы JavaScript и распространённых веб-фреймворков.

Без владения современными инструментами подготовки визуального контента тоже не обойтись. Я имею в виду редакторы векторной и растровой графики, средства подготовки веб-анимации и другие подобные инструменты. А с учётом того, что мир стремительно “скатывается” из текста к видео, не исключено, что скоро от техрайтеров потребуются навыки видеосъёмки, монтажа, а возможно и актёрское мастерство».

Как сделать портфолио?

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

Включайте только документы, которые имеют отношение к техническому письму.
На ClickHelp рекомендуют найти что-то близкое из того, что вы уже писали. Главное, чтобы это был формальный текст с чёткой структурой, например, отчёт.
На Reddit делятся информацией о заданиях для техрайтеров, из которых можно собрать портфолио, даже если реальных задач ещё не было. Встречаются любопытные задания, например, переписать инструкцию по сборке мебели из IKEA словами.
Возьмите инструкцию к сервису и попробуйте её улучшить.
Примите участие в ежегодном Season of Docs от Google, где технические писатели создают документацию для реальных проектов.
Поищите опенсорсные проекты на GitHub и предложите им написать документацию для пользователей. Это поможет вам поработать над реальной задачей, получить отзывы, и повысит шансы на отбор в Season of Docs.

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

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

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

Где учиться?

Курсы

Бесплатный курс на Stepik начинается с теста на уровень английского, который состоит из четырех частей. Он проверяет грамматику и словарь и опирается в оценке на Кэмбриджскую систему оценки знаний. В нем освещаются темы грамматики, выбора слов, которые соответствуют стилю, и пунктуации. В конце курса вы сможете пройти тест. Курс не расскажет, как работать техрайтером, но поможет снять стресс насчет языка.
Курс по API документации на Udemy преподаёт Питер Грюнбаум (Peter Gruenbaum), разработчик, который стал техническим писателем и специализируется на API документации. Стоимость курса $24.99, но на Udemy часто бывают скидки.
Курс Technical Writing: Documentation on Software Projects создан для разработчиков, но его можно проходить тем, кто собирается заниматься только письмом. Автор курса детально разбирает процесс создания технических документов, даёт советы, как писать и оформлять документацию для разработчиков, тестировщиков и конечного пользователя. Платформа платная, но деньги списываются через 2 недели, за которые можно пройти курс.
TCTrain Professional Course полноценный курс от организации TeKom на 8 месяцев. С сертификатом и нагрузкой на 7 часов в день. Цена на сайте не указана.
Бесплатный курс от Google, который предназначен для разработчиков, но вполне подойдёт для того, чтобы познакомиться с тем, как писать понятную техническую документацию, как её правильно форматировать и использовать язык разметки.
Курсы для тех, кому сначала хочется освоиться с технической частью. Легендарный курс CS50 по основам программирования поможет понимать, о чём говорят коллеги, и увереннее чувствовать себя в технических темах. На Coursera есть курс Google IT support, который поможет разобраться, как устроена техподдержка.

Каналы и блоги

Ютуб-канал documentat.io расскажет про основные инструменты и стандарты. На нем собраны видео с бесплатного курса, который периодически повторяется.
Интервью Как стать техническим писателем.
Тред /technicalwriting на Reddit помимо вопросов об инструментах или карьерном выборе содержит возможности для волонтёрства.
Телеграм-канал Technical Writing 101 публикует много полезностей, а ещё заходят HR с вакансиями, где можно посмотреть, какие тестовые задания просят сделать, и выполнить самому.
Телеграм-канал Techwriter’s Daily собирает статьи, анонсы мероприятий, курсов и вебинаров.
Телеграм-канал Shut up and write с советами, новостями, удачными примерами технической коммуникации, исследованиями. Например, вот подборка сайтов, где можно найти себе ментора.
Телеграм-канал DocOps с информацией про инструменты, техники и мероприятия. У канала также есть чат, где можно спросить совета и пообщаться с другими техрайтерами.
YouTube-канал технической писательницы Amruta Ranade, с отдельным плейлистом для начинающих техрайтеров.
Блог I’d rather be writing, в котором Том Джонсон, техрайтер из Сиэтла, пишет про API-документацию, техническую коммуникацию и тренды.
Блог ClickHelp про техническое письмо. Здесь вы найдёте советы, объявления о конференциях и авторские колонки.
Канал Write the Docs в Slack, где можно спросить совета, познакомиться с другими техрайтерами, узнать про отраслевые мероприятия или найти первую работу, там добавляют и вакансии.
На DocToolHub собрано 600+ статей на темы от построения карьеры до написания API документации.
Подкаст Cherryleaf часть блога про техническую коммуникацию, есть выпуски с отзывами на курсы и описанием трендов.

Книги

Technical Writing 101 написана простым языком и отвечает на вопросы про технические ресурсы, проблемы при создании документации и особенности планирования документации на проекте. Ещё в ней есть детальные описания процесса документации, от планирования и ресёрча до публикации.
Handbook of Technical Writing была написана еще в 2003, и это её десятое переиздание. Конечно, IT-индустрия меняется гораздо быстрее, но в книге есть всё еще актуальные примеры документации, принципы организации и форматирования документов, и много информации о техническом языке.
Пиши, сокращай поможет с пользой для читателя и заботливыми формулировками.
Tech Writing Handbook — коротенькая книжка с совсем основами, но очень дружелюбная, и ответит на основные вопросы в самом начале пути технического писателя.
Technical Writing Course Manual — неплохое собрание теории, разве что часть про MSWord устарела.

Что можно сделать прямо сейчас?

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

Источник