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

Name: Advanced Technical Writing. Продвинутый курс по технической документации
Price: 1976 RUB
Availability: PreOrder

15 участников

СФ Автор Семён Факторович Школа documentat.io

О чём курс

Опытные технические писатели часто сталкиваются с тем, что документация либо перегружена, либо не отвечает на вопросы пользователей — здесь разбирают, как превратить сухой текст в рабочий инструмент для команды. Вы научитесь объективно оценивать качество документации, отделяя личное "мне не нравится" от профессиональных критериев эффективности. Основной фокус сделан на методах описания сложных технических систем, выборе структуры под конкретные сценарии чтения и выстраивании культуры рецензирования в команде. Курс рассчитан на специалистов с 1–2 годами опыта, которые хотят перейти от написания текстов "как получится" к системному проектированию документации.

Программа обучения

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

Складчина создана 11 февраля 2024 г. · описание обновлено 3 мая 2026 г.

Отзывов пока нет. Будьте первым!

Как получить курс?

Влада Администратор сайта

Этот курс сейчас в процессе организации складчины. Нажмите кнопку «Записаться» и ожидайте старта — вам придёт уведомление. Когда складчина стартует, в карточке курса будет указан актуальный взнос. Текущая цена пока в процессе формирования и может отличаться от финальной.

Финальный взнос будет ниже, чем 30 000 ₽?

Влада Администратор сайта

Да, мы стремимся, чтобы финальный взнос был не больше ≈10% от оригинальной цены курса. Чем больше участников записывается в складчину, тем ниже выходит взнос для каждого.

Как я могу ускорить сбор складчины и уменьшить взнос?

Влада Администратор сайта

Нажмите кнопку «Записаться» и авторизуйтесь на сайте через email (через ту же почту, которую будете использовать для входа). В личном кабинете вас будут ждать инструкции, как пригласить других участников — чем больше людей записалось, тем быстрее стартует складчина и тем ниже взнос. Как только складчина готова к приобретению, вам придёт уведомление.