О чём курс

О чём курс

Профессия технического писателя сочетает подготовку технической документации в IT-сфере со знанием стилистических особенностей специализированных текстов. Обучение показывает отличия таких материалов от публицистики и художественной литературы, а также специфику работы этого специалиста в сравнении с другими авторами.

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

Для кого

Материал рассчитан на широкий круг слушателей без предварительного опыта и специальных технических знаний:

  • тех, кто хочет войти в IT-сферу или сменить текущую профессию;
  • специалистов с гуманитарным бэкграундом, планирующих применить свои навыки в технологических проектах;
  • тех, кто стремится научиться структурировать и оформлять сложную техническую информацию.

Что внутри

В программе разбираются базовые и специализированные темы:

  • целеполагание и анализ пользовательской аудитории;
  • подготовка различных форматов материалов: инструкций, концептуальных статей и руководств пользователя;
  • внедрение и применение стайлгайдов;
  • организация процессов и этика ревью документации, а также профилактика типичных профессиональных ошибок;
  • работа с государственными стандартами (ГОСТ 2, ГОСТ 19, ГОСТ 34), актуальными для крупных компаний и проектов с государственным участием.

Формат

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

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

  1. Определение технической документации. Ее назначение, стилистические особенности.
  2. Отличие технической документации от других видов текстов.
  3. Технический писатель: его обязанности, его роль в процессах разработки ПО.
  4. Отличие техписателя от других специалистов, работающих с текстами.
  5. Рынок труда технических писателей.
  6. Профессия технического писателя: необходимые навыки и особенности характера.
  7. Целеполагание технического документа: кому мы пишем и зачем мы пишем?
  8. Пошаговые инструкции: назначение, типичная структура, грамматические конструкции.
  9. Гиды по стилю (стайлгайды): назначение, примеры.
  10. Ревью технической документации. Процессы ревью, этикет ревью.
  11. Концепт-топики (концептуальные статьи). Основные особенности, типичные ошибки.
  12. Руководства пользователя: назначения, основные структурные паттерны, типичные ошибки.
  13. ГОСТ 2, ГОСТ 19, ГОСТ 34. Назначение и применение документационных стандартов.
  14. Основные принципы составления и оформления документации по ГОСТ 2.
  15. Основные документы по ГОСТ: техническое задание, пояснительная записка, руководство пользователя, программа и методика испытаний.
Складчина создана 2 декабря 2022 г.

Другие материалы автора 1

ОГ Оксана Гаврюшенко Все материалы
1 223 ₽ 10 000 ₽