Documentat.io

О чем курс

Об основах профессии технического писателя: о том, что такое техническая документация и как ее писать.

Для кого

Для тех, кто интересуется профессией технического писателя или хочет применить свои гуманитарные компетенции в IT.

Какой-либо предварительный опыт или знание специфики IT-индустрии для участия в курсе не требуются.

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

• Определение технической документации. Ее назначение, стилистические особенности. Отличие технической документации от других видов текстов.

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

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

• Целеполагание технического документа: кому мы пишем и зачем мы пишем?

• Пошаговые инструкции: назначение, типичная структура, грамматические конструкции.

• Гиды по стилю (стайлгайды): назначение, примеры.

• Ревью технической документации. Процессы ревью, этикет ревью.

• Концепт-топики (концептуальные статьи). Основные особенности, типичные ошибки.

• Руководства пользователя: назначение, основные структурные паттерны.

• ГОСТ 2, ГОСТ 19, ГОСТ 34. Назначение и применение документационных стандартов.

• Основные принципы составления и оформления документации по ГОСТ (обзорно).

• Практические задания по написанию технических текстов и разработке документов.

Формат курса

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

• Теоретический материал будет предоставлен в записи. Участникам нужно будет посмотреть лекции и подготовить вопросы до вебинара.

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

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

Видеозаписи вебинаров будут доступны участникам в течение неограниченного времени.

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