Разработка технической документации
Подробнее о курсе
Краткое описание курса
На курсе Вы получите полное представление о профессии технического писателя. Узнаете о том, какими должны быть технические документы по содержанию и структуре. Начнёте писать техническую документации и услышите мнение эксперта о ней
Краткое содержание курса
Модуль 1 — Профессия технического писателя
- Основные профессиональные обязанности
- Виды занятости
- Виды технических документов и их структуры
- Навыки технического писателя
- Группы читателей технических документов
- Постановка задачи для технического писателя
- Стили технической документации
Модуль 2 — Процесс создания технического документа
- Цель и аудитория документа
- Создание руководства пользователя
- Создание руководства администратора
- Создание технического задания
- Описания БД и кода
- Вычитка документа
Модуль 3 — Единые стандарты документирования
- Российские и зарубежные стандарты документирования
- Назначение стандартов
- Особенности организации процесса написания ГОСТовой документации
Модуль 4 — Способы представления информации в технической документации
- Роль вёрстки в документе
- Иллюстрации, как способ представления информации
- Инфографика в технических статьях
Модуль 5 — Перевод технической документации
- Сложности в переводе документации
- Правила и способы перевода
- Локализация
- ПО для перевода
Модуль 6 — ПО в работе технического писателя
- HTML Help Workshop
- Средства MS Office
- Платформа DocBook
- Wiki-системы
Модуль 7 — Создание документации в различных форматах
