Технический писатель (должность)

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

Код: В. Уровень квалификации: 5.

Возможные наименования должностей:

• Технический писатель (специалист по технической документации в ИТ);
• Разработчик технической документации.

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

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

Наименование документа	Код	Наименование базовой группы, должности (профессии) или специальности
ОКЗ	3512	Специалисты-техники по поддержке пользователей ИКТ
ЕКС	-
ОКПДТР	22824	Инженер-программист
ОКСО	2.09.00.00	Информатика и вычислительная техника
	2.27.00.00	Управление в технических системах

1. Разработка эксплуатационной документации, адресованной конечному пользователю продукта

Код: B/01.5.

Уровень (подуровень) квалификации: 5.

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

2. Разработка технического документа по заданному стандарту на основе предоставленных материалов

Код: B/02.5.

Уровень (подуровень) квалификации: 5.

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

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

Код: B/03.5.

Уровень (подуровень) квалификации: 5.

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

4. Составление текста для нанесения на упаковку продукта или на корпус устройства

Код: B/04.5.

Уровень (подуровень) квалификации: 5.

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

5. Редакторская правка контента технической документации в рамках его перекрестной проверки в рабочей группе

Код: B/05.5.

Уровень (подуровень) квалификации: 5.

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

6. Оценка качества технической документации с использованием заданной системы показателей

Код: B/06.5.

Уровень (подуровень) квалификации: 5.

Трудовые действия	Сбор исходных данных для оценки качества технической документации
	Расчет значений заданных метрик качества технической документации
	Составление отчета об оценке качества технической документации
Необходимые умения	Навыки работы с текстом как с объектом исследования
	Использование электронных таблиц для статистических вычислений
	Составление аналитических отчетов на основе данных статистики
Необходимые знания	Основные подходы к оценке качества технической документации
	Основные метрики качества технической документации
	Основные статистические функции электронных таблиц
	Основные понятия прикладной статистики: способы статистической проверки гипотез, p-значения
Другие характеристики	-