13 курсов технического писателя

Структура курса по техническому писанию

• Обзор курса: курс включает текстовый материал и задания по различным темам. Видеоматериалов нет, но есть куратор, который поможет ответить на вопросы.
• Уровень заданий: задания распределяются от простых к более сложным. Начинать придется с написания деловых писем, но затем материал усложняется.
• Содержание курса: основное внимание уделяется написанию мануалов, включая описание функциональности продукта и FAQ. Далее следует раздел, посвященный тестированию юзабилити руководства, подготовке отчетов и улучшению мануала на основе результатов.
• Завершающее задание: написание технического отчета по выбранной теме.
• Использование XML редактора: большинство заданий требуют работать в XML редакторе, поэтому в параллель необходимо изучить курс по использованию таких редакторов в техническом писательстве.

• Модуль 1 — Профессия технический писатель
• Основные обязанности технического писателя
• Маркетинговые и научные тексты
• Технический писатель + Специалист по анализу
• Основные профессиональные навыки технического писателя
• Дополнительные задачи технического писателя

• Модуль 2 — Поиск работы в области технического писательства
• Поиск открытых вакансий
• Составление профессионального резюме
• Эффективное интервью
• Оценка текущих навыков
• Планирование карьерного роста

• Модуль 3 — Техническая документация
• Структура технических документов
• Программное обеспечение и программное обеспечение
• Стили документации
• Унифицированные нормы документирования
• Написание статей

• Модуль 4 — Процесс документирования
• Роль технической документации в проекте
• Постановка задач перед техническим писателем
• Интервьюирование
• Коллективная работа технических писателей
• Редактирование, тестирование и публикация документации

• Модуль 5 — Использование английского языка для работы технического писателя
• Особенности перевода
• Техническая документация на английском языке
• Наименования основных элементов интерфейса на английском языке

• Модуль 6 — Инфостиль
• Использование инфостиля в технической документации
• Основы инфостиля

• Модуль 7 — Особенности организации процесса документирования
• Оценка временных рамок документации
• Верстка документа

• Модуль 8 — Текст в пользовательском интерфейсе
• Правила написания текста для интерфейса
• Психология пользователей

• Модуль 9 — Видео-инструкции
• Видео против текста
• Процесс создания видео-инструкций

• Модуль 10 — Программное обеспечение в работе технического писателя
• Список программного обеспечения для технического писателя
• Особенности работы с Confluence

Роль технического писателя в информационных технологиях

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

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

• Задания и инструкции для специалистов
• Руководства по эксплуатации для пользователей
• Техническое задание (ТЗ)
• Технические условия (ТУ)
• Технический паспорт
• Прочие описания продукта

Процесс создания видео-инструкции:

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

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

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

Профессия технического писателя в сфере IT

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

Цель курса

• Написать техническую документацию
• Найти необходимую информацию
• Определить аудиторию документации
• Эффективно структурировать текст

Для кого подходит курс

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

Что вы узнаете

• Анализ продукта
• Определение целевой аудитории
• Создание различных типов документов
• Лексические нормы и стандарты
• Использование инструментов для написания документации

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

• Введение
• Работа на IT проектах
• Техническая документация в IT-проектах
• Описание пользовательского интерфейса
• Организация документа на уровне деталей и общего вида
• Документация по задачам Часть 1 и Часть 2
• Концепция, справочные материалы, решение проблем
• Визуализация информации
• Оформление и редактирование
• Использование инструментов для управления проектами и создания вики и справочных сайтов, на примере Jira и Confluence
• Подготовка к экзамену и итоговый проект
• Защита итогового проекта

Уникальные курсы для технических писателей

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

Главная цель курса

Курс "ПроТекст" направлен на подготовку специалистов в области разработки технической документации и аналитики в сфере информационных технологий.

Цель курса:

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

Темы курса:

• Введение в профессию
• Становление техническим писателем
• Юридические и географические аспекты работы
• Виды текстов и аудитория
• Форматы документации и статей
• Стили технических текстов
• Основы написания технических текстов
• Методика написания документации по ПО и оборудованию
• Методика написания технических и аналитических статей
• Методика создания видеодокументации

Прочие темы курса:

• Разработка презентаций
• Описание программного кода, баз данных и принципиальных схем оборудования
• Разработка технических заданий
• Разработка маркетинговых текстов
• Работа с переводной документацией
• Технический перевод
• Эргономика веб-сайтов
• Используемое программное обеспечение
• Работа технического редактора
• Производственные процессы
• Дополнительные области
• Стандарты документации
• Навыки, доступные для самостоятельного освоения
• Тестирование документации

Итоговая практическая работа:

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

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

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

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

Ключевые навыки, которые вы освоите:

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

Что вы изучите:

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

Структура обучающего курса:

• Модуль 1: Основные термины и понятия в области технической документации (1 ак. ч.)
• Модуль 2: Разнообразие типов и стилей технических текстов (2 ак. ч.)
• Модуль 3: Методы и средства создания технических текстов (3 ак. ч.)
• Модуль 4: Соблюдение единых стандартов документирования (2 ак. ч.)
• Модуль 5: Эффективные приемы работы с техническими текстами (1 ак. ч.)
• Модуль 6: Процесс перевода технической документации с английского языка (2 ак. ч.)
• Модуль 7: Использование программного обеспечения при работе техническим писателем (2 ак. ч.)
• Модуль 8: Текущая проверка знаний (3 ак. ч.)

Профессия технический писатель

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

Особенности написания технической документации. Основные принципы написания технической документации

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

Этапы документирования. Работа с задачей на документированием

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

Типы программных продуктов

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

Практические задания

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

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

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

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

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

Цель обучения:

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

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

• Основные понятия и термины технической документации;
• Учеба работы технического писателя и его основные обязанности;
• Различия между техническим писателем, обычным писателем и писателем-аналитиком;
• Виды документации и основные создаваемые документы;
• Стандарты документирования и их классификация;
• Примеры оформления технических документов по стандартам;
• Специфика технической документации и стили текстов;
• Использование различных средств и методов создания технических текстов;
• Создание и редактирование технических текстов с учетом специфики перевода;
• Использование программного обеспечения для работы технического писателя;
• Программное обеспечение HTML, DOC(X), PDF, Wiki и другие технологии.

Для кого:

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

Программа:

• Профессиональный стандарт «Технический писатель»: содержание и требования.
• Единые стандарты документирования.
• Практические рекомендации и примеры оформления технических документов на основе шаблонов, составленных по стандартам.
• Система стандартов.
• Унификация, стандартизация и нормоконтроль документирования.
• Единый стандарт программной документации (ЕСПД).
• Система стандартов по информации, библиотечному и издательскому делу (СИБИД).

Мастер-классы и методы:

• Мастер-класс: «Сложности написания руководства пользователя по ГОСТ 34».
• Методы и приемы работы с техническими текстами.
• Методы аналитико-синтетической переработки, используемые в техническом писательстве.
• Этапы создания технического текста.
• Изучение целевой аудитории: метод сценариев.

Оформление и дизайн:

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

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

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

Принципы и методы работы:

• Промышленный подход к разработке документации.
• Стандарт DITA.
• Системы баг-трекинга ПО.
• Организация контроля за ошибками и доработками в документах.