Documentat.io

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Формат курса

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