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