Практика разработки технических текстов и документации в работе технического писателя
Программа семинара направлена на освещение самых актуальных и насущных вопросов технического писательства и закрепление навыков на практике. Слушатели научатся писать технические тексты, следовать правилам и применять существующие стандарты документирования.
Вид обучения
Формат обучения
Дата и время
Место проведения
г. Москва, ул. Золотая, д. 11, бизнес-центр «Золото», 5 этаж. Всем участникам высылается подробная схема проезда на семинар.
Документы по окончании обучения
Образец сертификата об участии в семинаре Москва
Что входит в стоимость
Методический материал, кофе-паузы.
Для кого предназначен
Технических писателей; сотрудников, ответственных за разработку и сопровождение технической документации; руководителей и технических специалистов; всех заинтересованных лиц, с опытом работы в IT – сфере или имеющих техническое образование.Цель обучения
- Получить знания методик и приемов подготовки технической документации;
- Применять существующие стандарты документирования;
- Использовать программные инструменты для технических писателей;
- Грамотно вести переговоры с техническими специалистами;
- Разрабатывать различные виды технических документов.
Программа обучения
Техническая документация и технический писатель: основные термины и понятия. Введение в проблему:
- Профессиональный стандарт «Технический писатель»: содержание и требования.
- Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика.
- Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
- Навыки и умения, необходимые техническому писателю.
- Задачи технического писателя.
- Группы читателей.
- Варианты занятости и сферы деятельности технического писателя.
- Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления.
Виды и стили технических текстов:
- Особенности технического документирования.
- Формат и структура технического документа (отчёт, ТЗ, ТП, статья: общие черты и различия).
- Стили технической документации.
- Разработка эксплуатационной документации:
- упрощенный технический русский язык;
- унификация текстовых формулировок.
- Методы копирайтинга в техническом писательстве (статья, рекламы).
Принципы создания технических текстов:
- Назначение технической документации: задачи пользователей при обращении к техническим документам.
- Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов.
- Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации.
Средства, методы и приёмы создания технических текстов:
- Определение аудитории и уровня разъяснения материала.
- Аналитическая переработка текста в техническом писательстве.
- Создание плана технического текста: интеллектуальное картирование, определение структуры текста.
- Терминология в технической документации: правила применения единых терминов.
- Лексические тонкости технических документов.
- Визуализация и графическое сопровождение технических документов.
- Техническое аннотирование и реферирование.
- Оформление цитирования.
-
Практика: Корректировка имеющихся текстов: основы редактирования и корректуры.
Единые стандарты документирования:
- Назначение стандартов.
- Отечественные и зарубежные стандарты.
- Зарубежные стандарты ИСО в области системной и программной инженерии.
- Классификация ГОСТов. Системы ГОСТов.
- Унификация, стандартизация и нормоконтроль документирования.
- Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
Оформление технической документации, ПО в работе технического писателя:
- Средства MS Office. Возможности текстового редактора MS Word.
- Средства Adobe.
- Базовые форматы документации: HTML, DOC(X), CHM, PDF.
- LaTeX, RST, HTML.
- Облачные технологии (Google Docs, Evernote, Dropbox и др.).
- Программное обеспечение создания презентаций и графики.
- Принцип единого источника (single-sourcing). Разработка структурированного контента, архитектура типизированной информации.
- Контроль ошибок в объемных документах.
- Базовые процессы по контролю документации.
- Версионирование. Системы баг-трекинга ПО — помощники технического писателя.
- Организация контроля за ошибками и доработками в документах.
Практика: Ознакомление с возможностями отдельных программных комплексов.
Процесс перевода технической документации (на примере английского языка):
- Сложности перевода на другой язык, основные подводные камни.
- Грамматика и лексика в техническом переводе.
- Правила и способы перевода технических текстов.
- Применяемое программное обеспечение и приёмы его корректного использования.
- Понятие локализации в технических переводах.
- Практика: Перевод и редактирование технического текста.
Преподаватели
Преподаватель
Технический писатель IBS на проекте с Huawei, переводчик, редактор, копирайтер, специалист по исследованиям, эксперт по инновациям, руководитель проектов, консультант по стратегическому развитию.
Преподаватель/инструктор с опытом работы в разных отраслях (промышленность, строительство, девелопмент и маркетинг недвижимости).
Автор креативных концептов, создатель художественных брифов и технических заданий для проектов в России, Германии, Казахстане, Мексике, соавтор монографии по клиентоцентричности в ритейле и индустрии развлечений.