Documentat.io

Ревью документации: методы, приемы, процессы

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

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

Этот курс — о том, как команде технических писателей проводить и организовывать ревью своих документов.

Мы расскажем о том, как:

  • определить понятие качества документации и повышать его с помощью ревью;

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

  • выстроить конструктивное взаимодействие между автором текста и автором правок;

  • регламентировать процессы ревью.

Курс предполагает практику: мы потренируемся делать ревью технических текстов, а в конце проведем ревью фрагмента вашей документации по стандартам documentat.io.

Для кого

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

Для техписателей-тимлидов, которые настраивают процессы ревью в своей команде.

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

  • Качество документации: по каким критериям оценивать качество текстов.

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

  • Как делать ревью: алгоритм и этапы работы, подводные камни, на что смотреть в документах, что учитывать при работе.

  • Виды ошибок в текстах: что может сломаться в тексте документации и как это чинить.

  • Культура ревью: типичные проблемы, которые возникают при ревью (со стороны автора текста, со стороны ревьюера). Способы их устранить.

  • Ревью как рабочий процесс: хорошие и плохие практики. Регламенты ревью. Как подстраивать процессы под конкретные проектные нужды.

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

Формат курса

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

Для участия в курсе вам потребуется доступ к Zoom, Telegram и Google Docs.

Курс предполагает живое общение, поэтому приготовьте микрофон.

Остались вопросы?

Прочитайте наш FAQ по курсам или напишите на info@documentat.io.

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

11–21 ноября 2024

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

Онлайн

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

4 дня: 11, 14, 18, 21 ноября

Время занятий

10:00 — 13:00 Мск

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

Ната Мелихова

Главный редактор в documentat.io, компании по заказной разработке документации.

4 года занимаюсь настройкой процессов ревью и повышением качества документации в разных командах.

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

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

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

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


Отправляя заявку, вы принимаете соглашение об обработке персональных данных, политику обработки персональных данных и условия договора-оферты.

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

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

© 2016–2024 Семён Факторович и команда