Технический писатель курсы москва

Documentat.io

Advanced Techwriting Msk Продвинутый курс по технической документации в Москве

Что это за курс

Двухдневный интенсивный семинар для практикующих технических писателей и системных аналитиков.

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

Для кого

Для практикующих технических писателей, системных аналитиков, и всех, кому по роду деятельности нужно описывать сложные технические системы.

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

Жизненные циклы технического документа: большой цикл (от бизнес-проблемы до ее решения) и малый цикл (от постановки задачи на написание документа до его приемки). Три кита технического документа: цель, целевая аудитория, заказчик.

Заочное профилирование целевой аудитории: кому мы пишем? Что мы знаем о читателе? Что читатель знает об описываемом предмете?

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

Рецензирование документов и его виды: корректура, проверка фактологической корректности, проверка на соответствие цели. Сценарии рецензирования, личное взаимодействие редактора и автора. Антипаттерны рецензирования.

Объективные критерии качества документа. «Источники истины»: документационные стандарты, словари, справочники по грамматике, внешние и внутренние гиды по стилю. Компромисс между доведением документа до совершенства и выдерживанием сроков. Понятие «good enough».

Субъективные критерии качества документа, субъективные оценки при рецензировании и приемке. Ситуации «мне не нравится», «я бы написал по-другому». Разрешение неконструктивных споров в процессе рецензирования. Почему цель документа становится особенно важной на этапе рецензирования и приемки.

Понятийный граф текста. Подходы к структурированию текста и к подаче информации. Принцип пирамиды.

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

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

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

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

Для участия в семинаре вам нужно будет взять с собой ноутбук (или любое другое устройство, на котором вам удобно набирать текст) с возможностью подключиться к Wi-Fi и открыть в браузере Google Docs.

Подготовка технических писателей

Описание

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

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

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

Разбираемые темы

• Задачи технического писателя;
• Требования к документации;
• Этапы разработки документации. Планирование;
• Комплектность документации;
• Виды, типы и структура документов;
• Разработка разделов документов;
• Описание функциональных возможностей;
• Структурно-обусловленные разделы;
• Оформление, стилевая дисциплина;
• Изложение. Организация текста;
• Верификация документации;
• Рекомендации по работе с MS Word.

Целевая аудитория

Предварительная подготовка

В ИТ-отрасли Дмитрий работает с 1992 г. Начинал свою карьеру как разработчик и архитектор, принимал участие в разработке систем автоматизированного проектирования (САПР), систем расчета заработной платы, учетных систем и даже русско-украинского переводчика.

Смена мест работы лишь расширяла кругозор и ставила новые более интересные задачи, но не меняла направленности – во всех компаниях, где работал Дмитрий, он управлял ИТ-подразделениями и/или ИТ-проектами. При этом он всегда стремился сделать разрабатываемые системы «умными» и удобными для конечных пользователей, превратить компьютер из «продвинутой пишущей машинки» в инструмент анализа и управления бизнесом.

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

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

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

В ряде проектов Дмитрий выполнял роль руководителя проекта, но роль аналитика – специалиста, отвечающего за выявление и удовлетворение потребностей заказчика, – всегда была ему ближе. Для того чтобы лучше понимать современные подходы к управлению бизнесом (а значит лучше понимать потребности, мотивы и опасения заказчиков), Дмитрий получил в 2012 г. второе высшее образование – степень МВА (Master of Business Administration).

Одна из составляющих роли аналитика в ИТ-проектах – необходимость объяснять простыми словами порой достаточно сложные понятия: разработчикам – нюансы бизнеса заказчика, заказчику – нюансы ИТ-технологий и решений. Умение объяснять, в котором, кроме всего, Дмитрию помогает его давнее увлечение психологией, постепенно стало превращаться в самостоятельную деятельность – проведение тренингов, мастер-классов, консалтинг ИТ-команд.

В итоге с 2012 г. Дмитрий стал штатным экспертом по бизнес-анализу Luxoft Training.

В качестве эксперта Дмитрий проводил курсы для сотрудников таких компаний, как Райффайзен Банк Аваль, АСТЕЛИТ, Альфа-банк Украина, МТС Украина, Киевстар, ELEKS, ГРУППА КОМПАНИЙ FOZZY GROUP, Миратех, УкрСиббанк, Энвижн Групп, iBox, Инфопульс Украина, ПриватБанк, Укрэксимбанк, РОВНОАЗОТ OSTCHEM, ЮРИЯ-ФАРМ, Укрсоцбанк, ПроКредит Банк и других.

Технический писатель

Technical writer

Аннотация

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

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

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

Описание образовательной программы

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

Знать

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

Уметь

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

Владеть

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

Цель курса

Формирование знаний и умений, необходимых для разработки технических текстов различного назначения.

Целевая аудитория

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

Необходимая подготовка

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

Содержание

1. Краткий экскурс в специальность «технический писатель».
2. Виды и стили технических документов.
3. Ознакомление с методологией создания технических текстов.
4. Отечественные и зарубежные стандарты документирования.
5. Обучение базовым приемам для работы с технической документацией.
6. Правила и особенности разработки эксплуатационной технической документации: технических условий, руководств по технической эксплуатации, регламента технического обслуживания и других.
7. Разработка программной документации.
8. Работа с технической документацией на иностранном языке. Основные приемы.
9. Обзор программного обеспечения для разработки технической документации.

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

Маркетинг и продажи

Soft-skills (Развитие личности)

Этот курс в нашем Центре
успешно закончили
506 человек!

Technical writer: technical documentation development

Хотите научиться сложное объяснять доступно и понятно? Хотите работать по высоким стандартам, принятым в крупных компаниях? Нацелены освоить секреты мастерства технического писателя? Тогда этот курс для вас!

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

Технический писатель – сравнительно молодая профессия, возникшая и оформившаяся в середине прошлого века. Техписатель – создатель текстов, рассказывающих о том, как работает тот или иной механизм или электронная машина, программное обеспечение, телефония и т.д. Он может создавать инструкции и сопроводительные документы, задания, руководства пользователей, формуляры, техтребования или большие технические статьи, СНиПы, ГОСТы и многое другое. Во многом, технический писатель сродни переводчику. Он должен уметь достаточно просто объяснить сложные вещи. Для этого необходима специальная подготовка.

Нет образовательного учреждения, где бы технических писателей готовили столь же фундаментально, как, к примеру, писателей обычных или журналистов. Техписателей готовят те, кто уже прошёл серьёзный путь в этой профессии и может поделиться накопленными знаниями. Именно такие педагоги-практики работают в Центре «Специалист» и научат вас на этом курсе всему, что знают сами.

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

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

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

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

Освойте востребованную профессию на профессиональном уровне. Приходите в «Специалист».

Курсы повышения квалификации Технический писатель: создание технической документации

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

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

1. Профессиональный стандарт «Технический писатель (специалист по технической документации в области информационных технологий)» (Приказ Минтруда России N 612н): содержание и требования.
2. Нормативные требования к содержанию и оформлению технической документации предприятия. Структура документирования и виды документов.
3. Виды и стили технических текстов.
   • Формат и структура технического документа.
   • Правила и особенности разработки эксплуатационной технической документации: технических условий, руководств по технической эксплуатации, регламента технического обслуживания и других.
   • Стили технической документации.
4. Средства и методы создания технических текстов. Корректировка имеющихся текстов: основы редактирования и корректуры.
5. Единые стандарты документирования.
   • Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
   • Система стандартов ГОСТ 19 и ГОСТ 34.
   • Единый стандарт программной документации (ЕСПД).
   • Единая система конструкторской документации (ЕСКД).
   • Единая система технологической документации (ЕСТД).
6. Приёмы работы с техническими текстами.
   • Терминология в технической документации: правила применения единых терминов.
   • Информационный дизайн технического документа.
   • Визуализация и графическое сопровождение технических документов.
   • Работа над ошибками и лексические тонкости в технических документах.
7. Работа с технической документацией на иностранном языке. Основные приемы. Правила и способы перевода технических текстов.
8. Программное обеспечение в работе технического писателя. Базовые форматы документации: HTML, DOC(X), CHM, PDF, HTML Help Workshop. Средства MS Office, средства Adobe, платформа DocBook/XML, Wiki-системы.
9. Практические рекомендации и примеры оформления технических документов (технические условия, технологический регламент, технологическая инструкция). Управление документированной информацией в контексте требований МС ISO 9001:2015.

Наличие среднего профессионального или высшего образования

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