О чем курс:
Об основах профессии технического писателя: о том, что такое техническая документация и как ее писать.
Для кого:
Для тех, кто интересуется профессией технического писателя или хочет применить свои гуманитарные компетенции в IT.
Какой-либо предварительный опыт или знание специфики IT-индустрии для участия в курсе не требуются.
Программа курса:
- Определение технической документации. Ее назначение, стилистические особенности. Отличие технической документации от других видов текстов.
- Технический писатель: его обязанности, его роль в процессах разработки ПО. Отличие техписателя от других специалистов, работающих с текстами.
- Рынок труда технических писателей. Профессия технического писателя: необходимые навыки и особенности характера.
- Целеполагание технического документа: кому мы пишем и зачем мы пишем?
- Пошаговые инструкции: назначение, типичная структура, грамматические конструкции.
- Гиды по стилю (стайлгайды): назначение, примеры.
- Ревью технической документации. Процессы ревью, этикет ревью.
- Концепт-топики (концептуальные статьи). Основные особенности, типичные ошибки.
- Руководства пользователя: назначения, основные структурные паттерны, типичные ошибки.
- ГОСТ 2, ГОСТ 19, ГОСТ 34. Назначение и применение документационных стандартов.
- Основные принципы составления и оформления документации по ГОСТ 2.
- Основные документы по ГОСТ: техническое задание, пояснительная записка, руководство пользователя, программа и методика испытаний.
Формат курса
Курс проводится в формате живых вебинаров. После завершения курса участникам будут доступны видеозаписи всех занятий.
