Скачать [Documentat.io] Advanced Technical Writing [Семён Факторович]

  • Гость, подпишитесь сейчас

    📥 Наш адрес сайта меняется, чтобы быть в курсе актуального адреса, подпишитесь на телеграм канал «Перейти»

Описание складчины

Курс [Documentat.io] Advanced Technical Writing [Семён Факторович] содержит актуальные материалы и практические рекомендации по своей тематике. Благодаря складчине купить курс можно значительно выгоднее полной стоимости.

Информация
Цена: 280 РУБ
Организатор: Kail Kail
Скачать
Kail
Kail
Организатор
Организатор
Регистрация
09.04.2020
Сообщения
463 498
Реакции
45 757
Монеты
1 191
Оплачено
0
Баллы
0
  • #SkladchinaVip
  • #1
[Documentat.io] Advanced Technical Writing [Семён Факторович]
Ссылка на картинку
Это это за курс
Интенсивный семинар для практикующих технических писателей.
Без привязки к конкретным типам документов и документационным методологиям расскажем, как сделать ваш текст лучше, как описывать сложные программные (и вообще технические) системы, и как выработать объективные критерии качества документации и донести их до всей команды.

Для кого
  • Для опытных технических писателей, системных аналитиков, и всех, кому по роду деятельности нужно описывать сложные технические системы.
Программа курса
  • Жизненные циклы технического документа: большой цикл (от бизнес-проблемы до ее решения) и малый цикл (от постановки задачи на написание документа до его приемки). Три кита технического документа: цель, целевая аудитория, заказчик.
  • Заочное профилирование целевой аудитории: кому мы пишем? Что мы знаем о читателе? Что читатель знает об описываемом предмете?
  • Проблемы технической документации глазами ее потребителя: «ничего не понял», «не нашел того, что искал», «не смог решить исходную проблему» и т.д. и методы их решения. Типичные сценарии чтения технического текста. Выбор структуры документа и подходов к подаче информации исходя из ожидаемых сценариев чтения.
  • Рецензирование документов и его виды: корректура, проверка фактологической корректности, проверка на соответствие цели. Сценарии рецензирования, личное взаимодействие редактора и автора. Антипаттерны рецензирования.
  • Объективные критерии качества документа. «Источники истины»: документационные стандарты, словари, справочники по грамматике, внешние и внутренние гиды по стилю. Компромисс между доведением документа до совершенства и выдерживанием сроков. Понятие "good enough".
  • Субъективные критерии качества документа, субъективные оценки при рецензировании и приемке. Ситуации «мне не нравится», «я бы написал по-другому». Разрешение неконструктивных споров в процессе рецензирования. Почему цель документа становится особенно важной на этапе рецензирования и приемки.
  • Понятийный граф текста. Подходы к структурированию текста и к подаче информации. Принцип пирамиды.
  • Подходы к описанию сложных технических систем. Работа с ментальными моделями, описание различных ракурсов одной и той же модели. Архитектурные документы как один из самых сложных видов технической документации.
  • Типичные ошибки структуры и подачи информации. «Проклятие знания» и «проклятие незнания». Определение понятий через их второстепенные характеристики. Непопадание в цель и целевую аудиторию. Ошибка ракурсов. Изложение фактов в том порядке, в котором их узнавал автор. Другие варианты нарушения порядка в понятийном графе.
  • Роль старшего технического писателя в команде. Создание культуры рецензирования, передача опыта, формирование командного вкуса.
Показать больше
 
Зарегистрируйтесь , чтобы посмотреть контент.
advanced technical writing documentat.io граф текста курс по технической документации семён факторович
Похожие складчины

Войдите или зарегистрируйтесь

Вы должны быть авторизованны для просмотра материала

Создать аккаунт

Создать учетную запись займет не больше минуты!

Войти

Уже зарегистрированы? Просто войдите.