Технический писатель: создание технической документации
Тех_П
Данный курс предназначен для специалистов, разрабатывающих и создающих техническую документацию любой сложности. На практических занятиях специалисты получат профессиональные знания и приобретут опыт написания текстов различных стилей на техническую тематику.
Аудитория
Технические писатели, специалисты, ответственные за разработку и сопровождение технической документации.
Предварительный уровень подготовки
- желателен опыт работы в IT-сфере или наличие технического образования
- желательно знание иностранного языка
- владение коммуникативными навыками
- владение грамотным русским языком.
Программа курса
Модуль 1. Техническая документация и технический писатель: основные термины и понятия. Введение в тематику (1 ак. ч.)
- Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика
- Виды занятости, связанные с разработкой документации и основные виды создаваемых документов
- Навыки и умения технического писателя
- Задачи технического писателя. Группы читателей
- Варианты занятости и сферы деятельности технического писателя
Модуль 2. Виды и стили технических текстов (2 ак. ч.)
- Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия
- Стили технической документации
Модуль 3. Средства и методы создания технических текстов (3 ак. ч.)
- Блок целеполагания: цель, задачи, методы и средства
- Определение аудитории и уровня разъяснения материала
- Об описании БД, кодов. Создание руководств пользователя
- Практика: Корректировка имеющихся текстов: основы редактирования и корректуры
Модуль 4. Единые стандарты документирования (2 ак. ч.)
- Отечественные и зарубежные стандарты:
- Классификация ГОСТов
- Зарубежные стандарты – ИСО в области системной и программной инженерии
- Назначение стандартов
- ГОСТ 7.32-2017
Модуль 5. Приёмы работы с техническими текстами (1 ак. ч.)
- Терминология в технической документации: правила применения единых терминов
- Визуализация и графическое сопровождение технических документов
- Работа над ошибками и лексические тонкости в технических документах
Модуль 6. Процесс перевода технической документации (на примере английского языка) (2 ак. ч.)
- Сложности перевода на другой язык, основные подводные камни
- Грамматика и лексика в техническом переводе
- Правила и способы перевода технических текстов
- Применяемое программное обеспечение и приёмы его корректного использования
- Понятие локализации в технических переводах
- Практика: Перевод и редактирование технического текста
Модуль 7. Программное обеспечение в работе технического писателя (2 ак. ч.)
- Базовые форматы документации: HTML, DOC(X), CHM, PDF
- HTML Help Workshop
- Средства MS Office
- Средства Adobe
- Платформа DocBook/XML
- Wiki-системы
Модуль 8. Итоговая работа (3 ак. ч.)
- Итоговая работа: Создание текста по заранее согласованной тематике, включающее корректировку и редактирование.