Старший технический писатель, архитектор контента
Перейти к навигации
Перейти к поиску
Руководство разработкой технической документации продукта в сфере информационно-коммуникационных технологий.
Код: E. Уровень квалификации: 6.
Возможные наименования должностей:
- Старший (ведущий) технический писатель (специалист по технической документации в ИТ);
- Старший разработчик технической документации;
- Руководитель группы разработки технической документации;
- Архитектор контента.
| Требования к образованию и обучению | Высшее образование – бакалавриат |
|---|---|
| Требования к опыту практической работы | Не менее одного года работы техническим писателем |
| Особые условия допуска к работе | – |
| Другие характеристики | Рекомендуется дополнительное профессиональное образование – программы повышения квалификации по профилю деятельности |
| Наименование документа | Код | Наименование базовой группы, должности (профессии) или специальности |
|---|---|---|
| ОКЗ | 2519 | Разработчики и аналитики программного обеспечения и приложений, не входящие в другие группы |
| ЕКС | - | Инженер-программист |
| ОКПДТР | 22824 | Инженер-программист |
| ОКСО | 2.09.00.00 | Информатика и вычислительная техника |
| 2.27.00.00 | Управление в технических системах |
1. Планирование разработки комплекта технической документации продукта
Код: E/01.6.
Уровень (подуровень) квалификации: 6.
| Трудовые действия | Уточнение ожиданий заказчика от запланированной работы по документированию, оценка их реалистичности, корректировка в случае необходимости |
| Изучение целевой аудитории документа, выяснение ее задач, потребностей в информации, уровня подготовки | |
| Изучение документируемой продукции с точки зрения всех целевых аудиторий и с учетом их информационных потребностей | |
| Разработка спецификации требований к комплекту технической документации | |
| Согласование спецификации требований к комплекту технической документации с заказчиком | |
| Необходимые умения | Проводить опросы экспертов и анализировать полученные сведения |
| Исследовать программные средства на тестовом стенде | |
| Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи | |
| Исследовать целевую аудиторию комплекта технической документации | |
| Разрабатывать требования к комплекту технической документации | |
| Разрабатывать требования к техническому документу | |
| Работать в системах управления требованиями | |
| Необходимые знания | Понятия «техническое средство», «программное средство», «комплекс», «система», содержание этих понятий, различия между ними |
| Перечень наиболее часто применяемых в настоящее время стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты | |
| Перечень наиболее распространенных в настоящее время методологий разработки программ и систем, основные принципы, заложенные в основу этих методологий | |
| Основные типы информационных продуктов, в т. ч. технических документов, и их особенности | |
| Практика документирования технических средств, программных средств, комплексов, систем | |
| Стандарты, содержащие требования к технической документации | |
| Основы управления требованиями | |
| Типовой состав требований к комплекту технической документации | |
| Типовой состав требований к техническому документу | |
| Общие требования к структуре технического документа | |
| Основные электронные форматы информационных продуктов и их особенности | |
| Другие характеристики | - |
2. Управление процессом разработки комплекта технической документации продукта
Код: E/02.6.
Уровень (подуровень) квалификации: 6.
| Трудовые действия | Формирование команды разработчиков комплекта технической документации |
| Постановка задачи членам коллектива разработчиков комплекта технической документации | |
| Организация деятельности коллектива разработчиков комплекта технической документации | |
| Составление руководства по стилю технической документации | |
| Инструктирование инженеров, участвующих в разработке комплекта технической документации | |
| Проверка соответствия получаемых документов предъявляемым к ним требованиям | |
| Обсуждение документов с авторами | |
| Литературное редактирование документов | |
| Проверка соблюдения разработчиками комплекта технической документации сроков решения поставленных перед ними задач | |
| Регулярная корректировка календарного плана разработки комплекта технической документации | |
| Согласование комплекта технической документации с экспертами | |
| Согласование комплекта технической документации с нормоконтролем | |
| Оформление результирующих материалов и их передача заказчику | |
| Необходимые умения | Оценивать затраты (в том числе трудозатраты) на создание комплекта технической документации |
| Ставить исполнителям задачи с четкими критериями решения | |
| Составлять рабочие инструкции, правила, памятки | |
| Проверять и оценивать работу исполнителей | |
| Вести словарь терминологии на уровне проекта | |
| Составлять руководство по стилю на уровне проекта | |
| Налаживать продуктивное сотрудничество с авторами текстов и выполнять литературное редактирование текстов | |
| Осуществлять деловые коммуникации, в том числе вести переписку | |
| Читать и понимать сетевые графики и диаграммы Ганта | |
| Составлять сетевые графики с помощью электронных таблиц | |
| Составлять сетевые графики с помощью специализированных программных средств | |
| Необходимые знания | Основы управления проектами (применительно к проектам в сфере информационных технологий) |
| Практика выполнения проектов в сфере информационных технологий | |
| Основные факторы, влияющие на сроки выполнения проектов в сфере информационных технологий | |
| Наиболее распространенные в настоящее время методы мотивации разработчиков в проектах | |
| Порядок работы технического писателя, регламент его взаимодействия с другими специалистами организации, факторы, оказывающие влияние на возможность выполнения техническим писателем его должностных обязанностей, характерные для большинства организаций | |
| Методика работы над текстом, основы литературного редактирования | |
| Основы управления терминологией | |
| Основы делового этикета | |
| Трудовое законодательство Российской Федерации | |
| Инструменты: текстовые процессоры, электронные таблицы, средства управления проектами | |
| Другие характеристики | - |
3. Управление процессом подготовки технической документации к использованию в глобальной среде
Код: E/03.6.
Уровень (подуровень) квалификации: 6.
| Трудовые действия | Выяснять стратегию развития компании в разные регионы, на ее основе выстраивать процесс подготовки технической документации к использованию к глобальной среде |
| Формирование команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде | |
| Подбор поставщиков необходимого программного обеспечения | |
| Организация деятельности и планирование работ команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде | |
| Регулярная отчетность по результатам работ команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде | |
| Формирование требований к работе команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде | |
| Контроль соблюдения требований, сформированных для команды специалистов и разработчиков технической документации, участвующих в подготовке технической документации к использованию в глобальной среде | |
| Формирование требований к используемому инструментарию и процессу работы | |
| Контроль эксплуатации средств, используемых при подготовке технической документации к использованию в глобальной среде | |
| Формирование инструкций по работе команды и инструментария, организация обучения сотрудников | |
| Необходимые умения | Оценивать затраты (в том числе трудозатраты) на создание комплекта технической документации |
| Ставить исполнителям задачи с четкими критериями решения | |
| Составлять рабочие инструкции, правила, памятки | |
| Проверять и оценивать работу исполнителей | |
| Налаживать продуктивное сотрудничество как внутри команды, так и со смежными подразделениями | |
| Развивать и популяризировать экспертизу на уровне компании | |
| Работать в инструментах планирования работ и отчетности | |
| Необходимые знания | Основы управления проектами (применительно к проектам в сфере информационных технологий) |
| Основы управления персоналом, методы мотивации | |
| Порядок работы технического писателя и специалиста, регламент его взаимодействия с другими специалистами организации, факторы, оказывающие влияние на возможность выполнения техническим писателем его должностных обязанностей, характерные для большинства организаций | |
| Основы делового этикета | |
| Трудовое законодательство Российской Федерации | |
| Инструменты: текстовые процессоры, электронные таблицы, средства управления проектами | |
| Стандарты, содержащие требования к технической документации | |
| Основы управления требованиями | |
| Типовой состав требований к комплекту технической документации | |
| Типовой состав требований к техническому документу, к контролю качества технической документации и ее локализации | |
| Общие требования к структуре технического документа | |
| Основные форматы электронных документов и их особенности | |
| Стандартные форматы электронной справки и их особенности | |
| Принципы создания текстов с учетом последующего перевода | |
| Особенности локализации под разные регионы и языки: валюта, цены, единицы измерения, географические названия, номера телефонов, графические элементы, шрифты, кодировки и другое | |
| Перечень наиболее распространенных в настоящее время средств разработки технической документации и средств локализации, их основные функциональные возможности и технические характеристики | |
| Другие характеристики | - |
4. Обеспечение качества технической документации, в том числе, ее соответствия стандартам и языковыми нормами
Код: E/04.6.
Уровень (подуровень) квалификации: 6.
| Трудовые действия | Уточнение ожиданий заказчика от запланированной работы по документированию, оценка их реалистичности, корректировка сроков и ожиданий в случае необходимости |
| Исследование целевой аудитории документа, выяснение ее задач, потребностей в информации, уровня подготовки | |
| Уточнение задач бизнеса, которые решает заказанный документ, корректировка задачи на их основе | |
| Проверка готового содержания и структуры относительно руководства по стилю, принятого в организации | |
| Использование средств автоматизированной проверки до публикации документа | |
| Внесение правок и повторная проверка по итогам редактуры | |
| Необходимые умения | Проводить первичную вычитку информационного продукта относительно общих языковых и стилистических правил и относительно руководства по стилю организации |
| Передавать информационный продукт на вычитку редактору с указанием целевой аудитории и поставленной задачи | |
| Исследовать информационный продукт на предмет его полноты, правильности относительно описываемой системы, воспроизводимости приведенных в нем указаний, единообразия терминов, удобочитаемости и других принятых критериев | |
| Исследовать целевую аудиторию комплекта технической документации | |
| Проверять и поддерживать актуальность документации | |
| Обеспечивать актуальность скриншотов и корректность диаграмм и схем, соответствие их версиям программного продукта | |
| Опрашивать читателей или внутреннюю аудиторию организации о качестве документа | |
| Обеспечивать качество и корректность публикации документа: для печатного формата это форматирование, для веб-документов — корректность верстки и гиперссылок | |
| Использовать внешние справочные ресурсы и лучшие практики индустрии, чтобы оценивать и корректировать качество информационного продукта, в т. ч. технического документа | |
| Необходимые знания | Основные лексические и грамматические правила используемого в компании рабочего языка/языков |
| Основные метрики проверки качества информационного продукта, в т. ч. технического документа | |
| Перечень наиболее часто применяемых в настоящее время руководств по стилю и стандартов написания текста технической документации | |
| Принятый в компании процесс вычитки и согласования технической документации | |
| Правила разметки, верстки и публикации технических документов | |
| Другие характеристики | - |