Documentat.io

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

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

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

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

Для кого

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

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

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

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

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

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

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

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

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

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

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

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


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

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

Следующий курс

8-9 декабря 2017

Место проведения

Новосибирск, Академгородок, ул. Кутателадзе, 4Г

Стоимость
12 000 руб. Записаться
Продолжительность

Два полных дня
(11:00–19:00 с перерывом на обед)

Ведущий курса

Семён
Факторович

Руководитель отдела техдокументации компании HDsoft (новосибирского подразделения американской компании Zodiac Interactive)

Более 5 лет занимается технической документацией в разных ее проявлениях.

Преподает в Новосибирском государственном университете.

Оставьте заявку на участие в курсе!

Мы свяжемся с вами в ближайшее время.

или пишите на info@documentat.io

Оставьте заявку

Мы свяжемся с вами в ближайшее время.
Если вы оставите свой номер телефона, то мы сможем пообщаться еще быстрее.

или пишите на info@documentat.io

Спасибо, ваш запрос отправлен!
Мы свяжемся с вами в самое ближайшее время.

Что-то пошло не так, и форма не отправилась.
Напишите, пожалуйста, свой вопрос или заявку на info@documentat.io