Технический писатель (специалист по технической документации в области информационных технологий)

Возможные наименования должностей, профессий

• Технический писатель – стажер (специалист по технической документации в информационных технологиях – стажер)
• Младший технический писатель (младший специалист по технической документации в информационных технологиях)
• Оформитель технической документации

Требования к образованию и обучению

• Среднее профессиональное образование – программы подготовки специалистов среднего звена

Требования к опыту практической работы

• –

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

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

Необходимые умения

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

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Работать в современном текстовом процессоре
• Создавать, настраивать, применять стили в документе с помощью текстового процессора
• Создавать графические схемы, получать снимки экрана, включать рисунки в технический документ и оформлять их
• Создавать информационно-поисковый аппарат документа с помощью текстового процессора
• Создавать в тексте якоря и гипертекстовые ссылки, оформлять подписи к гипертекстовым ссылкам
• Оформлять рисунки, в том числе снимки экрана, оформлять подписи к ним в соответствии с используемым стандартом

Необходимые знания

• Основные возможности современных текстовых процессоров
• Основные стандарты оформления текстовых документов
• Основные способы работы с векторной и растровой графикой, способы включения рисунков в документ, правила оформления рисунков
• Основы типографики
• Информационно-справочный и информационно-поисковый аппарат документа
• Основные графические форматы и их особенности

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Создание (изменение, удаление) статей в используемой системе управления контентом или базе знаний
• Копирование текста из технических документов и его приведение в соответствие требованиям системы управления контентом или базы знаний
• Поиск контента, который повторяется в базе знаний или системе управления контентом, устранение повторов
• Приведение иллюстраций (рисунков, таблиц, листингов) в соответствие требованиям системы управления контентом или базы знаний
• Создание элементов информационно-поискового аппарата в системе управления контентом или базе знаний
• Настройка перекрестных ссылок между разделами и логическими частями контента
• Формирование набора смысловых меток (тегов) и назначение их разделам и логическим частям контента

Необходимые умения

• Создавать, изменять, удалять статьи в используемой вики-системе или базе знаний
• Извлекать текст из технических документов в формате текстового процессора и перемещать его в систему управления контентом и или базу знаний
• Извлекать из документов в формате текстового процессора изображения и преобразовывать их в графические файлы нужного формата
• Выявлять в базе знаний или системе управления контентом неоправданные повторы контента и устранять их
• Создавать в используемой системе управления контентом или базе знаний элементы информационно-поискового аппарата

Необходимые знания

• Вики-системы, принципы их функционирования с точки зрения автора и читателя в объеме, необходимом для выполнения трудовой функции
• Принцип единого источника и способы многократного использования контента в информационных продуктах в объеме, необходимом для выполнения трудовой функции
• Языки разметки, теговые языки разметки и легкие текстовые форматы
• Перечень наиболее распространенных средств информационно-поискового аппарата, их назначение, сильные и слабые стороны, способы применения: оглавления, теги, указатели, перекрестные ссылки в объеме, необходимом для выполнения трудовой функции
• Основные графические форматы в объеме, необходимом для выполнения трудовой функции, разница между растровыми и векторными форматами

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Выбор, установка, настройка программных средств для ввода и структурирования контента с использованием заданного языка разметки
• Подготовка структуры папок (директорий) и файлов для размещения структурированного контента в используемой среде хранения
• Ввод либо копирование и последующее структурирование контента с использованием заданного языка разметки
• Подготовка рисунков для включения в контент, структурированный с использованием заданного языка разметки
• Проверка валидности контента, структурированного с использованием заданного языка разметки

Необходимые умения

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

Необходимые знания

• Языки разметки, основные типы языков разметки (теговые, легковесные) и их особенности в объеме, необходимом для выполнения трудовой функции
• Синтаксис языка разметки HTML, его основные элементы и атрибуты
• Язык описания стилей CSS, его основные конструкции и селекторы, предусмотренные в нем
• Основные принципы языка XML и правила, общие для всех языков разметки, представляющих собой его приложения
• Основные разновидности легковесных языков разметки, их возможности и распространенные варианты
• Источники официальных спецификаций языков разметки, способы их поиска в информационно-телекоммуникационной сети «Интернет»
• Основные форматы графических файлов и особенности их использования
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые редакторы с поддержкой набора исходного кода, программы-конверторы, XML-редакторы, программы и сервисы валидации веб-документов в форматах HTML и XML

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

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

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Работать с системой управления задачами и/или системой контроля версий
• Логически группировать изменения на новые, обновленные и исправленные ошибки
• Выбирать стиль описания изменений
• Описывать изменения простым языком, понятным пользователю
• Иллюстрировать изменения с помощью диаграмм и снимков экрана

Необходимые знания

• Системы управления задачами и системы контроля версий: поиск и выделение нужной информации
• Особенности, присущие стилю текстовых документов компании, требования руководства по стилю
• Основные виды форматирования
• Каналы распространения списка изменений и их особенности (рассылка, магазин приложений, корпоративный блог)

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Настройка параметров публикации информационных продуктов в соответствии с полученными указаниями
• Запуск процесса публикации информационных продуктов с помощью используемого средства публикации
• Поиск причин ошибок публикации информационных продуктов, их устранение и перезапуск публикации
• Размещение опубликованных информационных продуктов на внутренних или внешних ресурсах организации согласно регламенту

Необходимые умения

• Настраивать параметры публикации информационных продуктов в используемых программных средствах
• Запускать процесс публикации информационных продуктов в используемых программных средствах
• Читать и понимать лог-файлы, формируемые программными средствами публикации информационных продуктов
• Исправлять ошибки в контенте, приводящие к ошибкам при публикации информационных продуктов

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Технический писатель (специалист по технической документации в информационных технологиях)
• Разработчик технической документации

Требования к образованию и обучению

• Высшее образование – бакалавриат

Требования к опыту практической работы

• –

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

• Изучение целевой аудитории документа, выяснение ее задач, потребностей в информации, уровня подготовки
• Изучение основ предметной области
• Изучение темы технического документа с точки зрения целевой аудитории и с учетом ее информационных потребностей
• Составление подробного плана технического документа и его согласование с экспертами
• Составление текста документа, подготовка иллюстраций
• Составление и вычитка строк интерфейса пользователя программного средства
• Согласование технического документа с экспертами
• Преобразование технического документа в требуемый выходной формат

Необходимые умения

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

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Сбор исходных сведений и материалов
• Согласование с экспертами состава сведений, приводимых в документе, и уровня подробности их изложения
• Компоновка и оформление текста технического документа
• Разработка структуры технического документа и ее согласование с экспертами

Необходимые умения

• Опрашивать экспертов и анализировать полученные сведения
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
• Оценивать количество рабочих часов, необходимых для выполнения полученного задания
• Составлять календарный план выполнения полученного задания
• Применять требования используемых в проекте стандартов с учетом особенностей данного проекта
• Подготавливать графические схемы
• Компоновать технический документ на основе заданных источников

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Выбор средств создания графической схемы и формата файла для ее хранения
• Создание графической схемы по заданному описанию или эскизу
• Согласование графической схемы с экспертами, внесение в графическую схему исправлений по замечаниям экспертов
• Передача заказчику файла графической схемы и исходных материалов, использованных при ее создании

Необходимые умения

• Создавать информативные графические схемы
• Подготавливать графические схемы с помощью инструментов, предусмотренных в наиболее распространенных пакетах офисных приложений
• Подготавливать графические схемы с помощью специализированных визуальных редакторов
• Подготавливать графические схемы с помощью программ-генераторов, поддерживающих языки разметки, предназначенные для описания графических схем
• Преобразовывать файлы графических схем из векторных форматов в растровые форматы
• Отображать алгоритм или процесс с помощью блок-схемы
• Отображать логическую структуру базы данных с помощью диаграммы «сущность – связь»
• Отображать структуру компьютерной сети или системы на графической схеме

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение основ предметной области
• Изучение продукта с точки зрения целевой аудитории и с учетом ее потребностей, определение ключевых сценариев использования, важных характеристик продукта и его отличий от аналогов
• Изучение нормативных требований об информации, обязательной к нанесению на корпус устройства или упаковку продукта
• Сбор информации о физических размерах упаковки или корпуса, особенностях нанесения текста, объеме текста, который можно разместить, и других ограничениях
• Разработка текста, отвечающего нормативным требованиям и внутренним стандартам
• Согласование текста с экспертами
• Передача текста на верстку и сопровождение верстки: корректорская правка и литературное редактирование макетов

Необходимые умения

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

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Проверка корректности, непротиворечивости, полноты, ясности и достоверности излагаемых сведений
• Проверка соответствия стиля изложения используемым в компании стандартам (руководству по стилю, глоссарию, голосу бренда)
• Составление замечаний к содержанию и их обсуждение с авторами

Необходимые умения

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

Необходимые знания

• Особенности стилистики технического текста на используемом языке
• Распространенные стилистические ошибки, способы их исправления
• Распространенные логические ошибки и дефекты текста и способы их исправления

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Сбор исходных данных для оценки качества технической документации
• Расчет значений заданных метрик качества технической документации
• Составление отчета об оценке качества технической документации

Необходимые умения

• Работать с текстом как с объектом исследования
• Использовать электронные таблицы для статистических вычислений
• Составлять аналитические отчеты на основе данных статистики

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Старший технический писатель (специалист по технической документации в информационных технологиях)
• Старший разработчик технической документации

Требования к образованию и обучению

• Высшее образование – бакалавриат

Требования к опыту практической работы

• Не менее одного года в области написания научных или технических статей

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

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

Необходимые умения

• Описывать продукт и его технические особенности с точки зрения менеджеров и разработчиков
• Работать в веб-редакторе или вики-разметке
• Повышать вероятность вхождения статей в поисковую выдачу по релевантным запросам с помощью организации содержания статей в соответствии с принципами поисковой оптимизации и улучшения навигации
• Обобщать часто используемые элементы контента и создавать на их основе шаблоны статей
• Отслеживать аналитику и статистику посещений, взаимодействий, историю поиска и на их основе улучшать содержание и структуру статей

Необходимые знания

• Лучшие образцы баз знаний по продуктам из той же отрасли экономики
• Принципы поисковой оптимизации
• Принципы информационной архитектуры
• Понятия вики-системы и базы знаний, основные принципы функционирования вики-систем; перечень наиболее распространенных современных программных средств для создания и поддержки вики-систем, их основные функциональные возможности и технические характеристики

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение потребностей сотрудников в специфичных для организации знаниях, необходимых для выполнения рабочих обязанностей в технологической среде организации
• Выбор, установка и настройка программных средств для фиксации и распространения знаний в организации
• Создание инструкций, чек-листов и документации с описанием процессов и критических знаний компании
• Организация встреч и мероприятий по обмену знаниями, организация деятельности профессиональных объединений и сообществ
• Получение от экспертов корпоративных знаний и их обработка
• Оказание помощи специалистам отделов управления персоналом в составлении планов адаптации новых сотрудников и обучающих курсов
• Получение от экспертов необходимой информации по формализации знаний и согласование с ними текста технической документации

Необходимые умения

• Фиксировать выявленные у экспертов знания в виде технических документов, видеолекций или презентаций
• Строить карты знаний и матрицы компетенций в организации
• Следить за сообщениями, публикуемыми в корпоративных каналах коммуникации и источниках знаний, выявлять пробелов в корпоративных знаниях и планировать их устранение
• Получать необходимую информацию от отделов внутренних коммуникаций, управления персоналом и обучения для вовлечения сотрудников в передачу знаний и для организации доставки им информации
• Организовывать способы и каналы передачи знаний внутри организации

Необходимые знания

• Подходы к обмену знаниями в организации, практикуемые лидерами индустрии, образцы применения этих подходов
• Перечень наиболее распространенных современных систем управления знаниями
• Понятие цикла знаний в организации, подходы к управлению знаниями и построению систем управления знаниями, виды знаний и их отличия
• Принципы и методики построения карт знаний в организациях

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Разрабатывать методические материалы в соответствии с принятыми требованиями и стандартами
• Валидировать разработанные методические материалы
• Использовать инструменты разработки методических материалов и графических схем
• Публиковать методические материалы в заданном формате в электронной системе обучения
• Подготавливать графические схемы и иллюстрации
• Согласовывать методические материалы с экспертами
• Разрабатывать сценарии для обучающих видеороликов
• Разрабатывать проверочные вопросы

Необходимые знания

• Методические основы электронного обучения
• Основные подходы к формулированию проверочных вопросов
• Основные подходы к разработке обучающих видеороликов
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, средства подготовки графических схем, средства подготовки снимков экрана, средства администрирования электронных систем обучения

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение основ предметной области
• Изучение продукта или технологии
• Разработка концепции описания продукта или технологии
• Согласование концепции описания продукта или технологии с экспертами
• Составление текста описания продукта или технологии, подготовка иллюстраций
• Согласование текста описания продукта или технологии с экспертами
• Передача текста описания продукта или технологии на публикацию, проверка корректности опубликованных материалов

Необходимые умения

• Опрашивать экспертов и анализировать полученные сведения
• Исследовать открытые источники для сбора информации о предметной области
• Раскрывать заданную тему с заданной точки зрения, соблюдая требования к объему и к стилю изложения
• Составлять информационный текст, правильный в литературном, грамматическом и техническом отношении
• Компоновать технический документ на основе заданных источников
• Готовить иллюстрации
• Получать замечания экспертов и вносить исправления в описание продукта или технологии
• Оценивать количество рабочих часов, необходимых для выполнения полученного задания

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Старший технический писатель (специалист по технической документации в информационных технологиях)
• Старший разработчик технической документации
• Инженер
• Программист

Требования к образованию и обучению

• Высшее образование – бакалавриат

Требования к опыту практической работы

• Не менее одного года в области разработки продукции в сфере информационных технологий в качестве конструктора или программиста

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

• Опрос экспертов в предметной области
• Изучение технической документации и научной литературы
• Определение способа и достаточного объема описания информационной или математической модели
• Составление описания информационной или математической модели
• Согласование описания информационной или математической модели с экспертами

Необходимые умения

• Опрашивать экспертов и анализировать полученные сведения
• Исследовать программные средства на тестовом стенде
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
• Исследовать научно-техническую литературу, извлекать из нее сведения, необходимые для решения поставленной задачи
• Составлять обобщенные описания явлений, процессов, объектов управления без использования математического аппарата и специальной терминологии
• Использовать математический аппарат для описания явлений, процессов, объектов управления
• Описывать бизнес-процессы с помощью графических нотаций

Необходимые знания

• Основы высшей математики в объеме программы технического вуза
• Основы теории систем и системного анализа
• Перечень наиболее распространенных современных методологий описания бизнес-процессов; основные принципы, на которых построены эти методологии
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: средства для набора текста (текстовый процессор, XML-редактор), средства подготовки графических схем, средства визуального описания бизнес-процессов

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение целевой аудитории технической документации, выяснение ее задач, потребностей в информации, уровня подготовки
• Изучение темы информационного продукта с точки зрения целевой аудитории и с учетом ее информационных потребностей
• Составление подробного плана информационного продукта и его согласование с экспертами
• Составление текста информационного продукта, подготовка иллюстраций
• Составление и отладка программ-примеров
• Согласование информационного продукта с экспертами
• Преобразование информационного продукта в требуемый выходной формат

Необходимые умения

• Опрашивать экспертов и анализировать полученные сведения
• Исследовать программные средства на тестовом стенде
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
• Осваивать языки программирования, интерфейсы прикладного программирования, протоколы обмена данными
• Составлять и отлаживать несложные программы и тестовые примеры
• Разрабатывать требования к информационному продукту, в том числе техническому документу
• Оценивать количество рабочих часов, необходимых для выполнения полученного задания
• Составлять календарный план выполнения полученного задания
• Разрабатывать технические задания и спецификации требований
• Разрабатывать описание системной или программной архитектуры
• Разрабатывать руководства программиста, справочники по интерфейсам прикладного программирования
• Разрабатывать описание структуры набора данных
• Разрабатывать руководство по языку программирования
• Разрабатывать инструкцию по монтажу, пуску, регулированию и обкатке технического средства или аппаратно-программного комплекса
• Разрабатывать руководство системного администратора
• Получать замечания экспертов и вносить исправления в техническую документацию
• Преобразовывать информационный продукт в различные выходные форматы (PDF, HTML, формат электронной справки)

Необходимые знания

• Современное состояние индустрии информационных технологий, основные подходы и тенденции
• Перечень наиболее распространенных современных аппаратных платформ, сферы их применения, основные технические характеристики
• Перечень наиболее распространенных современных операционных систем, сферы их применения, основные технические характеристики
• Принципы функционирования современных телекоммуникационных сетей
• Наиболее распространенные современные архитектурные решения, применяемые при проектировании программных средств и компьютерных систем различного назначения
• Перечень наиболее часто применяемых современных стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
• Перечень наиболее распространенных современных методологий разработки программ и систем, основные принципы, заложенные в эти методологии
• Программирование в объеме программы технического вуза
• Основные типы документов, адресованных разработчикам продукции в сфере информационных технологий, особенности этих документов
• Общие требования к структуре информационного продукта, в том числе технического документа
• Способы изложения материала, наиболее распространенные в современной документации разработчика
• Информационно-справочный и информационно-поисковый аппарат документа
• Основные виды авторской разметки текста технической документации
• Примеры документации разработчика, которые в профессиональной среде специалистов по информационным технологиям считаются наиболее удачными
• Основные стандарты оформления технической документации
• Основные электронные форматы информационных продуктов и особенности их использования
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: средства для набора текста (текстовый процессор, XML-редактор), средства автоматизированного документирования исходного кода, текстовые редакторы с поддержкой набора исходного кода, средства подготовки снимков экрана, средства преобразования документов в выходные форматы, тестовый стенд

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение целевой аудитории технической документации сетевых инфраструктур и развертывания порядка многокомпонентных приложений, выяснение ее задач, потребностей в информации, уровня подготовки
• Изучение темы технической документации с точки зрения целевой аудитории и с учетом ее информационных потребностей
• Составление подробного плана технической документации и его согласование с экспертами
• Составление текстового контента, подготовка иллюстраций
• Составление и отладка программ-примеров
• Согласование технической документации с экспертами
• Публикация контента технической документации в виде информационных продуктов, отвечающих заданным требованиям

Необходимые умения

• Опрашивать экспертов и анализировать полученные сведения
• Исследовать элементы инфраструктуры на тестовом стенде
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
• Осваивать языки программирования, программное обеспечение управления конфигурациями, средства сборки, развертывания и управления приложениями
• Составлять и отлаживать несложные программы и тестовые примеры
• Разрабатывать требования к информационному продукту
• Оценивать количество рабочих часов, необходимых для выполнения полученного задания
• Составлять календарный план выполнения полученного задания
• Разрабатывать описание системной или программной архитектуры
• Разрабатывать инструкцию по монтажу, пуску, регулированию и обкатке технического средства или аппаратно-программного комплекса
• Получать замечания экспертов и вносить исправления в документ
• Преобразовывать контент в различные выходные форматы (PDF, форматы текстовых процессоров, HTML, форматы электронной справки, форматы электронных книг)

Необходимые знания

• Современное состояние индустрии информационных технологий, основные подходы и тенденции
• Перечень наиболее распространенных современных аппаратных платформ, сферы их применения, основные технические характеристики
• Перечень наиболее распространенных современных операционных систем, сферы их применения, основные технические характеристики
• Принципы функционирования современных телекоммуникационных сетей
• Наиболее распространенные современные архитектурные решения, применяемые при проектировании программных средств и компьютерных систем различного назначения
• Перечень наиболее часто применяемых современных стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
• Перечень наиболее распространенных современных методологий разработки программ и систем, основные принципы, заложенные в эти методологии
• Программирование в объеме программы технического вуза
• Основные типы документов, адресованных специалистам по инфраструктуре информационных технологий
• Общие требования к структуре технического документа
• Способы изложения материала, наиболее распространенные в современной документации разработчика
• Информационно-справочный и информационно-поисковый аппарат документа
• Основные виды авторской разметки текста технической документации
• Примеры технической документации, которые в профессиональной среде специалистов по инфраструктуре информационных технологий считаются наиболее удачными
• Основные стандарты оформления технической документации
• Основные электронные форматы информационных продуктов и особенности их использования
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: средства для набора текста (текстовый процессор, XML-редактор), средства автоматизированного документирования, текстовые редакторы с поддержкой набора исходного кода, средства подготовки снимков экрана, средства преобразования документов в выходные форматы, тестовый стенд

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение целевой аудитории технической документации на программные интерфейсы (далее – API) и средства разработки приложений (далее – SDK)
• Изучение темы технической документации с точки зрения целевой аудитории и с учетом ее информационных потребностей
• Составление подробного плана технической документации и его согласование с экспертами
• Создание описаний интерфейсов (API) и средств разработки приложений (SDK), составление технической документации, подготовка иллюстраций
• Настройка правил автоматической проверки документации на соответствие требованиям качества
• Составление и отладка программ-примеров
• Согласование технической документации с экспертами
• Публикация контента технической документации в виде информационных продуктов, отвечающих заданным требованиям

Необходимые умения

• Опрашивать экспертов и анализировать полученные сведения
• Исследовать API и SDK на тестовом стенде
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
• Осваивать языки программирования, интерфейсы прикладного программирования, протоколы обмена данными
• Составлять и отлаживать несложные программы и тестовые примеры
• Разрабатывать требования к информационному продукту
• Оценивать количество рабочих часов, необходимых для выполнения полученного задания
• Составлять календарный план выполнения полученного задания
• Получать замечания экспертов и вносить исправления в документ
• Преобразовывать технический документ в различные выходные форматы (PDF, форматы текстовых процессоров, HTML, форматы электронной справки, форматы электронных книг)

Необходимые знания

• Современное состояние индустрии информационных технологий, основные подходы и тенденции
• Перечень наиболее распространенных современных аппаратных платформ, сферы их применения, основные технические характеристики
• Перечень наиболее распространенных современных операционных систем, сферы их применения, основные технические характеристики
• Принципы функционирования современных телекоммуникационных сетей
• Наиболее распространенные современные архитектурные решения, применяемые при проектировании программных средств и компьютерных систем различного назначения
• Перечень наиболее часто применяемых современных стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
• Перечень наиболее распространенных современных методологий разработки программ и систем, основные принципы, заложенные в эти методологии
• Программирование в объеме программы технического вуза
• Основные типы документов, адресованных разработчикам продукции в сфере информационных технологий, особенности этих документов
• Общие требования к структуре технического документа
• Способы изложения материала, наиболее распространенные в современной документации разработчика
• Информационно-справочный и информационно-поисковый аппарат документа
• Основные виды авторской разметки текста технической документации
• Примеры документации API и SDK, которые в профессиональной среде специалистов по информационным технологиям считаются наиболее удачными
• Наиболее распространенные современные языки структурированного описания API и моделей данных
• Наиболее распространенные языки аннотирования программного кода, а также инструменты генерации описаний API и SDK
• Основные стандарты оформления технической документации
• Основные электронные форматы информационных продуктов и особенности их использования
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: средства для набора текста (текстовый процессор, XML-редактор), текстовые редакторы с поддержкой набора исходного кода, средства подготовки снимков экрана, средства генерации документации, средства преобразования документов в выходные форматы

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Разработка концепции технической статьи
• Согласование концепции технической статьи с экспертами
• Составление текста технической статьи, подготовка иллюстраций
• Согласование текста технической статьи с экспертами
• Сдача технической статьи в редакцию целевого средства массовой информации, работа с редактором

Необходимые умения

• Раскрывать заданную тему с заданной точки зрения, соблюдая требования к объему и к стилю изложения
• Сотрудничать со средствами массовой информации в качестве автора материалов научно-технической тематики
• Осуществлять литературное редактирование текста
• Компоновать технический документ на основе заданных источников
• Подготавливать графические схемы

Необходимые знания

• Жанровые особенности и стилистика технических текстов
• Основы редакционной работы в периодическом издании
• Основные характеристики аудитории и редакционной политики целевого средства массовой информации
• Методика работы над текстом, основы литературного редактирования
• Основные сведения о ситуации на целевом рынке
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, средства подготовки графических схем, средства подготовки снимков экрана

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Старший (ведущий) технический писатель (специалист по технической документации в информационных технологиях)
• Старший разработчик технической документации
• Руководитель группы разработки технической документации
• Архитектор контента

Требования к образованию и обучению

• Высшее образование – бакалавриат

Требования к опыту практической работы

• Не менее одного года техническим писателем

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

• Уточнение ожиданий заказчика от запланированной работы по документированию, оценка их реалистичности, корректировка в случае необходимости
• Изучение целевой аудитории документа, выяснение ее задач, потребностей в информации, уровня подготовки
• Изучение документируемой продукции с точки зрения всех целевых аудиторий и с учетом их информационных потребностей
• Разработка спецификации требований к комплекту технической документации
• Согласование спецификации требований к комплекту технической документации с заказчиком

Необходимые умения

• Проводить опросы экспертов и анализировать полученные сведения
• Исследовать программные средства на тестовом стенде
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
• Исследовать целевую аудиторию комплекта технической документации
• Разрабатывать требования к комплекту технической документации
• Разрабатывать требования к техническому документу
• Работать в системах управления требованиями

Необходимые знания

• Понятия «техническое средство», «программное средство», «комплекс», «система», содержание этих понятий, различия между ними
• Перечень наиболее часто применяемых современных стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
• Перечень наиболее распространенных современных методологий разработки программ и систем, основные принципы, заложенные в эти методологии
• Основные типы информационных продуктов, в том числе технических документов, и их особенности
• Практика документирования технических средств, программных средств, комплексов, систем
• Стандарты, содержащие требования к технической документации
• Основы управления требованиями
• Типовой состав требований к комплекту технической документации
• Типовой состав требований к техническому документу
• Общие требования к структуре технического документа
• Основные электронные форматы информационных продуктов и их особенности

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Формирование коллектива разработчиков комплекта технической документации
• Постановка задачи членам коллектива разработчиков комплекта технической документации
• Организация деятельности коллектива разработчиков комплекта технической документации
• Составление руководства по стилю технической документации
• Инструктирование инженеров, участвующих в разработке комплекта технической документации
• Проверка соответствия получаемых документов предъявляемым к ним требованиям
• Обсуждение документов с авторами
• Литературное редактирование документов
• Проверка соблюдения разработчиками комплекта технической документации сроков решения поставленных перед ними задач
• Регулярная корректировка календарного плана разработки комплекта технической документации
• Согласование комплекта технической документации с экспертами
• Согласование комплекта технической документации с нормоконтролем
• Оформление результирующих материалов и их передача заказчику

Необходимые умения

• Оценивать затраты (в том числе трудозатраты) на создание комплекта технической документации
• Ставить исполнителям задачи с четкими критериями решения
• Составлять рабочие инструкции, правила, памятки
• Проверять и оценивать работу исполнителей
• Вести словарь терминологии на уровне проекта
• Составлять руководство по стилю на уровне проекта
• Налаживать продуктивное сотрудничество с авторами текстов и выполнять литературное редактирование текстов
• Осуществлять деловые коммуникации, в том числе вести переписку
• Читать сетевые графики и диаграммы Ганта
• Составлять сетевые графики с помощью электронных таблиц
• Составлять сетевые графики с помощью специализированных программных средств

Необходимые знания

• Основы управления проектами (применительно к проектам в сфере информационных технологий)
• Практика выполнения проектов в сфере информационных технологий
• Основные факторы, влияющие на сроки выполнения проектов в сфере информационных технологий
• Наиболее распространенные современные методы мотивации разработчиков в проектах
• Порядок работы технического писателя, регламент его взаимодействия с другими специалистами организации; факторы, оказывающие влияние на возможность выполнения техническим писателем его должностных обязанностей, характерные для большинства организаций
• Методика работы над текстом, основы литературного редактирования
• Основы управления терминологией
• Основы делового этикета
• Трудовое законодательство Российской Федерации в объеме, необходимом для выполнения трудовой функции
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, электронные таблицы, средства управления проектами

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Выяснять стратегию распространения компании в разные регионы, на ее основе выстраивать процесс подготовки технической документации к использованию к глобальной среде
• Формирование команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде
• Подбор поставщиков необходимого программного обеспечения
• Организация деятельности и планирование работ команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде
• Регулярное составление отчетности по результатам работ команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде
• Формирование требований к работе команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде
• Контроль соблюдения требований, сформированных для команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде
• Формирование требований к используемому инструментарию и процессу работы
• Контроль эксплуатации средств, используемых при подготовке технической документации к использованию в глобальной среде
• Формирование инструкций по работе команды и использованию инструментария, организация обучения сотрудников

Необходимые умения

• Оценивать затраты (в том числе трудозатраты) на создание комплекта технической документации
• Ставить исполнителям задачи с четкими критериями решения
• Составлять рабочие инструкции, правила, памятки
• Проверять и оценивать работу исполнителей
• Налаживать сотрудничество как внутри команды, так и со смежными подразделениями
• Развивать и популяризировать экспертизу на уровне компании
• Пользоваться инструментами планирования работ и составления отчетности

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

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

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Инженер по документированию
• Программист

Требования к образованию и обучению

• Высшее образование – специалитет, магистратура

Требования к опыту практической работы

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

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

• Выяснение состава, структуры, содержания, оформления выпускаемых (планируемых к выпуску) информационных продуктов
• Выяснение реального и/или желаемого порядка создания выпускаемых (планируемых к выпуску) информационных продуктов
• Составление требований к информационной архитектуре и их согласование с заинтересованными лицами
• Выработка информационных типов, определяющих содержание и внутреннюю структуру разделов контента технической документации
• Выработка структуры метаданных разделов контента технической документации и логики присвоения метаданных разделам
• Выработка структуры хранилища разделов контента технической документации и логики их размещения в хранилище
• Выработка формализованной структуры информационных продуктов, выпуск которых предусмотрен информационной архитектурой
• Выработка логики автоматического формирования и верстки информационных продуктов из разделов контента технической документации
• Определение порядка управления версиями разделов контента технической документации и информационных продуктов
• Проверка выработанной информационной архитектуры на реалистичном примере, прототипе, пилотном проекте
• Согласование выработанной информационной архитектуры со всеми заинтересованными лицами
• Составление требований к реализации выработанной информационной архитектуры с использованием средств автоматизации документирования
• Составление описания информационной архитектуры и ее разъяснение разработчикам технической документации
• Разработка средств автоматизированного контроля соблюдения информационной архитектуры
• Текущий контроль соблюдения информационной архитектуры разработчиками технической документации

Необходимые умения

• Исследовать информационные продукты, выявлять их структурное, смысловое, визуальное сходство и различие
• Вырабатывать информационные типы разделов контента технической документации, составлять их формализованные описания
• Вырабатывать структуру данных (метаданных), составлять ее формализованные описания
• Вырабатывать структуру информационных продуктов, составлять ее формализованные описания
• Составлять формализованные описания логики формирования информационных продуктов из разделов контента
• Описывать формализованные требования к программным средствам и автоматизированным системам
• Проводить презентации, адресованные техническим специалистам, техническим руководителям и другим вовлеченным лицам

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение практики документирования в других организациях
• Разработка бизнес-процессов документирования в организации
• Согласование бизнес-процессов с заинтересованными лицами
• Разработка регламентов и инструкций по выполнению бизнес-процессов

Необходимые умения

• Описание бизнес-процессов в графических форме: схем, диаграмм
• Описание бизнес-процессов в текстовой форме

Необходимые знания

• Основные стандарты процессов разработки в сфере ИТ
• Взаимосвязь процессов документирования с процессами разработки
• Возможности современных средств автоматизированной разработки технической документации

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение современных средств автоматизированной разработки и форматов технической документации
• Изучение практики автоматизированной разработки технической документации в других организациях
• Обмен опытом со специалистами на выставках, семинарах, конференциях
• Разработка технического задания на систему автоматизированного документирования, реализующую требуемую информационную архитектуру
• Поиск и выбор средств автоматизированной разработки технической документации для требуемой информационной архитектуры
• Проектирование системы автоматизированного документирования, реализующей требуемую информационную архитектуру
• Развертывание средств автоматизированной разработки технической документации в организации и их базовая настройка
• Создание шаблонов разделов контента технической документации в соответствии с требуемой информационной архитектурой
• Создание хранилища разделов контента технической документации в соответствии с требуемой информационной архитектурой
• Создание шаблонов информационных продуктов в соответствии с требуемой информационной архитектурой
• Создание сценариев и стилей для выпуска информационных продуктов в соответствии с требуемой информационной архитектурой
• Загрузка унаследованного контента технической документации в систему автоматизированного документирования
• Испытания системы автоматизированного документирования на материале пилотного проекта
• Составление руководств и технологических инструкций для разработчиков технической документации
• Выбор средств защиты информационных продуктов от внесения несанкционированных изменений третьими лицами

Необходимые умения

• Получать и анализировать информацию о программных средствах, доступных на коммерческом рынке и в сфере средств с открытым исходным кодом
• Общаться с поставщиками программных средств и техническими специалистами по ним устно и письменно, в том числе на английском языке
• Разворачивать тестовые стенды и исследовать на них возможности программных средств
• Исследовать потребности будущих пользователей и разрабатывать требования к автоматизированным системам
• Проектировать несложные автоматизированные системы масштаба рабочей группы
• Проводить испытания несложных автоматизированных систем масштаба рабочей группы
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленных задач
• Разрабатывать сценарии автоматизации на предназначенных для этого языках программирования
• Разрабатывать стили оформления информационных продуктов на предназначенных для этого языках разметки
• Конвертировать контент технической документации из исходных форматов в структурированные форматы
• Разрабатывать руководства и технологические инструкции для пользователей автоматизированных систем

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Находить и анализировать информацию о программных средствах, доступных на коммерческом рынке и в сфере средств с открытым исходным кодом
• Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленных задач
• Общаться с поставщиками программных средств и техническими специалистами по ним устно и письменно, в том числе на английском языке
• Разворачивать тестовые стенды и исследовать на них возможности программных средств, проводить пилотные испытания на реальном контенте
• Исследовать потребности будущих пользователей и разрабатывать требования к автоматизированным системам и сценарии их применения
• Разрабатывать рабочие инструкции, правила, памятки по работе с программными средствами, вести базу знаний по особенностям работы программных средств и надстроек к ним

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Разработка сценариев автоматического тестирования (верификации) на популярных скриптовых языках
• Разработка правил и внедрение автоматического тестирования (верификации) на соответствие текста правилам форматирования, терминологии, стилистики, структурирования (настройка статических анализаторов)
• Разработка и внедрение проверки корректности примеров кода
• Разработка и внедрение проверки соответствия документации программному коду
• Разработка и внедрение проверки актуальности скриншотов и/или автоматической съемки скриншотов при помощи инструментов для автоматизации действий веб-браузеров
• Получение от отдела тестирования необходимой информации по вопросам автоматического тестирования (верификации) технической документации

Необходимые умения

• Использовать средства автоматического тестирования (верификации) и средств проверки синтаксиса (статических анализаторов)
• Разработка сценариев автоматического тестирования (верификации) на популярных скриптовых языках
• Встраивание проверок в принятую в организации систему непрерывной интеграции и развертывания приложений

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Составление перечня средств разработки документации, используемых в организации
• Создание обучающих материалов и инструкций по использованию средств разработки технической документации
• Разработка критериев оценки усвоения знаний разработчиками технических материалов
• Публикация обучающих материалов и инструкций во внутренней базе знаний
• Организация обучающих семинаров для разработчиков технической документации

Необходимые умения

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

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Начальник отдела технической документации

Требования к образованию и обучению

• Высшее образование – специалитет, магистратура

Требования к опыту практической работы

• Не менее одного года в области руководства разработкой технической документации продукта

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

• Разработка регламентов работы отдела, составление организационно-распорядительной документации
• Разработка организационно-штатной структуры отдела технического документирования
• Разработка кадровой политики отдела технического документирования и ее согласование с руководителями, имеющими соответствующие полномочия
• Разработка и согласование технической политики отдела технического документирования
• Планирование работы специалистов отдела технического документирования
• Планирование ресурсов отдела технического документирования
• Контроль текущей загрузки специалистов отдела технического документирования
• Контроль ресурсов отдела технического документирования
• Организация и ведение архива технической документации
• Среднесрочное планирование развития отдела технического документирования
• Координация работы отдела с работой смежных подразделений организации в сфере требований к технической документации и порядка ее разработки
• Планирование закупок профильных продуктов и услуг для нужд отдела технического документирования
• Поиск профильных подрядных организаций и их привлечение к решению задач, связанных с техническим документированием
• Обмен опытом со специалистами на профильных выставках, семинарах, конференциях

Необходимые умения

• Обосновывать бюджет и управленческие решения
• Составлять организационно-распорядительную документацию, в том числе положения и регламенты
• Обрабатывать документы в рамках корпоративного документооборота
• Осуществлять деловые коммуникации, в том числе переписку

Необходимые знания

• Основные современные подходы, методы, технологии, технические и программные средства, используемые в сфере информационных технологий
• Современное состояние отрасли технической коммуникации
• Современные подходы, методы, технологии, программные средства, используемые при разработке технической документации
• Практика технического документирования в других организациях
• Основные профильные издания, ресурсы, выставки, конференции
• Основы менеджмента
• Трудовое законодательство Российской Федерации в объеме, необходимом для выполнения трудовой функции
• Основные положения Гражданского кодекса Российской Федерации, регулирующие оказание услуг и выполнение подрядных работ
• Основы делового этикета
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, средства подготовки слайд-шоу

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Управлять проектами в сфере информационных технологий
• Выполнять проекты в сфере информационных технологий
• Ставить исполнителям задачи
• Проверять и оценивать работу исполнителей
• Читать сетевые графики и диаграммы Ганта

Необходимые знания

• Методы оценки затрат (в том числе трудозатрат) на создание комплекта технической документации
• Особенности практики работы технического писателя
• Факторы, влияющие на сроки разработки в сфере информационных технологий
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, электронные таблицы, средства управления проектами

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Составление руководства по стилю технических документов, правил оформления изображений, списков, таблиц и глоссария и внедрение их в работу отдела
• Формулирование критериев проверки непротиворечивости, правильности и актуальности технической документации
• Обсуждение и обмен знаниями по поводу руководства по стилю с подразделениями организации, работающими с текстами
• Создание и распространение шаблонов технических документов, принятых в организации
• Создание и внедрение критериев проверки удобочитаемости, доступности технической документации и ее пригодности для поиска, регулярная верификация структуры комплекта документации
• Определение и донесение до команды критериев удобства информационного продукта и процесса их проверки
• Организация процесса сбора отзывов для улучшения показателей качества информационных продуктов
• Согласование стандартов качества организации с заинтересованными лицами

Необходимые умения

• Применять основные принципы и правила принятого в организации стиля написания документов и адаптировать их под бизнес-задачи организации
• Составлять требования к качеству создаваемой технической документации с учетом общего подхода к работе с текстами в организации
• Выносить повторяющиеся элементы документации в шаблоны
• Внедрять или подготавливать описание правил для автоматизированных проверок критериев качества

Необходимые знания

• Основные российские и международные спецификации и стандарты выпуска технической документации и процессы ее разработки
• Основные подходы к структурированию информационных продуктов, в том числе технических документов
• Методы проверки качества технической документации

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Формулировать требования к продукции в сфере информационных технологий
• Описывать бизнес-процессы и требования к порядку их выполнения

Необходимые знания

• Нормативно-правовая база стандартизации в тех странах, где организация осуществляет свою деятельность
• Стандарты в области системной и программной инженерии
• Стандарты технической документации и процессов документирования
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, электронные таблицы, средства управления проектами

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

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

Необходимые умения

• Разъяснять соискателю преимущества работы в организации
• Мотивировать специалиста к повышению квалификации
• Составлять тестовые задания для соискателей
• Интервьюировать соискателей

Необходимые знания

• Основы управления персоналом
• Трудовое законодательство Российской Федерации в объеме, необходимом для выполнения трудовой функции
• Профессиональные стандарты, определяющие требования к квалификации специалистов, необходимых отделу технического документирования
• Возможности развития карьеры специалиста в организации, а также за пределами организации
• Методы оценки квалификации профильных специалистов
• Методы повышения квалификации профильных специалистов
• Основы делового этикета
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, электронная почта, системы управления наймом в организации, интернет-ресурсы с вакансиями

Требования к опыту практической работы

Требований нет

Другие характеристики

Возможные наименования должностей, профессий

• Начальник подразделения технической коммуникации

Требования к образованию и обучению

• Высшее образование – специалитет, магистратура

Требования к опыту практической работы

• Не менее одного года в области руководства отделом технического документирования

Особые условия допуска к работе

Другие характеристики

Дополнительные характеристики

Трудовые действия

• Диагностика потребностей организации в области технической коммуникации
• Выработка политики организации в отношении технической коммуникации
• Создание в подразделении отдела технического документирования
• Создание в подразделении отдела перевода и локализации
• Создание в подразделении терминологической службы
• Создание в подразделении библиотеки технической документации
• Разработка регламентов работы подразделения технической коммуникации, составление организационно-распорядительной документации

Необходимые умения

• Выявлять возможности применения методов технической коммуникации для решения задач, поставленных перед организацией
• Формулировать предложения по внедрению методов технической коммуникации в практику работы организации с использованием управленческой терминологии
• Распознавать перспективные идеи и внедрять их в практику
• Обосновывать бюджеты и управленческие решения
• Составлять организационно-распорядительную документацию, в том числе положения и регламенты
• Обрабатывать документы в рамках корпоративного документооборота
• Осуществлять деловые коммуникации, в том числе переписку

Необходимые знания

• Современные подходы, методы, технологии, технические и программные средства, используемые в сфере информационных технологий
• Современные подходы, методы, технологии, программные средства, используемые в сфере технической коммуникации
• Стандарты в области технической коммуникации
• Основы системной и программной инженерии
• Стандарты в области системной и программной инженерии
• Практика разработки технической документации
• Практика работы по переводу и локализации
• Практика работы терминологических служб
• Методы и средства управления технической информацией
• Основы менеджмента
• Основы бюджетирования
• Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: текстовые процессоры, электронные таблицы, средства управления проектами

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Формулирование целей и задач, решаемых организацией с помощью технической документации
• Формирование набора ключевых показателей эффективности в отношении технической документации и процессов документирования
• Разработка критериев и метрик качества технической документации исходя их ключевых показателей эффективности

Необходимые умения

• Выявление потребностей бизнеса и возможностей их удовлетворения с помощью технической документации
• Формирование набора ключевых показателей эффективности

Необходимые знания

• Практика разработки и использования технической документации в индустрии информационных технологий
• Критерии качества технической документации, метрики качества технической документации, способы их расчета и интерпретации

Требования к опыту практической работы

Требований нет

Другие характеристики

Трудовые действия

• Изучение мировых тенденций в области технической коммуникации
• Координация совместной работы отделов подразделения технической коммуникации, в частности организация обмена информацией между ними
• Составление бюджета подразделения
• Формирование и согласование программы развития подразделения
• Постановка задач начальникам отделов в составе подразделения технической коммуникации
• Оценка качества работы отделов подразделения технической коммуникации

Необходимые умения

• Выявлять возможности применения методов технической коммуникации для решения задач, поставленных перед организацией
• Формулировать предложения по внедрению методов технической коммуникации в практику работы организации с использованием управленческой терминологии
• Распознавать перспективные идеи и внедрять их в практику
• Обосновывать бюджеты и управленческие решения
• Составлять организационно-распорядительную документацию, в том числе положения и регламенты
• Работать в системе корпоративного документооборота
• Осуществлять деловые коммуникации, в том числе переписку

Необходимые знания

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

Требования к опыту практической работы

Требований нет

Другие характеристики