Курс "Технический писатель в IT-проектах"

Код: EDU-TW
Специализация: Авторские курсы: Теоретические основы разработки информационных систем

Продолжительность - 2 дня

Расписание:
10 июня 2024 года (Москва)
18 ноября 2024 года (Москва)

Курс Технический писатель в IT-проектах

Технический писатель – создатель текстов, рассказывающих о том, как работает тот или иной механизм или электронная машина, программное обеспечение, телефония и т.д. Он может создавать инструкции и сопроводительные документы, технические задания, руководства пользователей, формуляры, техтребования или большие технические статьи, СНиПы, ГОСТы и многое другое. Во многом, технический писатель сродни переводчику. Он должен уметь достаточно просто объяснить сложные вещи. Для этого необходима специальная подготовка.

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

Компетенции, которые вы приобретёте в процессе обучения на курсе Технический писатель в IT-проектах:

• использование методик и приёмов подготовки технической документации в профессиональной деятельности;
• узнаете способы подготовки технических текстов различного назначения;
• развитый навык письменной коммуникации в сфере технического документирования;
• навык постановки задач пред техническими специалистами.

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

Требуемая подготовка:

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

По окончании курса Технический писатель в IT-проектах слушатели будут уметь:

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

Программа курса Технический писатель в IT-проектах

Модуль 1. Введение. Роль и место технического писателя

• Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика
• Навыки и умения технического писателя
• Задачи технического писателя. Группы читателей
• Варианты занятости и сферы деятельности технического писателя

Модуль 2. Техническая документация

• История. Особенности.
• Отличия технического текста от литературного

Модуль 3. Виды и типы технической документации

• Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия
• Виды и типы технической документации

Модуль 4. Перевод и локализация

• Сложности перевода на другой язык, основные подводные камни
• Грамматика и лексика в техническом переводе
• Правила и способы перевода технических текстов
• Применяемое программное обеспечение и приёмы его корректного использования
• Понятие локализации в технических переводах
• Практика: Перевод и редактирование технического текста

Модуль 5. Средства и методы создания технических текстов

• Блок целеполагания: цель, задачи, методы и средства
• Определение аудитории и уровня разъяснения материала
• Создание руководств пользователя
• ПРАКТИКА: Корректировка имеющихся текстов: основы редактирования и корректуры

Модуль 6. Структура технического документа. Макет

• Структура документа
• Элементы структуры документа
• Структура ТЗ
• Структура Руководства пользователя

Модуль 7. Приёмы работы с техническими текстами. Стиль. Термины. Характерные ошибки

• Терминология в технической документации: правила применения единых терминов
• Визуализация и графическое сопровождение технических документов
• Работа над ошибками и лексические тонкости в технических документах

Модуль 8. Правила. Нормы. Стандарты

• Отечественные и зарубежные стандарты:
• Классификация ГОСТов
• Зарубежные стандарты – ИСО в области системной и программной инженерии
• Назначение стандартов
• ГОСТ 7.32-2001

Модуль 9. Инструменты технического писателя

• Базовые форматы документации: HTML, DOC(X), CHM, PDF
• HTML Help Workshop
• Средства MS Office
• Средства Adobe
• Платформа DocBook/XML
• Wiki-системы

Модуль 10. Применение Word. Стиль. Шаблон

• Особенности Word
• Стили
• Макет
• Вставка. Колонтитулы
• Ссылки
• Рецензирование

Модуль 11. Практика

Создание текста по заранее согласованной тематике, включающее корректуру и редактирование (по согласованию – и перевод)

В конце обучения на курсе проводится итоговая аттестация в виде теста или на основании оценок за практические работы, выполненных в процессе обучения.