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

Обучение
Содержание

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

Технический писатель (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+ лучших курсов для обучения технического писателя: подробный обзор

Стоимость: 28 000 ₽ или рассрочка на 12 месяцев – 2 333 ₽ / мес
  • Программа из 3 курсов
  • Упор на практику напишете 3 работы
  • Разбор кейсов
  • Бонусный курс по системе контроля версий Git.

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

Кому подойдёт этот курс:

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

Чему вы научитесь:

  1. Планировать рабочий процесс
    Будете оценивать, сколько времени требуется для работы над документацией в различных жанрах. Организуете рабочий процесс в Trello.
  2. Пользоваться инструментами
    Познакомитесь с важными для писателя функциями Microsoft Word, освоите OneDrive, Google Документы, языки разметки. Получите технические навыки: познакомитесь с HTML, CSS и git.
  3. Работать с фактурой
    Узнаете, как подготовиться к интервью с техническими специалистами, правильно задавать вопросы и вести конспекты. Научитесь собирать информацию из чертежей, таблиц, графиков.
  4. Писать грамотные тексты
    Познакомитесь с правилами стилистики, типографики и будете структурировать текст так, чтобы неподготовленный читатель всё понял. Облегчите общение между разработчиками ПО и нетехническими специалистами в компании.
  5. Разрабатывать и адаптировать документацию
    Будете создавать технические задания, паспорта, технические условия, руководства по эксплуатации и онлайн-справки. Оформлять проекты по стандартам ГОСТ, ISO, IEC и IEEE.
  6. Презентовать себя как специалиста
    Добавите в портфолио работы, которые сделаете на курсе. Сможете доказать свою ценность и полезность работодателю.

Программа

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

Основные курсы

  1. Технический писатель. Базовый уровень
  • Введение в профессию.
  • Типовой сценарий работы технического писателя.
  • Microsoft Word и другие инструменты написания.
  • Работа с техническим текстом.
  • Зарубежные и отечественные стандарты.
  • Создание документа: техническое задание (ТЗ).
  • Создание документа: паспорт (ПС).
  • Создание документа: технические условия (ТУ).
  • Создание документа: руководство по эксплуатации (РЭ).
  • Создание онлайн-справки.
  • Управление знаниями.
  • Как получить работу технического писателя.
  1. Технический писатель-дизайнер
  • Введение.
  • Базовый HTML.
  • Базовый CSS. Часть 1.
  • Базовый CSS. Часть 2.
  • Подготовка к верстке.
  • HTML-разметка.
  • Flexbox.
  • Стилизация.
  1. Технический писатель PRO
  • Освоение инструментов визуализации.
  • Освоение технологий и средств для автоматизации документирования.
  • Technical documentation.
  1. Дипломные проекты
  • Руководство по эксплуатации

Дополнительные курсы

  1. Система контроля версий Git
  • Версии программного кода.
  • Установка Git.
  • Индекс и частичные коммиты.
  • Сравнение версий.
  • Отмена изменений и откат версий.
  • Репозитории и коллективная работа.
  • Ветки — создание и управление.
  • Слияние и разрешение конфликтов.
  • Полезные инструменты.
  • Правила работы с Git.

Дипломные проекты

  1. Руководство по эксплуатации
  • Оформите документ по ГОСТу с применением оглавления, стилей, сквозной автонумерации, перекрёстных ссылок.

Диплом Skillbox

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

Цели семинара/курса:

  • Получить знания методик и приемов подготовки технической документации;
  • Применять существующие стандарты документирования;
  • Использовать программные инструменты для технических писателей;
  • Грамотно вести переговоры с техническими специалистами;
  • Разрабатывать различные виды технических документов.

Профессиональный стандарт «Технический писатель»: содержание и требования:

  1. Техническая документация и технический писатель: основные термины и понятия. Введение в проблему.
  • Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика.
  • Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
  • Навыки и умения технического писателя.
  • Задачи технического писателя. Группы читателей.
  • Варианты занятости и сферы деятельности технического писателя.
  1. Единые стандарты документирования.
  • Отечественные и зарубежные стандарты.
  • Классификация ГОСТов.
  • Зарубежные стандарты ИСО в области системной и программной инженерии.
  • Назначение стандартов.
  • ГОСТ 7.32-2001.
  • Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
  • Система стандартов ГОСТ 19 и ГОСТ 34.
  • Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД).
  • Система стандартов по информации, библиотечному и издательскому делу (СИБИД).
  • Единая система конструкторской документации (ЕСКД).
  • Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов.
  • Управление документированной информацией в контексте требований МС ISO 9001:2015.
  1. Виды и стили технических текстов.
  • Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия.
  • Стили технической документации.
  1. Средства и методы создания технических текстов.
  • Блок целеполагания: цель, задачи, методы и средства.
  • Определение аудитории и уровня разъяснения материала.
  • Об описании БД, кодов. Создание руководств пользователя.
  • ПРАКТИКА: Корректировка имеющихся текстов: основы редактирования и корректуры.
  • Приёмы работы с техническими текстами.
  • Терминология в технической документации: правила применения единых терминов.
  • Визуализация и графическое сопровождение технических документов.
  • Работа над ошибками и лексические тонкости в технических документах.
  1. Создание векторных изображений и контроль ошибок в объемных документах.
  • Векторные изображения в документе.
  • Иллюстрации в MS Word.
  • Фотография и векторная иллюстрация в документах.
  • Методика отрисовки векторной графики в PowerPoint.
  • Специальная вставка изображений в MS Word.
  • Контроль ошибок в объемных документах.
  • Базовые процессы по контролю документации.
  • Версионирование. Системы баг-трекинга ПО — помощники технического писателя.
  • Организация контроля за ошибками и доработками в документах.
  1. Процесс перевода технической документации (на примере английского языка).
  • Сложности перевода на другой язык, основные подводные камни.
  • Грамматика и лексика в техническом переводе.
  • Правила и способы перевода технических текстов.
  • Применяемое программное обеспечение и приёмы его корректного использования.
  • Понятие локализации в технических переводах.
  • Практика: Перевод и редактирование технического текста.
  1. Программное обеспечение в работе технического писателя.
  • Базовые форматы документации: HTML, DOC(X), CHM, PDF.
  • HTML Help Workshop.
  • Средства MS Office.
  • Средства Adobe.
  • Платформа DocBook/XML.
  • Wiki-системы.
  • Облачные технологии (Google Docs, Evernote, Dropbox и др.).
  • Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin.

Цель курса:

  • Получить знания методик и приемов подготовки технической документации;
  • Применять существующие стандарты документирования;
  • Использовать программные инструменты для технических писателей;
  • Грамотно вести переговоры с техническими специалистами;
  • Разрабатывать различные виды технических документов.

Программа курса:

Техническая документация и технический писатель: основные термины и понятия. Введение в проблему.

  1. Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика.
  2. Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
  3. Навыки и умения технического писателя.
  4. Задачи технического писателя. Группы читателей.
  5. Варианты занятости и сферы деятельности технического писателя.

Единые стандарты документирования.

  1. Отечественные и зарубежные стандарты.
  2. Классификация ГОСТов.
  3. Зарубежные стандарты ИСО в области системной и программной инженерии.
  4. Назначение стандартов.
  5. ГОСТ 7.32-2001.
  6. Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
  7. Система стандартов ГОСТ 19 и ГОСТ 34.
  8. Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД).
  9. Система стандартов по информации, библиотечному и издательскому делу (СИБИД).
  10. Единая система конструкторской документации (ЕСКД).
  11. Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов.
  12. Управление документированной информацией в контексте требований МС ISO 9001:2015.

Виды и стили технических текстов.

  1. Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия.
  2. Стили технической документации.

Средства и методы создания технических текстов.

  1. Блок целеполагания: цель, задачи, методы и средства.
  2. Определение аудитории и уровня разъяснения материала.
  3. Об описании БД, кодов. Создание руководств пользователя.
  4. ПРАКТИКА: Корректировка имеющихся текстов: основы редактирования и корректуры.

Приёмы работы с техническими текстами.

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

Создание векторных изображений и контроль ошибок в объемных документах.

  1. Векторные изображения в документе.
  2. Иллюстрации в MS Word.
  3. Фотография и векторная иллюстрация в документах.
  4. Методика отрисовки векторной графики в PowerPoint.
  5. Специальная вставка изображений в MS Word.
  6. Контроль ошибок в объемных документах.
  7. Базовые процессы по контролю документации.
  8. Версионирование. Системы баг-трекинга ПО — помощники технического писателя.
  9. Организация контроля за ошибками и доработками в документах.

Процесс перевода технической документации (на примере английского языка).

  1. Сложности перевода на другой язык, основные подводные камни.
  2. Грамматика и лексика в техническом переводе.
  3. Правила и способы перевода технических текстов.
  4. Применяемое программное обеспечение и приёмы его корректного использования.
  5. Понятие локализации в технических переводах.
  6. Практика: Перевод и редактирование технического текста.

Программное обеспечение в работе технического писателя.

  1. Базовые форматы документации: HTML, DOC(X), CHM, PDF.
  2. HTML Help Workshop.
  3. Средства MS Office.
  4. Средства Adobe.
  5. Платформа DocBook/XML.
  6. Wiki-системы.
  7. Облачные технологии (Google Docs, Evernote, Dropbox и др.).
  8. Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin.

Для кого:

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

Программа:

  1. Профессиональный стандарт «Технический писатель»: содержание и требования.
  2. Единые стандарты документирования.
    Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам. Система стандартов. Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов. Управление документированной информацией в контексте требований МС ISO 9001:2015. Мастер-класс: «Сложности написания руководства пользователя по ГОСТ 34».
  3. Методы и приемы работы с техническими текстами.
    Методы аналитико-синтетической переработки, используемые в техническом писательстве. Этапы создания технического текста. Изучение целевой аудитории: метод сценариев. Создание плана технического текста: интеллектуальное картирование, определение структуры текста. Техническое аннотирование и реферирование. Оформление цитирования. Читабельный текст: функциональность стиля, информативность и дизайн. Виды функциональных стилей в технической коммуникации. Терминология в технической документации. Информационный дизайн технического документа. Визуализация информации и применение инфографики в техническом документе. Особенности создания и использования деловой графики. Мастер-классы: структурирование информации при создании технической документации. Создание инфографики для визуализации научно-технической информации. Создание и оформление технического задания, отчета, руководства пользователя.
  4. Техническая коммуникация и техническое писательство.
    Особенности технического документирования. Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления. Навыки, необходимые техническому писателю. Формат и структура технического документа. Методы копирайтинга научно-технической рекламы, используемые в техническом писательстве. Принципы популяризации научно-технического текста.
  5. Промышленный подход к разработке документации.
    Разработка документации на основе принципа единого источника. Стандарт DITA. Особенности внедрения технологии DITA на предприятии, целесообразность использования XML-подобных документов. Разработка структурированного контента разных типов, смысловая разметка документов, формирование документа из карты и топиков, профилирование. Oxygen. Практическое занятие.
  6. Принципы создания технических текстов.
    Целевое назначение технической документации: определение целей обращения пользователей к техническим документам. Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов. Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации. Мастер-класс: создание научно-технического рекламного текста.
  7. Оформление текста по ГОСТ 2.105 «ЕСКД.
    Общие требования к текстовым документам». Параметры для оформления текста в электронном виде. Правила оформления таблиц.
  8. Документация, ориентированная на пользователя:
    Help и онлайн-справка. Confluence. Создание профессиональных справочных файлов. Формирование справки с помощью Robohelp.
  9. Документирование программного обеспечения, программно-аппаратных изделий.
    Предмет документирования: программный продукт, документация пользователя и ее характеристики. Документы, используемые при эксплуатации программного продукта.
  10. Создание векторных изображений и контроль ошибок в объемных документах.
    Векторные изображения в документе. Технический писатель или дизайнер? Иллюстрации в MS Word. Фотография и векторная иллюстрация в документах. Методика отрисовки векторной графики в PowerPoint. Специальная вставка изображений в MS Word. Контроль ошибок в объемных документах. Базовые процессы по контролю документации. Страхи при написании объемной документации. Версионирование. Системы баг-трекинга ПО помощники технического писателя. Организация контроля за ошибками и доработками в документах.
  11. Секреты мастерства.
    Инструменты, используемые техническими писателями. Microsoft Word — секреты мастерства для технического писателя. Шаблоны. Применение, создание и изменение стилей. Форматирование абзацев заголовка, текста, списка, таблицы. Многостраничные таблицы. Формирование оглавления. Создание многоуровневой нумерованной структуры документа. Добавление названий к объектам. Перекрестные ссылки. Специальные поля в документе. Автозаполнение типовых документов с помощью полей слияния. Автозамена и автотекст. Расширенные возможности поиска и замены. Регулярные выражения. Макетирование. Связанные надписи. Печать брошюры.
  12. Программное обеспечение в работе технического писателя.
    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-программ и автоматизированных систем. К технической документации относят: задания и инструкции для специалистов, руководства по эксплуатации для пользователей, техническое задание (ТЗ), технические условия (ТУ), технический паспорт, прочие описания продукта.

  1. Выбор темы для видео инструкции
  2. Запись видео инструкции в виде скринкаста
  3. Размещение видео инструкции на видео хостинге
  4. Отправка задания на общественную экспертизу
  5. Дополнительные ресурсы.

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

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

Для кого этот курс:

  1. для студентов с хорошим знанием английского языка (уверенный Intermediate и выше);
  2. для копирайтеров, у которых есть навыки письма на английском, но нет опыта подготовки технической документации;
  3. для специалистов, которые занимаются написанием документации и сталкиваются с проблемой лаконичного изложения, грамотного структурирования и оформления текста;
  4. для всех, кто владеет английским на уровне Intermediate и выше и планирует попробовать себя в сфере IT.

Вы узнаете

Основа курса – получение теоретических и практических навыков создания документации:

  • анализ продукта;
  • поиск конечного пользователя;
  • определение типа документов, подходящих для продукта;
  • составление плана активностей;
  • создание документов;
  • использование лексики, которая соответствует стандартам;
  • использование инструментов для создания документов.

Программа курса:

  1. Вводное занятие
  2. Работа на IT проектах
  3. Техническая документация в IT-проектах
  4. Описание пользовательского интерфейса
  5. Организация документа на микроуровне
  6. Организация документа на макроуровне
  7. Task-oriented documentation Часть 1
  8. Task-oriented documentation Часть 2
  9. Concept topic, reference topic, troubleshooting topic
  10. Визуализация информации
  11. Оформление и редактирование
  12. Инструменты управления проблемами, задачами, проектами и wiki software на примерах программ Jira и Confluence
  13. Инструменты создания пользовательской справки, статических сайтов
  14. Итоговое занятие
  15. Экзамен. Подготовка итогового проекта (2 недели)
  16. Защита итогового проекта.

Курсы для технических писателей, проводимые компанией «ПроТекст», являются первым в России полноценным образовательным проектом в области документирования. Курс разработан техническими писателями-практиками с большим стажем и одобрен Новосибирским государственным техническим университетом в 2012 году. В 2014 году курс также одобрил Белорусский государственный университет.

Цель курса: Подготовка специалистов в области разработки технической документации и аналитики в IT-сфере.

Стоимость: 16 800 ₽ – 21 100 ₽

Цель курса: Повышение квалификации специалистов в области разработки технической документации и аналитики в IT-сфере.

Темы курса:

  1. Введение в специальность
  2. Как стать техническим писателем
  3. Юридические и территориальные аспекты работы
  4. Типы текстов и их пользователей
  5. Форматы документации и статей
  6. Стили технических текстов
  7. Основы написания технических текстов
  8. Методика написания документации на ПО и оборудовании
  9. Методика написания технических и аналитических статей
  10. Методика разработки видеодокументации
  11. Методика разработки презентаций
  12. Методика описания программного кода, баз данных и принципиальных схем оборудования
  13. Методика разработки технических заданий
  14. Методика разработки маркетинговых текстов
  15. Работа с переводной документацией.
  16. Технические переводы
  17. Эргономика в сети. Как оформлять сайты
  18. Применяемое программное обеспечение
  19. Специфика работы технического редактора
  20. Производственные процессы
  21. Обзор дополнительных областей
  22. Стандарты в документировании
  23. Что можно освоить самостоятельно?
  24. Тестирование документации
  25. Итоговая практическая работа
  26. Итоговая работа включает в себя несколько заданий: документация на программное обеспечение; статья-обзор или аналитическая статья; презентация продукта для представления на публичном мероприятии или «продающий» текст.

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

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

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

Стоимость: 11 200 ₽ – 14 490 ₽

Компетенции, которые вы приобретёте в процессе обучения:

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

Вы научитесь:

  1. разрабатывать различные виды технических документов;
  2. применять существующие стандарты документирования;
  3. использовать программные инструменты для технических писателей;
  4. грамотно вести переговоры с техническими специалистами.

Программа курса:

  • Модуль 1. Техническая документация и технический писатель: основные термины и понятия. Введение в проблему (1 ак. ч.)
  • Модуль 2. Виды и стили технических текстов (2 ак. ч.)
  • Модуль 3. Средства и методы создания технических текстов (3 ак. ч.)
  • Модуль 4. Единые стандарты документирования (2 ак. ч.)
  • Модуль 5. Приёмы работы с техническими текстами (1 ак. ч.)
  • Модуль 6. Процесс перевода технической документации (на примере английского языка) (2 ак. ч.)
  • Модуль 7. Программное обеспечение в работе технического писателя (2 ак. ч.)
  • Модуль 8. Текущая аттестация (3 ак. ч.)
Стоимость: 10 900 ₽ – 12 900 ₽

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

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

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

Успешное окончание обучения по программе курса позволит специалистам:

Знать:

  • существующие виды и стили технических документов
  • основные принципы и единые стандарты технического документирования
  • этапы и тонкости разработки технической документации

  Уметь:

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

Владеть:

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

Содержание:

  1. Профессия технический писатель
  2. Особенности написания технической документации. Основные принципы написания технической документации
  3. Этапы документирования. Работа с задачей на документирование
  4. Особенности разработки ГОСТовой документации
  5. Разработка внутреннего руководство по стилю
  6. Типы программных продуктов
  7. Предмет документирования. Способы чтения документации пользователем
  8. Детальность изложения в технической документации
  9. ГОСТ 19. ГОСТ 34. Структура ТЗ
  10. Структура Руководства пользователя
  11. Международные стандарты документирования. Особенности написания документации на английском языке
  12. Правила вёрстки. Основные ошибки в вёрстке технической документации. Плюсы и минусы различных программ для вёрстки
  13. Основные принципы дизайна
  14. Роль скриншотов в документе. Правила оформления скриншотов. ПО для создания и оформления скриншотов
  15. ПО для планирования рабочего времени. ПО для написания документации
  16. ПО для создания иллюстраций и схематических изображений. ПО для работы с виртуальными машинами
  17. Создание обучающих видеороликов. ПО для создания обучающих видеороликов
  18. Практические задания:
  • Обсуждение фрагментов инструкции.
  • Написание простой инструкции.
  • Поиск необходимого документа и чтение необходимого ГОСТа.
  • Оформление Руководства пользователя по ГОСТу.
  • Сверстать документ.
  • Найти 3 некорректных и 3 корректных скриншота.
  • Написать инструкцию и вставить в неё скриншоты.
Стоимость: разная стоимость

Дистанционные курсы:

  1. Профессиональная разработка документа «Пояснительная записка» по ГОСТ
    Курс предназначен
    для технических писателей, разработчиков документации на программные продукты, программистов, руководителей проектов и IT-специалистов, занятых в области проектирования автоматизированных систем и программных продуктов для государственных и коммерческих заказчиков.
    В курсе подробно рассматривается процесс создания одного из самых сложных документов технического проекта – Пояснительной записки.
  2. Разработка и оформление эксплуатационной документации на техническое устройство согласно требованиям ГОСТ ( ЕСКД)
    Данный курс
    посвящен вопросам разработки, оформления и согласования эксплуатационной документации (ЭД) для технических устройств. Рассмотрены основные виды ЭД, комплектность ЭД, принципы формирования обозначения документа.
    Приведены правила согласования ЭД и примеры оформления документа. На примерах показана последовательность разделов документа.
    Объясняется структура и содержание разделов конкретных ЭД (паспорт, формуляр, руководство по эксплуатации, ведомость эксплуатационных документов и др.), правила оформления графической и текстовой информации. Приведены ссылки на стандарты, в соответствии с которыми разрабатывается ЭД.

И др.

Стоимость: бесплатно

Курсы:

  1. Открытый онлайн-курс по технической документации в IT-проектах
    Расскажем обо всем понемногу: о типах технических документов, об управлении документационными процессами и о документационном инструментарии.
  2. Technical Writing 101, базовый курс по документированию
    Курс будет интересен как будущим профессионалам в области документирования (мы помогаем нашим студентам с трудоустройством), так и компаниям: мы можем целевым образом подготовить вам сотрудников на целый документационный отдел.
  3. Advanced Technical Writing
    Семинар для практикующих техписателей.
    Расскажем тонкости и хитрости, интересные для специалистов с опытом.

И др.

Стоимость: бесплатно

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

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

Успешное прохождение курса позволит претендовать на позицию стажера или младшего технического писателя в Центр разработки Orion Innovation (ранее MERA).

Содержание курса:

  1. What is the job of a technical writer?
  2. Technical writing for IT products.
  3. Technical writing tools: overview.
  4. Technical writing style.
  5. Content development process.
  6. Planning documentation.
  7. Topic-based writing.
  8. Document review.
  9. Practice – Working with MS Word.
  10. Practice – Working with graphical tools.
  11. Practice – Writing task topics.

Насколько публикация полезна?

Нажмите на звезду, чтобы оценить!

Средняя оценка 5 / 5. Количество оценок: 2

Оценок пока нет. Поставьте оценку первым.

Автор статьи. Ответственный за актуальный контент, текст и редактуру сайта. Эксперт по выбору профессии, курсов и профессий с 2016 года. Делюсь личным практическим опытом.

Оцените автора
Добавить комментарий