Технический писатель: создание технической документации

ДЕНЬ 1

Введение в профессию технического писателя:

• История профессии. Эволюция технических текстов и языка.
• Содержание работы технического писателя. Отличия технического писателя от обычного писателя и писателя-аналитика.
• Техническая коммуникация: сущность, цели, задачи.
• Направления деятельности, связанные с разработкой документации. Виды занятости и сферы работы технического писателя.
• Навыки и умения, необходимые техническому писателю. Задачи технического писателя.
• Взаимодействие технических подразделений с техническими писателями. Организация подразделения технических писателей.
• Профессиональный стандарт «Технический писатель (специалист по технической документации в области информационных технологий)»: содержание и требования.

Практикум: Анализ типовых должностных инструкций технического писателя. Определение ключевых компетенций и зон ответственности. Составление профиля должности для конкретного предприятия.

Виды и стили технических текстов:

• Основные виды технических документов: технические условия, руководства по эксплуатации, паспорта изделий, регламенты технического обслуживания, технологические инструкции, программы и методики испытаний.
• Формат и структура технического документа. Отличия отчёта, технического задания, технического проекта, статьи: общие черты и различия.
• Стили технической документации. Выбор стиля в зависимости от целевой аудитории и назначения документа.
• Определение аудитории, группы читателей. Читатель и текст: нейробиологический и психолингвистический аспекты.
• Преодоление коммуникативных барьеров между разработчиком и читателем/пользователем.
• Определение уровня разъяснения: руководство пользователя vs. руководство администратора/оператора.

Деловая игра: «Выбор формата и стиля документа» – слушателям предлагается описание продукта и целевой аудитории. Задание: определить оптимальный вид документа, его структуру и стиль изложения, обосновать выбор.

ДЕНЬ 2

Средства, методы и приёмы создания технических текстов:

• Назначение технической документации. Задачи пользователей при обращении к техническим документам.
• Метод сценариев: картирование опыта, дизайн, план и структура технического документа.
• Практика взаимодействия технического писателя и технического специалиста (предметного эксперта). Сбор и анализ информации.
• Аналитическая переработка текста в техническом писательстве.
• Упрощённый технический русский язык. Унификация текстовых формулировок.
• Терминология в технической документации: правила применения единых терминов.
• Лексические тонкости технического текста. Работа над ошибками.
• Техническое писательство и копирайтинг (статья, реклама). Техническое аннотирование и реферирование.

Практикум: Создание фрагмента технического документа (руководства пользователя или инструкции) по заданному описанию продукта. Применение метода сценариев. Редактирование текста с использованием упрощённого технического русского языка.

Информационный дизайн и визуализация технических документов:

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

Практикум: Разработка макета страницы технического документа с размещением текстовых и графических элементов. Создание иллюстрации (схемы или рисунка) для пояснения технического описания.

ДЕНЬ 3

Системы стандартов документирования (ЕСКД, ЕСПД, ЕСТД):

• Назначение и классификация систем стандартов документирования.
• Единая система конструкторской документации (ЕСКД): общая характеристика, структура, основные стандарты. Требования к выполнению текстовых документов.
• Единая система программной документации (ЕСПД): назначение, стадии разработки программ, виды документов.
• Единая система технологической документации (ЕСТД): виды технологической документации, требования к оформлению.
• Система стандартов по информации, библиотечному и издательскому делу (СИБИД): общая характеристика.
• Унификация, стандартизация и нормоконтроль документирования.
• Отечественные и зарубежные стандарты в области системной и программной инженерии.

Деловая игра: «Нормоконтроль технического документа» – слушателям предоставляется фрагмент технического документа с намеренными нарушениями требований систем стандартизации. Задание: выявить все несоответствия, классифицировать их и предложить корректные варианты оформления.

Разработка эксплуатационной документации:

• Нормативные требования к содержанию и оформлению эксплуатационной технической документации.
• Структура документирования и виды документов на предприятии.
• Разработка технических условий (ТУ): структура, содержание, порядок согласования и утверждения.
• Разработка руководств по технической эксплуатации (РЭ): состав разделов, требования к содержанию.
• Разработка регламентов технического обслуживания (РТО).
• Разработка паспортов изделий и формуляров.
• Особенности разработки документации на программные продукты.

Практикум: Разработка структуры и содержания руководства по эксплуатации для заданного изделия (или программного продукта). Составление перечня разделов и определение требований к каждому из них.

ДЕНЬ 4

Программные инструменты технического писателя:

• Обзор современных программных средств для создания технической документации.
• Текстовые редакторы и издательские системы: возможности и области применения.
• Средства для создания графических иллюстраций: векторная и растровая графика, скриншоты, схемы.
• Системы управления документацией и совместной работы.
• Инструменты для автоматизации документирования (DITA, XML, Markdown).
• Использование систем контроля версий для документирования.
• Современные тенденции: использование искусственного интеллекта для создания и редактирования технической документации.

Практикум: Работа с программным инструментом для создания технической документации (по выбору преподавателя). Создание документа с использованием шаблонов, вставка иллюстраций, экспорт в требуемый формат.

Организация работы технического писателя и управление документацией:

• Организация рабочего процесса технического писателя. Планирование и контроль сроков выполнения задач.
• Взаимодействие с разработчиками, технологами, конструкторами, службой качества и другими подразделениями.
• Сбор и анализ исходных данных для разработки документации.
• Оценка трудозатрат на создание комплекта технической документации.
• Управление версиями и актуализация документации.
• Внедрение системы управления документацией на предприятии.
• Этика взаимоотношений с разработчиками и заказчиками документации.

Деловая игра: «Разработка регламента взаимодействия технического писателя с подразделениями предприятия» – слушателям предлагается описание структуры предприятия и существующих бизнес-процессов. Задание: разработать регламент взаимодействия технического писателя с конструкторским, технологическим и ИТ-подразделениями при создании документации на новое изделие.

Подведение итогов: Пример классификатора несоответствий, выявляемых при разработке и оформлении технической документации, рекомендации по их устранению и предотвращению.