Подборка бесплатных и платных онлайн-курсов для начинающих технических писателей с нуля и продвинутых.
Компания специализируется на создании технической документации для IT-компаний и обучении технических писателей.
Список курсов:
- Открытый онлайн-курс по технической документации в IT-проектах — бесплатно
Расскажем обо всем понемногу: о типах технических документов, об управлении документационными процессами и о документационном инструментарии. - Экспресс-курс «Технический писатель» — 10 000 руб.
Двухнедельный вводный курс для желающих войти в профессию.
Для тех, кто никогда не работал техническим писателем или даже не знаком с IT-индустрией. - Advanced Technical Writing — 30 000 руб.
Семинар для практикующих техписателей.
Расскажем тонкости и хитрости, интересные для специалистов с опытом. - Управляем командой технических писателей — 40 000 руб.
Неожиданно обнаружили, что вместо написания документации занимаетесь руководством другими техписателями?
Расскажем о том, как управлять документационными специалистами, как растить и обучать их, и как при этом не сойти с ума.
- Программа из 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-сфере.
Цель курса: Повышение квалификации специалистов в области разработки технической документации и аналитики в IT-сфере.
Темы курса:
- Введение в специальность
- Как стать техническим писателем
- Юридические и территориальные аспекты работы
- Типы текстов и их пользователей
- Форматы документации и статей
- Стили технических текстов
- Основы написания технических текстов
- Методика написания документации на ПО и оборудовании
- Методика написания технических и аналитических статей
- Методика разработки видеодокументации
- Методика разработки презентаций
- Методика описания программного кода, баз данных и принципиальных схем оборудования
- Методика разработки технических заданий
- Методика разработки маркетинговых текстов
- Работа с переводной документацией.
- Технические переводы
- Эргономика в сети. Как оформлять сайты
- Применяемое программное обеспечение
- Специфика работы технического редактора
- Производственные процессы
- Обзор дополнительных областей
- Стандарты в документировании
- Что можно освоить самостоятельно?
- Тестирование документации
- Итоговая практическая работа
- Итоговая работа включает в себя несколько заданий: документация на программное обеспечение; статья-обзор или аналитическая статья; презентация продукта для представления на публичном мероприятии или «продающий» текст.
Данный курс позволит вам освоить востребованную и высокооплачиваемую профессию технического писателя. И получить все знания и навыки, необходимые для успешной карьеры:
- Правовые основы профессиональной деятельности;
- Профессиональные стандарты и компетенции;
- Техническая документация, этапы документирования, инфостиль, текст в интерфейсе;
- Разработка и оформление инженерной технической документации в соответствии с заданным стандартом;
- Английский язык в работе технического писателя, презентация сложной технической продукции и т.д.
В результате обучения вы получаете диплом о профессиональной переподготовке установленного образца, который даёт право на ведение профессиональной деятельности.
Компетенции, которые вы приобретёте в процессе обучения:
- использование методик и приёмов подготовки технической документации в профессиональной деятельности;
- выделение подготовки технических текстов в самостоятельную функциональную область;
- развитый навык письменной коммуникации в сфере технического документирования;
- навык постановки задач пред техническими специалистами.
Вы научитесь:
- разрабатывать различные виды технических документов;
- применять существующие стандарты документирования;
- использовать программные инструменты для технических писателей;
- грамотно вести переговоры с техническими специалистами.
Программа курса:
- Модуль 1. Техническая документация и технический писатель: основные термины и понятия. Введение в проблему (1 ак. ч.)
- Модуль 2. Виды и стили технических текстов (2 ак. ч.)
- Модуль 3. Средства и методы создания технических текстов (3 ак. ч.)
- Модуль 4. Единые стандарты документирования (2 ак. ч.)
- Модуль 5. Приёмы работы с техническими текстами (1 ак. ч.)
- Модуль 6. Процесс перевода технической документации (на примере английского языка) (2 ак. ч.)
- Модуль 7. Программное обеспечение в работе технического писателя (2 ак. ч.)
- Модуль 8. Текущая аттестация (3 ак. ч.)
Технический писатель – это специальность, являющаяся весьма востребованной. Технический писатель занимается написанием документации для решения технических задач, поэтому работают такие специалисты в компаниях, разрабатывающих программные продукты, бытовую технику и аппаратуру для профессионального использования в медицине, науке и технике.
Особенностью данной профессии является то, что автор должен уметь создавать технические тексты разных стилей, сочетая в себе задатки «лирика» и «физика».
Пройдя обучение, слушатели получат знания, необходимые для работы с документацией, научатся писать тексты различных стилей на техническую тематику (технические статьи, технические задания, руководства пользователей, руководства по технической эксплуатации, формуляры и др.) на основе отечественных и зарубежных стандартов документирования, а также легко смогут применить приобретенные умения и навыки в реальных рабочих условиях.
Успешное окончание обучения по программе курса позволит специалистам:
Знать:
- существующие виды и стили технических документов
- основные принципы и единые стандарты технического документирования
- этапы и тонкости разработки технической документации
Уметь:
- разрабатывать техническую и программную документацию разного типа от технических статей до руководств пользователя
- работать с технической документацией на иностранном языке
- использовать программное обеспечение для разработки техдокументации
- создавать обучающие видеоролики
Владеть:
- терминологией и грамотным подходом при разработке технических документов различного стиля
- навыками верстки технической документации
- навыками оформления скриншотов.
Содержание:
- Профессия технический писатель
- Особенности написания технической документации. Основные принципы написания технической документации
- Этапы документирования. Работа с задачей на документирование
- Особенности разработки ГОСТовой документации
- Разработка внутреннего руководство по стилю
- Типы программных продуктов
- Предмет документирования. Способы чтения документации пользователем
- Детальность изложения в технической документации
- ГОСТ 19. ГОСТ 34. Структура ТЗ
- Структура Руководства пользователя
- Международные стандарты документирования. Особенности написания документации на английском языке
- Правила вёрстки. Основные ошибки в вёрстке технической документации. Плюсы и минусы различных программ для вёрстки
- Основные принципы дизайна
- Роль скриншотов в документе. Правила оформления скриншотов. ПО для создания и оформления скриншотов
- ПО для планирования рабочего времени. ПО для написания документации
- ПО для создания иллюстраций и схематических изображений. ПО для работы с виртуальными машинами
- Создание обучающих видеороликов. ПО для создания обучающих видеороликов
- Практические задания:
- Обсуждение фрагментов инструкции.
- Написание простой инструкции.
- Поиск необходимого документа и чтение необходимого ГОСТа.
- Оформление Руководства пользователя по ГОСТу.
- Сверстать документ.
- Найти 3 некорректных и 3 корректных скриншота.
- Написать инструкцию и вставить в неё скриншоты.
Дистанционные курсы:
- Профессиональная разработка документа «Пояснительная записка» по ГОСТ
Курс предназначен для технических писателей, разработчиков документации на программные продукты, программистов, руководителей проектов и IT-специалистов, занятых в области проектирования автоматизированных систем и программных продуктов для государственных и коммерческих заказчиков.
В курсе подробно рассматривается процесс создания одного из самых сложных документов технического проекта — Пояснительной записки. - Разработка и оформление эксплуатационной документации на техническое устройство согласно требованиям ГОСТ ( ЕСКД)
Данный курс посвящен вопросам разработки, оформления и согласования эксплуатационной документации (ЭД) для технических устройств. Рассмотрены основные виды ЭД, комплектность ЭД, принципы формирования обозначения документа.
Приведены правила согласования ЭД и примеры оформления документа. На примерах показана последовательность разделов документа.
Объясняется структура и содержание разделов конкретных ЭД (паспорт, формуляр, руководство по эксплуатации, ведомость эксплуатационных документов и др.), правила оформления графической и текстовой информации. Приведены ссылки на стандарты, в соответствии с которыми разрабатывается ЭД.
И др.
Курс введения в техническое писательство подойдет тем, кто любит разбираться в работе программного обеспечения, устройств и описывать свой опыт в форме доступных и лаконичных инструкций на английском языке.
В рамках курса узнаете специфику работы технического писателя, инструменты, используемые для создания документации, подходы к написанию пошаговых процедур и технических описаний.
Успешное прохождение курса позволит претендовать на позицию стажера или младшего технического писателя в Центр разработки 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.
