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

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

Technical writer

Аннотация

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

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

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

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

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

Знать

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

Уметь

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

Владеть

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

Цель курса

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

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

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

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

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

Содержание

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

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

Перевод статьи Ады Ндука Ойом «On Becoming a Technical Writer».

Одна из моих многочисленных примеров для подражания однажды рассказала о причине, по которой она занялась техническим писательством. Для нее это был способ зафиксировать изученное и описать свои находки на пути развития как разработчика программного обеспечения. Также это должно было помочь ей в тех случаях, когда она “терялась, встретив снова ту же самую проблему/баг”.

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

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

Навыки

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

Хорошие навыки письма и коммуникации

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

Технический опыт / навыки, имеющие отношение к отрасли

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

Интерес

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

Навыки поиска

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

Процесс

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

1. Знакомство с аудиторией.

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

• Кто они?
• Что им нужно (узнать из вашей статьи)?
• Где они будут читать вашу статью?
• Почему они будут ее читать?
• Как они будут читать?

Эти вопросы имеют большое значение для понимания аудитории.

2. Распланируйте свою статью

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

3. Повторный просмотр

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

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

4. Креативность контента

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

Выбор слов

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

Пример: Открыть командную строку и выполнить действия XYZ в директории «Документы».

Лучше так: Откройте командную строку, перейдите в директорию «Документы», напечатав «cd Документы», а затем выполните действия XYZ.

Постоянно используйте активный залог

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

Пример: Больше 35 тысяч пакетов содержится в реестре пакетов Node.js npm.

Лучше: Реестр пакетов Node.js npm содержит больше 35 тысяч пакетов.

Структура предложений

Большое значение имеет помещение важной информации в первом предложении.

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

Лучше: Чтобы избежать потери данных рекомендуется делать бэкап перед осуществлением обновления базы данных.

Избегайте технического сленга/сокращений/жаргона

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

Пример: Шаблон MVC принимается различными фреймворками.

Лучше: Шаблон Model-View-Controller (MVC) принимается различными фреймворками.

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

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

Преимущества

В том чтобы быть техническим писателем есть свои преимущества. Например:

1. Постоянное обучение – поскольку вы постоянно старайтесь поспевать за новыми технологиями, улучшать свои навыки чтения и письма, погружаться в новые глубины и получать обратную связь. Это рост все выше и выше.
2. Это ценный и прибыльный навык, поскольку каждый, кому хорошо удается доносить до пользователей технические сложности простыми словами, представляет ценность для организаций. И чтобы получить такого сотрудника, компании всегда готовы щедро платить.
3. Для людей, работающих в сфере технологий, это дополнительный набор навыков, который может содействовать карьерному росту. Связано это с тем, что их начинают воспринимать как способных быстро схватывать и доносить пользователю важность технологии и то, как ее использовать.

Желаем вам удачи в написании технических статей!

Вебинар Технический писатель. Разработка технических текстов

Код 43029

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

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

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

1. Профессиональный стандарт «Технический писатель»: содержание и требования.
2. Единые стандарты документирования. Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам. Система стандартов ГОСТ 19 и ГОСТ 34. Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД). Требования ГОСТ 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. Перевод технической документации. Сложности перевода на другой язык, основные подводные камни.
13. Программное обеспечение в работе технического писателя. HTML Help Workshop, средства Adobe, платформа DocBook/XML. Облачные технологии (Google Docs, Evernote, Dropbox и др.). Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin. Практика: ознакомление с возможностями отдельных программных комплексов.

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

Стоимость обучения с выдачей удостоверений на русском и английском языках — 41 000 р.

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

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

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

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

Technical writer: technical documentation development

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

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

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

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

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

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

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

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

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

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

Описание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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