Инженер по документированию
Перейти к навигации
Перейти к поиску
Создание и внедрение средств разработки технической документации.
Код: F. Уровень квалификации: 7.
Возможные наименования должностей:
- Инженер по документированию;
- Программист.
| Требования к образованию и обучению | Высшее образование – специалитет, магистратура |
|---|---|
| Требования к опыту практической работы |
Не менее одного года в области разработки и настройки программных средств или Не менее одного года в области разработки и сопровождении крупных комплектов технической документации в качестве технического писателя |
| Особые условия допуска к работе | – |
| Другие характеристики | Рекомендуется дополнительное профессиональное образование – программы повышения квалификации по профилю деятельности |
| Наименование документа | Код | Наименование базовой группы, должности (профессии) или специальности |
|---|---|---|
| ОКЗ | 2519 | Разработчики и аналитики программного обеспечения и приложений, не входящие в другие группы |
| ЕКС | - | Инженер-программист |
| ОКПДТР | 22824 | Инженер-программист |
| ОКСО | 2.09.00.00 | Информатика и вычислительная техника |
| 2.27.00.00 | Управление в технических системах |
1. Разработка информационной архитектуры контента технической документации и ее совершенствование
Код: F/01.7.
Уровень (подуровень) квалификации: 7.
| Трудовые действия | Выяснение состава, структуры, содержания, оформления и др. свойств выпускаемых (планируемых к выпуску) информационных продуктов |
| Выяснение реального и/или желаемого порядка создания выпускаемых (планируемых к выпуску) информационных продуктов | |
| Составление требований к информационной архитектуре и их согласование с заинтересованными лицами (руководителем, вовлеченными смежными подразделениями и др.) | |
| Выработка информационных типов, определяющих содержание и внутреннюю структуру разделов контента технической документации | |
| Выработка структуры метаданных разделов контента технической документации и логики присвоения метаданных разделам | |
| Выработка структуры хранилища разделов контента технической документации и логики их размещения в хранилище | |
| Выработка формализованной структуры информационных продуктов, выпуск которых предусмотрен информационной архитектурой | |
| Выработка логики автоматического формирования и верстки информационных продуктов из разделов контента технической документации | |
| Определение порядка управления версиями разделов контента технической документации и информационных продуктов | |
| Проверка выработанной информационной архитектуры с помощью реалистичного примера, прототипа, пилотного проекта | |
| Согласование выработанной информационной архитектуры со всеми заинтересованными лицами (руководителем, вовлеченными смежными подразделениями, разработчиком и др.) | |
| Составление требований к реализации выработанной информационной архитектуры с помощью средств автоматизации документирования | |
| Составление описания информационной архитектуры и ее разъяснение разработчикам технической документации | |
| Разработка средств автоматизированного контроля соблюдения информационной архитектуры | |
| Текущий контроль соблюдения информационной архитектуры разработчиками технической документации | |
| Необходимые умения | Исследовать информационные продукты, выявлять структурные, смысловые, визуальные сходства и различия между ними |
| Вырабатывать информационные типы разделов контента технической документации, составлять их формализованные описания | |
| Вырабатывать структуры данных (метаданных), составлять их формализованные описания | |
| Вырабатывать структуры информационных продуктов, составлять их формализованные описания | |
| Составлять формализованные описания логики формирования информационных продуктов из разделов контента | |
| Описывать формализованные требования к программным средствам и автоматизированным системам | |
| Проводить презентации, адресованные техническим специалистам, техническим руководителям и другими вовлеченным лицам | |
| Необходимые знания | Основы современной автоматизации документирования: принцип единого источника, компонентный подход, информационные типы |
| Понятие информационного типа, способы структурирования разделов, требования к формализованному описанию информационного типа | |
| Основные способы реализации информационной архитектуры: карты документов, профилирование, различные типы ссылок | |
| Современные средства автоматизации документирования, их основные возможности в части поддержки информационной архитектуры | |
| Представление о системах управления версиями: реализуемая ими логика работы, основные функциональные возможности | |
| Основы управления требованиями к программным средствам и автоматизированным системам | |
| Базовые знания программирования | |
| Другие характеристики | - |
2. Проектирование процессов автоматизированной разработки технической документации
Код: F/02.7.
Уровень (подуровень) квалификации: 7.
| Трудовые действия | Изучение практики документирования в других организациях |
| Разработка бизнес-процессов документирования в организации | |
| Согласование бизнес-процессов с заинтересованными лицами | |
| Разработка регламентов и инструкций по выполнению бизнес-процессов | |
| Необходимые умения | Описание бизнес-процессов в графических форме: схем, диаграмм |
| Описание бизнес-процессов в текстовой форме | |
| Необходимые знания | Основные стандарты на процессы разработки в сфере ИТ |
| Взаимосвязь процессов документирования с процессами разработки | |
| Возможности современных средств автоматизированной разработки технической документации |
3. Выбор средств разработки технической документации, их развертывание и настройка
Код: F/03.7.
Уровень (подуровень) квалификации: 7.
| Трудовые действия | Изучение современных средств автоматизированной разработки и форматов технической документации |
| Изучение практики автоматизированной разработки технической документации в других организациях | |
| Обмен опытом с другими специалистами на выставках семинарах, конференциях | |
| Разработка технического задания на систему автоматизированного документирования, реализующей требуемую информационную архитектуру | |
| Поиск и выбор средств автоматизированной разработки технической документации для требуемой информационной архитектуры | |
| Проектирование системы автоматизированного документирования, реализующей требуемую информационную архитектуру | |
| Развертывание средств автоматизированной разработки технической документации в организации и их базовая настройка | |
| Создание шаблонов разделов контента технической документации в соответствии с требуемой информационной архитектурой | |
| Создание хранилища разделов контента технической документации в соответствии с требуемой информационной архитектурой | |
| Создание шаблонов информационных продуктов в соответствии с требуемой информационной архитектурой | |
| Создание сценариев и стилей для выпуска информационных продуктов в соответствии с требуемой информационной архитектурой | |
| Загрузка унаследованного контента технической документации в систему автоматизированного документирования | |
| Испытания системы автоматизированного документирования на материале пилотного проекта | |
| Составление руководств и технологических инструкций для разработчиков технической документации | |
| Выбор средств защиты информационных продуктов от внесения несанкционированных изменений третьими лицами | |
| Необходимые умения | Получать и анализировать информацию о программных средствах, доступных на рынке или в мире открытого программного кода |
| Общаться с поставщиками программных средств и техническими специалистами по ним устно и письменно, в т. ч. на английском языке | |
| Разворачивать тестовые стенды и исследовать на них возможности программных средств | |
| Исследовать потребности будущих пользователей и разрабатывать требования к автоматизированным системам | |
| Проектировать несложные автоматизированные системы масштаба рабочей группы | |
| Проводить испытания несложных автоматизированных систем масштаба рабочей группы | |
| Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленных задач | |
| Разрабатывать сценарии автоматизации на предназначенных для этого языках программирования | |
| Разрабатывать стили оформления информационных продуктов на предназначенных для этого языках разметки | |
| Конвертировать контент технической документации из исходных форматов в структурированные форматы | |
| Разрабатывать руководства и технологические инструкции для пользователей автоматизированных систем | |
| Необходимые знания | Основы современной автоматизации документирования: принцип единого источника, компонентный подход, информационные типы |
| Понятие информационного типа, способы структурирования разделов, требования к формализованному описанию информационного типа | |
| Основные способы реализации информационной архитектуры: карты документов, профилирование, различные типы ссылок | |
| Современные средства автоматизации документирования, их основные возможности в части поддержки информационной архитектуры | |
| Профильные издания, интернет-ресурсы, конференции, посвященные, в т. ч., автоматизации разработки технической документации | |
| Представление о системах управления версиями: реализуемая ими логика работы, основные функциональные возможности | |
| Порядок создания автоматизированной системы | |
| Основы управления требованиями к программным средствам и автоматизированным системам | |
| Основные принципы проектирования автоматизированных систем | |
| Основные подходы к проведению испытаний автоматизированных систем | |
| Основные языки программирования предназначенные для разработки скриптов автоматизации | |
| Основные языки разметки, предназначенные для написания разработки стилей оформления документов | |
| Основные языки разметки структурированного контента, в том числе, теговые и легковесные языки разметки | |
| Популярные программные средства, предназначенные для конвертации контента из одного формата в другой | |
| Способы и программные средства защиты документов разного формата от внесения несанкционированных изменений | |
| Другие характеристики | - |
4. Выбор средств подготовки технической документации к интернационализации и локализации, а также последующему переводу, их развертывание и настройка
Код: F/04.7.
Уровень (подуровень) квалификации: 7.
| Трудовые действия | Исследование сценариев использования средств подготовки технической документации к локализации и последующему переводу и выбор на основе анализа подходящих инструментов |
| Обмен опытом с другими специалистами на выставках семинарах, конференциях | |
| Проработка сценариев использования средств подготовки технической документации к локализации и последующему переводу и формирование требований к дополнительной автоматизации | |
| Развертывание средств подготовки технической документации к локализации и последующему переводу в организации и их базовая настройка, настройка интеграции с системами разработки технической документации | |
| Верификация и валидация развернутых средств подготовки технической документации к локализации и последующему переводу, а также интеграции с системами разработки технической документации и системами локализации и переводов | |
| Составление руководств и технологических инструкций для разработчиков технической документации, обучение специалистов | |
| Эксплуатация и сопровождение средств подготовки технической документации к локализации и последующему переводу | |
| Необходимые умения | Находить и анализировать информацию о программных средствах, доступных на рынке или в мире открытого программного кода |
| Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленных задач | |
| Общаться с поставщиками программных средств и техническими специалистами по ним устно и письменно, в т. ч. на английском языке | |
| Разворачивать тестовые стенды и исследовать на них возможности программных средств, пилотировать использование на реальном контенте | |
| Исследовать потребности будущих пользователей и разрабатывать требования к автоматизированным системам и сценарии из применения | |
| Разрабатывать рабочие инструкции, правила, памятки по работе с программными средствами, вести базу знаний по особенностям работы программных средств и надстроек к ним | |
| Необходимые знания | Основы современной автоматизации документирования: принцип единого источника, компонентный подход, информационные типы |
| Понятие информационного типа, способы структурирования разделов, требования к формализованному описанию информационного типа | |
| Современные инструменты разработки технической документации и принципы их работы | |
| Современные инструменты локализации контента, особенности их работы и варианты интеграции с системами и инструментами разработки технической документации | |
| Особенности локализации под разные регионы и языки: валюта, цены, единицы измерения, географические названия, номера телефонов, графические элементы, шрифты, кодировки и другое | |
| Профильные издания, интернет-ресурсы, конференции, посвященные, в т. ч., автоматизации локализации и подготовке технической документации к переводу | |
| Основы управления требованиями к программным средствам и автоматизированным системам | |
| Основные принципы проектирования автоматизированных систем | |
| Основные подходы к проведению испытаний автоматизированных систем | |
| Основные языки разметки, предназначенные для написания разработки стилей оформления документов | |
| Основные языки разметки структурированного контента, в том числе, теговые и легковесные языки разметки | |
| Популярные программные средства, предназначенные для преобразования контента из одного формата в другой | |
| Основные языки программирования предназначенные для разработки скриптов автоматизации | |
| Другие характеристики | - |
5. Разработка автоматических тестов для проверки технической документации
Код: F/05.7.
Уровень (подуровень) квалификации: 7.
| Трудовые действия | Разработка сценариев автоматического тестирования (верификации) на популярных скриптовых языках |
| Разработка правил и внедрение автоматического тестирования (верификации) на соответствие текста правилам форматирования, терминологии, стилистики, структурирования (настройка статических анализаторов) | |
| Разработка и внедрение проверок корректности примеров кода | |
| Разработка и внедрение проверок соответствия документации программному коду | |
| Разработка и внедрение проверок актуальности скриншотов и/или автоматической съемки скриншотов при помощи инструментов для автоматизации действий веб-браузеров | |
| Получение необходимой информации от отдела тестирования в вопросах автоматического тестирования (верификации) технической документации | |
| Необходимые умения | Использование средств автоматического тестирования (верификации) и средств проверки синтаксиса относительно правил (статических анализаторов) |
| Разработка сценариев автоматического тестирования (верификации) на популярных скриптовых языках | |
| Встраивание проверок в принятую в компании систему непрерывной интеграции и развертывания приложений | |
| Необходимые знания | Принципы и практики непрерывной интеграции и развертывания приложений |
| Основные современные подходы к автоматическому тестированию (верификации) приложений | |
| Инструментальные средства автоматического тестирования (верификации) приложений, инструменты автоматизации действий браузеров, инструменты проверки синтаксиса относительно правил (статические анализаторы), их функциональные возможности | |
| Другие характеристики | - |
6. Инструктирование технических писателей по использованию средств разработки технической документации
Код: F/06.7.
Уровень (подуровень) квалификации: 7.
| Трудовые действия | Составление перечня средств разработки документации, используемых в организации |
| Создание обучающих материалов и инструкций по использованию средств разработки технической документации | |
| Разработка критериев оценки усвоения знаний разработчиками технических материалов | |
| Публикация обучающих материалов и инструкций во внутренней базе знаний | |
| Организация обучающих семинаров для разработчиков технической документации | |
| Необходимые умения | Разрабатывать обучающие материалы и инструкции для средств разработки учебных материалов |
| Изучать документацию к средствам разработки учебных материалов и использовать полученную информацию в разработке обучающих материалов и инструкций | |
| Оценивать качество освоения средств разработки технической документации у разработчиков технической документации | |
| Организовывать обучающие семинары по обучению и инструктированию разработчиков технической документации | |
| Публиковать обучающие материалы и инструкции во внутренней базе знаний | |
| Необходимые знания | Принципы работы средств разработки технической документации |
| Основные методологические подходы к разработке обучающих материалов | |
| Методология оценки качества усвоения материала | |
| Инструменты: средства разработки технической документации, текстовые редакторы, системы хранения баз знаний, средства разработки графических материалов, средства разработки слайд-шоу | |
| Другие характеристики | - |