Младший технический писатель
Перейти к навигации
Перейти к поиску
Оформление и компоновка технической документации на продукцию в сфере информационно-коммуникационных технологий.
Код: А. Уровень квалификации: 4.
Возможные наименования должностей:
- Технический писатель-стажер (специалист по технической документации в ИТ-стажер);
- Младший технический писатель (младший специалист по технической документации в ИТ);
- Оформитель технической документации.
| Требования к образованию и обучению | Среднее профессиональное образование – программы подготовки специалистов среднего звена |
|---|---|
| Требования к опыту практической работы | – |
| Особые условия допуска к работе | – |
| Другие характеристики | Рекомендуется дополнительное профессиональное образование – программы повышения квалификации в области эффективных коммуникаций |
| Наименование документа | Код | Наименование базовой группы, должности (профессии) или специальности |
|---|---|---|
| ОКЗ | 3512 | Специалисты-техники по поддержке пользователей ИКТ |
| ЕКС | - | |
| ОКПДТР | 25857 | Программист |
| ОКСО | 2.09.00.00 | Информатика и вычислительная техника |
| 2.27.00.00 | Управление в технических системах |
1. Компоновка технического документа на основе предоставленных источников и материалов
Код: A/01.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Разработка структуры документа и ее согласование с экспертами |
| Подбор дополнительных источников информации | |
| Отбор материала из имеющихся источников и его переработка для включения в новый контекст | |
| Составление вводного и заключительного разделов документа | |
| Согласование документа с экспертами, внесение в технический документ исправлений по замечаниям экспертов | |
| Проверка уникальности текста документа и корректности оформления цитат с использованием систем антиплагиата | |
| Необходимые умения | Находить в информационно-телекоммуникационной сети "Интернет" источники информации по заданной теме |
| Пользоваться ресурсами научно-технических библиотек и архивов | |
| Реферировать источники научно-технического характера, составленные на русском и английском языках | |
| Составлять научно-технический текст, придерживаясь композиционных и стилистических правил, присущих научно-техническому стилю | |
| Структурировать текст делением его на разделы, подразделы, пункты, подпункты, абзацы | |
| Корректно оформлять цитаты и библиографические ссылки в документах научно-технического характера | |
| Проверять уникальность текста документа с помощью систем антиплагиата | |
| Необходимые знания | Научно-технический стиль изложения и его особенности |
| Основные разновидности научно-технических документов | |
| Основные стандарты оформления научно-технических отчетов | |
| Правила оформления цитат и библиографических ссылок в документах научно-технического характера | |
| Инструменты: текстовые процессоры, программы оптического распознавания символов, системы антиплагиата, поисковые системы в информационно-телекоммуникационной сети "Интернет" | |
| Другие характеристики | - |
2. Оформление технического документа в текстовом процессоре по заданному стандарту или шаблону
Код: A/02.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Создание шаблона документа для заданного текстового процессора |
| Применение к тексту документа стилей и других средств оформления | |
| Создание в документе информационно-поискового аппарата | |
| Включение в текст иллюстраций: графических схем, снимков экрана | |
| Вычитка документа, устранение ошибок в оформлении и опечаток | |
| Преобразование сплошного текста в списки и таблицы | |
| Вставка в текст и оформление рисунков, в т. ч. снимков экрана | |
| Необходимые умения | Работать в современном текстовом процессоре |
| Создавать, настраивать, применять стили в документе с помощью текстового процессора | |
| Создавать графические схемы, получать снимки экрана, включать рисунки в технический документ и правильно их оформлять | |
| Создавать информационно-поисковый аппарат документа с помощью текстового процессора | |
| Создавать в тексте якоря и гипертекстовые ссылки, оформлять подписи к гипертекстовым ссылкам | |
| Оформлять рисунки, в т. ч. снимки экрана, оформлять подписи к ним в соответствии с используемым стандартом | |
| Необходимые знания | Основные возможности современных текстовых процессоров |
| Основные стандарты оформления текстовых документов | |
| Основные способы работы с векторной и растровой графикой, способы включения рисунков в документ, правила оформления рисунков | |
| Основы типографики | |
| Информационно-справочный и информационно-поисковый аппарат документа | |
| Основные графические форматы и их особенности | |
| Другие характеристики | - |
3. Перенос контента технической документации из технических документов в систему управления контентом или в базу знаний
Код: A/03.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Создание (изменение, удаление) статей в используемой системе управления контентом или базе знаний |
| Копирование текста из технических документов и его приведение в соответствие требованиям системы управления контентом или базы знаний | |
| Поиск контента, который повторяется в базе знаний или системе управления контентом, устранение избыточных повторов | |
| Приведение иллюстраций (рисунков, таблиц, листингов) в соответствие требованиям системы управления контентом или базы знаний | |
| Создание элементов информационно-поискового аппарата в системе управления контентом или базе знаний | |
| Настройка перекрестных ссылок между разделами и логическими частями контента | |
| Формирование набора смысловых меток (тегов) и назначение их разделам и логическим частям контента | |
| Необходимые умения | Создавать, изменять, удалять статьи в используемой вики-системе или базе знаний |
| Извлекать текст из технических документов в формате текстового процессора и перемещать его в систему управления контентом и или базу знаний | |
| Извлекать из документов в формате текстового процессора изображения и преобразовывать их в графические файлы нужного формата | |
| Выявлять в базе знаний или системе управления контентом неоправданные повторы одного и того же контента и устранять их | |
| Создавать в используемой системе управления контентом или базе знаний элементы информационно-поискового аппарата | |
| Необходимые знания | Представление о вики-системах, хорошее понимание принципов их функционирования с точки зрения автора и читателя |
| Представление о принципе единого источника и способах многократного использования контента в информационных продуктах | |
| Представление о языках разметки, знакомство с теговыми языками разметки и легкими текстовыми форматами | |
| Представление о средства информационно-поискового аппарата: оглавлениях, тегах, указателях, перекрестных ссылках | |
| Представление о графических форматах, понимание разницы между растровыми и векторными форматами, знание основных форматов | |
| Другие характеристики | - |
4. Разметка контента технической документации с помощью заданного языка разметки в целях публикации
Код: A/04.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Выбор, установка, настройка программных средств для ввода и структурирования контента с использованием заданного языка разметки |
| Подготовка структуры папок (директорий) и файлов для размещения структурированного контента в используемой среде хранения | |
| Ввод либо копирование и последующее структурирование контента с использованием заданного языка разметки | |
| Подготовка рисунков для включения в контент, структурированный с использованием заданного языка разметки | |
| Проверка валидности контента, структурированного с использованием заданного языка разметки | |
| Необходимые умения | Устанавливать и настраивать программные средства, предназначенные для работы со структурированным контентом |
| Находить в информационно-телекоммуникационной сети "Интернет" спецификации языков разметки, извлекать из них сведения о возможностях и синтаксических средствах этих языков | |
| Набирать и структурировать текст в соответствии с правилами языков разметки наиболее распространенных типов (теговых и легковесных) | |
| Описывать внешний вид документа, созданного с использованием языка разметки, на формальном языке описания: создавать стили и отлаживать их | |
| Конвертировать изображения, исходно представленные в различных цифровых форматах, в формат, отвечающий требованиям к документу | |
| Проверять корректность разметки структурированного контента и исправлять обнаруженные ошибки | |
| Придавать структурированному контенту вид, удобный для чтения, проверки и редактирования | |
| Необходимые знания | Представление о языках разметки, основные типы языков разметки (теговые, легковесные) и их особенности |
| Синтаксис языка разметки HTML, его основные элементы и атрибуты | |
| Язык описания стилей CSS, его основные конструкции и селекторы, предусмотренные в нем | |
| Основные принципы языка XML и правила, общие для всех языков разметки, представляющих собой его приложения | |
| Основные разновидности легковесных языков разметки, их возможности и распространенные варианты | |
| Источники официальных спецификаций языков разметки, способы их поиска в информационно-телекоммуникационной сети "Интернет" | |
| Основные форматы графических файлов и особенности их использования | |
| Инструменты: текстовые редакторы с поддержкой набора исходного кода, программы-конверторы, XML-редакторы, программы и сервисы валидации веб-документов в форматах HTML и XML | |
| Другие характеристики | - |
5. Разметка контента технической документации с помощью заданного языка разметки в целях локализации
Код: A/05.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Сбор информации о требованиях к локализации: регионе, языке публикации документа, юридических ограничениях и других особенностях |
| Изучение версии продукта для региона, выявление ее отличий от базовой версии продукта | |
| Выявление недостающего в техническом документе локального контента и контента, требующего локализации: обозначений валют, цен, единиц измерения, географических названий, номеров телефонов, логотипов и других элементов графического оформления | |
| Подготовка локализационного контента к последующему переводу | |
| Согласование локализованного контента с экспертами | |
| Внесение локализованного контента в технический документ в соответствии с правилами локализационной разметки заданного языка разметки | |
| Проверка корректности локализационной разметки | |
| Необходимые умения | Опрашивать экспертов и анализировать полученные сведения |
| Исследовать программные средства на тестовом стенде | |
| Исследовать открытые источники для выявления особенностей региона, влияющих на локализацию документа | |
| Оценивать количество рабочих часов, необходимых для выполнения полученного задания | |
| Подготавливать информативный и лаконичный локализованный контент | |
| Получать замечания у экспертов и вносить исправления в документ | |
| Размечать текст локализационными тегами в соответствии с правилами заданного языка разметки | |
| Выполнять сборку локализованного информационного продукта и проверять его целостность, валидность и смысловую корректность | |
| Необходимые знания | Основные особенности стиля изложения технической документации |
| Языки разметки | |
| Источники официальных спецификаций языков разметки | |
| Инструменты: редакторы с поддержкой набора в различных языках разметки, тестовый стенд, средства подготовки графических схем, средства подготовки снимков экрана, средства управления версиями и трекинга ошибок | |
| Другие характеристики | - |
6. Подготовка списка изменений, отличающих новую модель или версию продукта в сфере информационно-коммуникационных технологий от предшествующей
Код: A/06.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Получение из задачи в системе управления задачами или из системы управления версиями последних изменений в программном продукте |
| Определение структуры списка изменений (выделение разделов с новыми функциями, измененными или удаленными функциями и устранением ошибок) | |
| Согласование списка изменений с экспертами | |
| Составление списка изменений в соответствии с требованиями к стилю и формату, принятыми в организации | |
| Выбор формулировки каждого изменения | |
| Вычитка списка изменений | |
| Необходимые умения | Работать с системой управления задачами и/или системой контроля версий |
| Логически группировать изменения на новые, обновленные и исправленные ошибки | |
| Выбирать стиль описания изменений | |
| Описывать изменения простым языком, понятным пользователю | |
| Иллюстрировать изменения с помощью диаграмм и снимков экрана | |
| Необходимые знания | Системы управления задачами и системы контроля версий: поиск и выделение нужной информации |
| Особенности, присущие стилю текстовых документов компании, требования руководства по стилю | |
| Основные виды форматирования | |
| Каналы распространения списка изменений и их особенности (рассылка, магазин приложений, корпоративный блог) | |
| Другие характеристики | - |
7. Публикация информационных продуктов на основе заданного контента с использованием заданного сценария
Код: A/07.4.
Уровень (подуровень) квалификации: 4.
| Трудовые действия | Настройка параметров публикации информационных продуктов в соответствии с полученными указаниями |
| Запуск процесса публикации информационных продуктов с помощью используемого средства публикации | |
| Поиск причин ошибок публикации информационных продуктов, их устранение и перезапуск публикации | |
| Размещение опубликованных информационных продуктов на внутренних или внешних ресурсах организации согласно регламенту | |
| Необходимые умения | Настраивать параметры публикации информационных продуктов в используемых программных средствах |
| Запускать процесс публикации информационных продуктов в используемых программных средствах | |
| Читать и понимать лог-файлы, формируемые программными средствами публикации информационных продуктов | |
| Исправлять ошибки в контенте, приводящие к ошибкам при публикации информационных продуктов | |
| Необходимые знания | Понимание основных принципов работы систем автоматизированного документирования, основанных на едином источнике |
| Основные программные средства, используемые для публикации информационных продуктов, и возможные причины ошибок в их работе | |
| Перечень основных форматов файлов, используемых для поставки технической документации ее целевой аудитории | |
| Типовой процесс вычитки, согласования и публикации информационных продуктов | |
| Другие характеристики | - |