Этот курс можно
изучать очно!
Подробнее
Практика разработки технических текстов и документации в работе технического писателя. Стандарты ЕСПД и современные требования к документации
Артикул: МС26624
Программа курса направлена на освещение самых актуальных и насущных вопросов технического писательства и закрепление навыков на практике. Слушатели научатся писать технические тексты, следовать правилам и применять существующие стандарты документирования. Особое внимание в программе уделяется практическим аспектам работы и современным технологиям в области технической документации.
Вид обучения
Формат обучения
Дата и время
Документы по окончании обучения
По итогам обучения слушатели, успешно прошедшие итоговую аттестацию по программе обучения, получают Удостоверение о повышении квалификации в объеме 16 часов (в соответствии с лицензией на право ведения образовательной деятельности, выданной Департаментом образования и науки города Москвы).Что входит в стоимость
Методический материал.
Для кого предназначен
Технических писателей; сотрудников, ответственных за разработку и сопровождение технической документации; руководителей и технических специалистов; всех заинтересованных лиц, с опытом работы в IT – сфере или имеющих техническое образование.Цель обучения
- Получить знания методик и приемов подготовки технической документации;
- Применять существующие стандарты документирования;
- Использовать программные инструменты для технических писателей;
- Грамотно вести переговоры с техническими специалистами;
- Разрабатывать различные виды технических документов.
Программа обучения
День 1.
Техническая документация и технический писатель: основные термины и понятия.
- Профессиональный стандарт «Технический писатель»: содержание и требования.
- Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика.
- Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
- Навыки и умения, необходимые техническому писателю.
- Задачи технического писателя.
- Группы читателей.
- Варианты занятости и сферы деятельности технического писателя.
- Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления.
Виды и стили технических текстов:
- Особенности технического документирования.
- Формат и структура технического документа (отчёт, ТЗ, ТП, статья: общие черты и различия).
- Стили технической документации.
- Разработка эксплуатационной документации:
- упрощенный технический русский язык;
- унификация текстовых формулировок.
- Методы копирайтинга в техническом писательстве (статья, рекламы).
Принципы создания технических текстов:
- Назначение технической документации: задачи пользователей при обращении к техническим документам.
- Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов.
- Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации.
Средства, методы и приёмы создания технических текстов:
- Определение аудитории и уровня разъяснения материала.
- Аналитическая переработка текста в техническом писательстве.
- Создание плана технического текста: интеллектуальное картирование, определение структуры текста.
- Терминология в технической документации: правила применения единых терминов.
- Лексические тонкости технических документов.
- Визуализация и графическое сопровождение технических документов.
- Техническое аннотирование и реферирование.
- Оформление цитирования.
-
Практика: Корректировка имеющихся текстов: основы редактирования и корректуры.
Единые стандарты документирования:
- Назначение стандартов.
- Отечественные и зарубежные стандарты.
- Зарубежные стандарты ИСО в области системной и программной инженерии.
- Классификация ГОСТов. Системы ГОСТов.
- Унификация, стандартизация и нормоконтроль документирования.
- Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
Оформление технической документации различного назначения.
- Визуализация и графическое сопровождение технических документов.
- Фотография и векторная иллюстрация в документах.
- Отображение алгоритма или процесса с помощью блок-схем.
- Документирование функциональных требований (ФТ).
Обзор ПО в работе технического писателя.
- Средства MS Office. Возможности текстового редактора MS Word.
- Средства Adobe.
- Базовые форматы документации: HTML, DOC(X), PDF, LaTeX, RST, HTML.
- Облачные технологии (Google Docs, Evernote, R7, Доктор Эксплейн, Опен Офис и др.).
- Программное обеспечение создания презентаций и графики.
- Контроль ошибок в объемных документах.
- Организация контроля ошибок и доработки документов.
- Базовые процессы контроля документации.
- Версионирование.
- Системы баг-трекинга ПО — помощники технического писателя.
Разработка документации на основе принципа единого источника. Стандарт DITA:
- Принцип единого источника: разработка структурированного контента, архитектура типизированной информации, смысловая разметка и формирование документа.
- Особенности внедрения технологии DITA на предприятии, целесообразность использования XML-подобных документов.
День 2.
Определение и назначение стандартов ЕСПД. Область распространения стандартов ЕСПД.
- Классификация и обозначение стандартов ЕСПД. Общие положения ГОСТ 19.001.
- Структура обозначения программ и программных документов. Виды программных документов ГОСТ 19.101.
- Стадии разработки программ и программной документации ГОСТ 19.102.
- Основные надписи. ГОСТ 19.104.
- Общие требования к программным документам ГОСТ 19.105.
- Техническое задание ГОСТ 19.201.
- Спецификация ГОСТ 19.202.
- Программа и методика испытаний ГОСТ 19.301.
- Текст программы ГОСТ 19.401.
- Формуляр ГОСТ 19.501.
- Описание применения ГОСТ 19.502.
- Пояснительная записка ГОСТ 19.404.
- Руководство программиста ГОСТ 19.504.
- Руководство оператора ГОСТ 19.505.
- Ведомость эксплуатационных документов ГОСТ 19.507.
- Руководство по техническому обслуживанию ГОСТ 19.508.
- Общие правила внесения изменений ГОСТ 19.603.
- Схемы алгоритмов, программ, данных и систем ГОСТ 19.701.
ГОСТ 34 Информационные технологии. Автоматизированные системы.
- Информационная технология. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем ГОСТ 34.201.
- Информационные технологии. Система стандартов по базам данных. Концепции и терминология для концептуальной схемы и информационной базы ГОСТ 34.320.
- Информационные технологии. Система стандартов по базам данных. Эталонная модель управления данными ГОСТ 34.321.
- Информационные технологии. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы ГОСТ 34.602.
ГОСТ Р59 Комплекс стандартов на автоматизированные системы.
- Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания ГОСТ Р 59793.
- Комплекс стандартов на автоматизированные системы. Виды испытаний автоматизированных систем ГОСТ Р 59792.
- Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов ГОСТ Р 59795.
- Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения. ГОСТ Р 59853.
ГОСТ Р 51 Защита информации.
Защита информации. Порядок создания автоматизированных систем в защищенном исполнении. Общие положения ГОСТ Р 51583.
Преподаватели
Преподаватель
Преподаватели курсов по техническому копирайтингу.
Эксперты по составлению технической документации.