Войти

Специалист по разработке технической документации (технический писатель)

Описание профессии
2529-0-002
Специалист по разработке технической документации (технический писатель)
Профессиональный стандарт
Паспорт профессионального стандарта
Связь с другими профессиями
Карта профессий
Правила признания
Реестр профессий
Описание
Основная цель
Разработка технической документации на продукцию в сфере ИТ, разработка технических документов информационно-методического назначения, управление технической информацией
Требования к личностным компетенциям
  • Аналитическое мышление, Ответственность, Организованность, Обучаемость, Умение работать в команде, Системное мышление
Требования к опыту работы
  • Не менее 2 лет по профилю
Связь с другими профессиями
6 уровень ОРК
Специалист по разработке технической документации (технический писатель)
Подробнее
Уровень 6
высшее образование (бакалавриат, специалитет, ординатура) , 6B061 Информационно-коммуникационные технологии

Умения
1. Составлять требования к эксплуатационному документу
2. Оценивать количество рабочих часов, необходимых для выполнения полученного задания
3. Составлять календарный план выполнения полученного задания
4. Разрабатывать руководство по эксплуатации бытового прибора
5. Разрабатывать руководство по установке прикладного программного средства
6. Разрабатывать руководство пользователя прикладного программного средства
7. Разрабатывать учебное пособие по прикладному программному средству
8. Разрабатывать технологическую инструкцию для персонала автоматизированной системы
9. Составлять текст, адаптированный для автоматизированного перевода
10. Анализировать замечания экспертов и вносить исправления в документ
11. Преобразовывать документ в различные выходные форматы
Знания
1. Понятий «техническое средство», «программное средство», «комплекс», «система», содержание этих понятий, различия между ними
2. Основных типов эксплуатационных документов, адресованных пользователям, их особенности
3. Основных стандартов на эксплуатационную документацию, в том числе на документацию пользователя
4. Общих требований к структуре разделов технического документа
5. Терминологии, применяемой для описания интерфейса пользователя компьютерных систем
6. Методики и стиля изложения документации пользователя (технических средств, программных средств)
7. Информационно-справочного и поискового аппарата документа
8. Основных видов авторской разметки текста технической документации
9. Основных стандартов оформления технической документации
10. Основных форматов электронных документов и особенности их использования
11. Инструментов: средств для набора текста, средств подготовки снимков экрана, средств преобразования документов в выходные форматы, тестовых стендов
Умения
1. Опрашивать экспертов и анализировать полученные сведения
2. Применять требования стандарта с учетом особенностей конкретного проекта
3. Подготавливать графические схемы
4. Компоновать документ на основе заданных источников
Знания
1. Современного состояния индустрии информационных технологий, основные подходы и тенденции
2. Методов системной и программной инженерии
3. Нормативно-правовой базы применения стандартов
4. Стандартов документирования промышленной продукции, программных средств, систем (в том числе автоматизированных)
Умения
1. Проводить опрос экспертов и анализировать полученные сведения
2. Составлять информативные и лаконичные разделы электронной справки, понятные представителям целевой аудитории в отрыве от других разделов
3. Расставлять в гипертексте полезные для читателей гипертекстовые ссылки
4. Размечать текст в соответствии с правилами заданного языка разметки
5. Отлаживать программы и настраивать системы
6. Создавать простые элементы веб-дизайна
7. Пользоваться системой управления версиями
8. Пользоваться системой трекинга ошибок
Знания
1. Основных возможностей и технические характеристики наиболее распространенных в настоящее время форматов электронной справки
2. Способов интеграции электронной справки в программные средства и системы
3. Перечня лидирующих средств разработки электронной справки, их основные функциональные возможности и технические характеристики
4. Средств разработки электронной справки
5. Гипертекста, его методических и стилистических особенностей
6. Инструментов: текстовых редакторов с поддержкой набора исходного кода, HTML-редакторов, XML-редакторов, средств разработки электронной справки заданного формата, тестового стенда, средств управления версиями и трекинга ошибок

Умения
1. Анализировать научно-техническую литературу, извлекать из нее сведения, необходимые для решения поставленной задачи
2. Составлять обобщенные описания явлений, процессов, объектов управления без использования математического аппарата и специальной терминологии
3. Использовать математический аппарат для описания явлений, процессов, объектов управления
4. Описывать бизнес-процессы с помощью графических нотаций
Знания
1. Основ высшей математики в объеме программы технического вуза
2. Основ теории систем и системного анализа
3. Перечня наиболее распространенных в настоящее время методологий описания бизнес-процессов, основные принципы, на которых основаны эти методологии
4. Инструментов: средств для набора текста, средств подготовки графических схем, средств визуального описания бизнес-процессов
Умения
1. Анализировать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
2. Составлять и отлаживать несложные программы и тестовые примеры
3. Разрабатывать технические задания и спецификации требований
4. Разрабатывать описание системной или программной архитектуры
5. Разрабатывать руководства программиста, справочники по интерфейсам прикладного программирования
6. Разрабатывать описание структуры набора данных
7. Разрабатывать руководство по языку программирования
8. Разрабатывать инструкцию по монтажу, пуску, регулированию и обкатке технического средства или аппаратно-программного комплекса
9. Разрабатывать руководство системного администратора
Знания
1. Перечня наиболее распространенных в настоящее время аппаратных платформ, сферы их применения, основные технические характеристики
2. Перечня наиболее распространенных в настоящее время операционных систем, сферы их применения, основные технические характеристики
3. Принципов функционирования современных телекоммуникационных сетей
4. Наиболее распространенных в настоящее время архитектурных решений, применяемых при проектировании программных средств и компьютерных систем различного назначения
5. Перечня наиболее часто применяемых в настоящее время стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
6. Перечня наиболее распространенных в настоящее время методологий разработки программ и систем, основные принципы, заложенные в основу этих методологий
7. Языка программирования (согласно специфике работы)
8. Основных типов документов, адресованных разработчикам продукции в сфере информационных технологий, особенности этих документов
9. Способов изложения материала, наиболее распространенные в современной документации разработчика
10. Информационно-справочного и информационно-поискового аппарата документа
11. Примеров документации разработчика, которые в профессиональной среде специалистов по информационным технологиям принято считать наиболее удачными
12. Инструментов: средств для набора текста, средств автоматизированного документирования исходного кода, текстовых редакторов с поддержкой набора исходного кода, средств подготовки снимков экрана, средств преобразования документов в выходные форматы, тестового стенда
Умения
1. Описывать технические решения с точки зрения разработчиков продукции в сфере информационных технологий
2. Применять тиражируемые системы управления контентом веб-сайтов
3. Применять тиражируемые программные средства для создания и поддержки вики-систем
4. Взаимодействовать со службами поддержки хостинговых компаний
5. Поддерживать на веб-ресурсе атмосферу конструктивной профессиональной дискуссии
Знания
1. Лучших образцов справочных ресурсов по информационным технологиям
2. Основных архитектурных решений, применяемых в настоящее время при проектировании веб-приложений
3. Перечня наиболее распространенных в настоящее время систем управления контентом веб-сайтов, их основные функциональные возможности и технические характеристики
4. Понятия вики-системы, основные принципы функционирования вики-систем; перечня наиболее распространенных в настоящее время программных средств для создания и поддержки вики-систем, их основные функциональные возможности и технические характеристики
5. Потребности пользователей справочного ресурса по информационным технологиям
6. Услуг хостинга, услуг “software as a service” (SaaS) и услуг “platform as a service” (PaaS)
7. Инструментов: систем управления контентом веб-сайтов, программных средств для создания и поддержки вики-систем
Умения
1. Раскрывать заданную тему с заданной точки зрения, соблюдая требования к объему и к стилю изложения
2. Работать в средствах массовой информации в качестве автора или редактора
3. Осуществлять литературное редактирование текста
Знания
1. Жанровых особенностей и стилистики технических текстов
2. Основ редакционной работы в периодическом издании
3. Основных характеристик аудитории и редакционной политики целевого средства массовой информации
4. Основных сведений о ситуации на целевом рынке
5. Инструментов: текстовых процессоров, средств подготовки графических схем, средств подготовки снимков экрана
Уровень 7
послевузовское образование (магистратура, резидентура) , 7M061 Информационно-коммуникационные технологии

Умения
1. Составлять требования к эксплуатационному документу
2. Оценивать количество рабочих часов, необходимых для выполнения полученного задания
3. Составлять календарный план выполнения полученного задания
4. Разрабатывать руководство по эксплуатации бытового прибора
5. Разрабатывать руководство по установке прикладного программного средства
6. Разрабатывать руководство пользователя прикладного программного средства
7. Разрабатывать учебное пособие по прикладному программному средству
8. Разрабатывать технологическую инструкцию для персонала автоматизированной системы
9. Составлять текст, адаптированный для автоматизированного перевода
10. Анализировать замечания экспертов и вносить исправления в документ
11. Преобразовывать документ в различные выходные форматы
Знания
1. Понятий «техническое средство», «программное средство», «комплекс», «система», содержание этих понятий, различия между ними
2. Основных типов эксплуатационных документов, адресованных пользователям, их особенности
3. Основных стандартов на эксплуатационную документацию, в том числе на документацию пользователя
4. Общих требований к структуре разделов технического документа
5. Терминологии, применяемой для описания интерфейса пользователя компьютерных систем
6. Методики и стиля изложения документации пользователя (технических средств, программных средств)
7. Информационно-справочного и поискового аппарата документа
8. Основных видов авторской разметки текста технической документации
9. Основных стандартов оформления технической документации
10. Основных форматов электронных документов и особенности их использования
11. Инструментов: средств для набора текста, средств подготовки снимков экрана, средств преобразования документов в выходные форматы, тестовых стендов
Умения
1. Опрашивать экспертов и анализировать полученные сведения
2. Применять требования стандарта с учетом особенностей конкретного проекта
3. Подготавливать графические схемы
4. Компоновать документ на основе заданных источников
Знания
1. Современного состояния индустрии информационных технологий, основные подходы и тенденции
2. Методов системной и программной инженерии
3. Нормативно-правовой базы применения стандартов
4. Стандартов документирования промышленной продукции, программных средств, систем (в том числе автоматизированных)
Умения
1. Проводить опрос экспертов и анализировать полученные сведения
2. Составлять информативные и лаконичные разделы электронной справки, понятные представителям целевой аудитории в отрыве от других разделов
3. Расставлять в гипертексте полезные для читателей гипертекстовые ссылки
4. Размечать текст в соответствии с правилами заданного языка разметки
5. Отлаживать программы и настраивать системы
6. Создавать простые элементы веб-дизайна
7. Пользоваться системой управления версиями
8. Пользоваться системой трекинга ошибок
Знания
1. Основных возможностей и технические характеристики наиболее распространенных в настоящее время форматов электронной справки
2. Способов интеграции электронной справки в программные средства и системы
3. Перечня лидирующих средств разработки электронной справки, их основные функциональные возможности и технические характеристики
4. Средств разработки электронной справки
5. Гипертекста, его методических и стилистических особенностей
6. Инструментов: текстовых редакторов с поддержкой набора исходного кода, HTML-редакторов, XML-редакторов, средств разработки электронной справки заданного формата, тестового стенда, средств управления версиями и трекинга ошибок

Умения
1. Анализировать научно-техническую литературу, извлекать из нее сведения, необходимые для решения поставленной задачи
2. Составлять обобщенные описания явлений, процессов, объектов управления без использования математического аппарата и специальной терминологии
3. Использовать математический аппарат для описания явлений, процессов, объектов управления
4. Описывать бизнес-процессы с помощью графических нотаций
Знания
1. Основ высшей математики в объеме программы технического вуза
2. Основ теории систем и системного анализа
3. Перечня наиболее распространенных в настоящее время методологий описания бизнес-процессов, основные принципы, на которых основаны эти методологии
4. Инструментов: средств для набора текста, средств подготовки графических схем, средств визуального описания бизнес-процессов
Умения
1. Анализировать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
2. Составлять и отлаживать несложные программы и тестовые примеры
3. Разрабатывать технические задания и спецификации требований
4. Разрабатывать описание системной или программной архитектуры
5. Разрабатывать руководства программиста, справочники по интерфейсам прикладного программирования
6. Разрабатывать описание структуры набора данных
7. Разрабатывать руководство по языку программирования
8. Разрабатывать инструкцию по монтажу, пуску, регулированию и обкатке технического средства или аппаратно-программного комплекса
9. Разрабатывать руководство системного администратора
Знания
1. Перечня наиболее распространенных в настоящее время аппаратных платформ, сферы их применения, основные технические характеристики
2. Перечня наиболее распространенных в настоящее время операционных систем, сферы их применения, основные технические характеристики
3. Принципов функционирования современных телекоммуникационных сетей
4. Наиболее распространенных в настоящее время архитектурных решений, применяемых при проектировании программных средств и компьютерных систем различного назначения
5. Перечня наиболее часто применяемых в настоящее время стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
6. Перечня наиболее распространенных в настоящее время методологий разработки программ и систем, основные принципы, заложенные в основу этих методологий
7. Языка программирования (согласно специфике работы)
8. Основных типов документов, адресованных разработчикам продукции в сфере информационных технологий, особенности этих документов
9. Способов изложения материала, наиболее распространенные в современной документации разработчика
10. Информационно-справочного и информационно-поискового аппарата документа
11. Примеров документации разработчика, которые в профессиональной среде специалистов по информационным технологиям принято считать наиболее удачными
12. Инструментов: средств для набора текста, средств автоматизированного документирования исходного кода, текстовых редакторов с поддержкой набора исходного кода, средств подготовки снимков экрана, средств преобразования документов в выходные форматы, тестового стенда
Умения
1. Описывать технические решения с точки зрения разработчиков продукции в сфере информационных технологий
2. Применять тиражируемые системы управления контентом веб-сайтов
3. Применять тиражируемые программные средства для создания и поддержки вики-систем
4. Взаимодействовать со службами поддержки хостинговых компаний
5. Поддерживать на веб-ресурсе атмосферу конструктивной профессиональной дискуссии
Знания
1. Лучших образцов справочных ресурсов по информационным технологиям
2. Основных архитектурных решений, применяемых в настоящее время при проектировании веб-приложений
3. Перечня наиболее распространенных в настоящее время систем управления контентом веб-сайтов, их основные функциональные возможности и технические характеристики
4. Понятия вики-системы, основные принципы функционирования вики-систем; перечня наиболее распространенных в настоящее время программных средств для создания и поддержки вики-систем, их основные функциональные возможности и технические характеристики
5. Потребности пользователей справочного ресурса по информационным технологиям
6. Услуг хостинга, услуг “software as a service” (SaaS) и услуг “platform as a service” (PaaS)
7. Инструментов: систем управления контентом веб-сайтов, программных средств для создания и поддержки вики-систем
Умения
1. Раскрывать заданную тему с заданной точки зрения, соблюдая требования к объему и к стилю изложения
2. Работать в средствах массовой информации в качестве автора или редактора
3. Осуществлять литературное редактирование текста
Знания
1. Жанровых особенностей и стилистики технических текстов
2. Основ редакционной работы в периодическом издании
3. Основных характеристик аудитории и редакционной политики целевого средства массовой информации
4. Основных сведений о ситуации на целевом рынке
5. Инструментов: текстовых процессоров, средств подготовки графических схем, средств подготовки снимков экрана