Background

Создание и тестирование документации в промышленности: стандарты ISO/IEC/IEEE 26513 и 26514

Иван Давыдов

Дата публикации: .

Для создания и тестирования пользовательской документации в контексте ПО и системного управления достаточно двух стандартов: ISO/IEC/IEEE 26514 (проектирование и разработка) и ISO/IEC/IEEE 26513 (тестирование и рецензирование). Однако для документации на промышленное оборудование базовым является IEC/IEEE 82079-1, задающий общие принципы подготовки информации по применению для всех типов продуктов. Рассмотрим эти документы подробнее.

Что такое ISO/IEC/IEEE 26513 и 26514: стандарты документации для промышленного оборудования

В индустрии программного обеспечения и системной инженерии есть два стандарта, которые напрямую касаются работы технического писателя: ISO/IEC/IEEE 26513 и ISO/IEC/IEEE 26514. Формально они относятся к ПО и системам, но их требования применимы и к документации для промышленного оборудования — станков, систем управления, контроллеров и другого сложного оборудования. Это применимость по аналогии: процессы создания и проверки информации схожи, а 26513 прямо указывает, что его рекомендации распространяются на системы и ПО для управления оборудованием.

ISO/IEC/IEEE 26513 — требования для тестировщиков и рецензентов

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

Не ограничивается этапом тестирования — он охватывает деятельность на протяжении всего процесса управления информацией. Ее проверяют не в конце, а на всех этапах: от планирования до сопровождения. Методы проверки включают документационное ревью, системное и юзабилити-тестирование, проверку доступности, а также локализацию и кастомизацию.

Кому это нужно: тестировщикам, рецензентам, специалистам по юзабилити, информационным архитекторам и бизнес-аналитикам.

ISO/IEC/IEEE 26514 — требования для проектировщиков и разработчиков

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

26514 состоит из двух частей:

  • Первая часть описывает процесс документирования: как определить, какая информация нужна пользователям, как выбрать способ ее представления и как подготовить информацию и сделать ее доступной.
  • Вторая часть устанавливает минимальные требования к структуре, содержанию и формату пользовательской документации.

Кроме того, 26514 содержит рекомендации по стилистическому оформлению. Он не привязан к конкретным инструментам и применим как к печатным, так и к экранным форматам.

Кому это нужно: техническим писателям, информационным дизайнерам, разработчикам, которые встраивают подсказки в интерфейс, и техническим иллюстраторам.

Чем отличаются ISO/IEC/IEEE 26513 и 26514: сравнение стандартов

На первый взгляд документы похожи. Оба посвящены информации для пользователей. Оба входят в серию ISO/IEC JTC 1/SC 7. Оба поддерживают интерес пользователей в получении согласованной, полной, точной и пригодной к использованию документации.

Разница — в точке зрения и назначении. Один отвечает за создание документации, другой — за ее тестирование. Вместе они покрывают полный цикл: от проектирования до проверки качества.

Параметр ISO/IEC/IEEE 26513 ISO/IEC/IEEE 26514
Кто Тестировщики и рецензенты Проектировщики и разработчики
Что Как проверять документацию Как создавать документацию
Детализация Минимальные требования Более детальные требования
Объект Процесс тестирования и рецензирования Процесс разработки + структура и формат продукта
Актуальная версия 2017 (черновик новой редакции — 2026) 2022

Важный нюанс: 26514 детальнее, чем 26513. Даже если сравнивать с минимальными требованиями 26513, требования 26514 более проработанные. Это логично: чтобы что-то проверять, нужно сначала это что-то создать. Требования к созданию неизбежно сложнее требований для проверки.

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

Мини-тест: 26513 или 26514?

Выберите, к какому стандарту относится утверждение

Правильных ответов: 0 из 10

Как применять стандарты ISO/IEC/IEEE 26513 и 26514 на практике

26513: как проверять и тестировать документацию

Главная ценность 26513 — процесс. 26513 дает не абстрактные пожелания, а конкретные этапы проверки: от планирования тестирования до фиксации дефектов.

На практике это выглядит так:

  • Вы берете готовый раздел документации.
  • Проходите по чек-листу из приложения A — там сжато, на несколько страниц, изложены минимальные требования.
  • Фиксируете, где текст не соответствует этим требованиям.
  • Вносите правки или передаете замечания автору.

Чек-листы из 26513 — это не про "проверить орфографию". Они про содержательные вещи: согласованность терминологии, полноту информации, точность описаний, пригодность к использованию.

Документ также описывает виды тестирования: документационное ревью, системное и юзабилити-тестирование, проверку доступности, локализацию и кастомизацию. Для каждого вида — свои методы и критерии.

Важно: 26513 оценивает только текст, а не сам продукт. Если в справочнике ошибка — это дефект материала, даже если продукт работает правильно.

Пример из практики: как стандарт 26513 помогает находить скрытые дефекты

Чтобы понять разницу между формальным подходом и работой по стандарту, рассмотрим пример из разработки документации для промышленного станка.

Обычный текст (без стандартов):

"Перед началом работы на станке оператор должен убедиться в стабильности параметров питающей сети и исправности защитных цепей".

Что видит аудитор при проверке по требованиям ISO/IEC/IEEE 26513:

С точки зрения проверяющего, такая формулировка содержит критический дефект полноты и точности: понятия "стабильность" и "исправность" не имеют объективных критериев проверки. Оператор не сможет однозначно понять, соответствуют ли параметры допускам.

Исправленный вариант по стандарту:

"Перед началом работы убедитесь, что напряжение в силовой сети находится в допустимом диапазоне по ГОСТ 32144-2013 (342–418 В для трехфазной сети 380 В), а сопротивление защитного заземления не превышает 4 Ом по показаниям мультиметра".

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

Следующий пример.

Обычный текст (без стандартов):

"В случае возникновения нештатной ситуации или появления дыма немедленно выключите оборудование главной кнопкой и покиньте помещение".

Что видит аудитор по стандарту 26513:

Инструкция не указывает точное расположение "главной кнопки", отсутствует порядок действий, а формулировка "покиньте помещение" слишком размыта для регламента безопасности.

Исправленный вариант по стандарту:

"При появлении признаков задымления или аварийного сбоя нажмите аварийный выключатель (красная грибовидная кнопка S1 на передней панели операторского терминала), обесточьте цех вводным рубильником QS1 и действуйте согласно инструкции предприятия по пожарной безопасности".

Пример проектирования раздела по требованиям к экранам (ISO/IEC/IEEE 26514)

Обычный текст (без стандартов):

"Для настройки скорости вращения шпинделя перейдите в меню параметров и введите новое значение в поле ввода".

Что требует стандарт 26514 (проектирование экранной документации):

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

Исправленный вариант по стандарту:

"Для настройки скорости вращения шпинделя выберите пункт меню [Настройки] > [Привод]. В поле «Скорость (об/мин)» введите значение в диапазоне от 100 до 3000 и нажмите кнопку [Применить]. Текущий статус изменения отобразится в строке состояния зеленым индикатором".

26514: как проектировать и создавать документацию

26514 начинается не с открытия MS Word, а с вопроса: какая информация нужна пользователям? Это принципиальный момент: документация — не результат, а процесс.

Первая часть стандарта описывает, как:

  • Определить потребности пользователей в информации.
  • Выбрать способ представления этой информации (печатное руководство, онлайн-справка, встроенные подсказки, видео).
  • Подготовить информацию и сделать ее доступной.

Вторая часть — про продукт: структуру, содержание и формат. Здесь уже видна конкретика: какие разделы должны быть в руководстве, как оформлять предупреждения, как строить навигацию.

26514 не привязан к инструментам — можно работать в Word, можно в Markdown, можно в специализированных СКД.

Особое внимание — электронной документации. 26514 содержит детальные требования к онлайн-справке, встроенным подсказкам и другим электронным форматам. Стоит также учитывать IEC/IEEE 82079-1:2019 — горизонтальный, он задает общие принципы подготовки информации по применению для широкого класса продуктов и прорабатывает тему цифровых носителей. При этом 82079-1 и линейка 26513/26514 решают разные задачи: первый — общие принципы, вторая — специфический инструментарий для проектирования информации в ПО.

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

Как интегрировать стандарты документации в рабочий процесс

Документация как часть жизненного цикла продукта

Оба стандарта подчеркивают: работа с информацией для пользователей идет параллельно с разработкой продукта, а не отдельным этапом в конце. 26513 требует тестирования на протяжении всего процесса управления информацией. 26514 требует проектирования информации как части жизненного цикла.

На практике это означает:

  • Технический писатель входит в команду на этапе планирования.
  • Материал проходит ревью вместе с кодом.
  • Проверка текста идет параллельно с тестированием продукта.

Создание и тестирование документации: два стандарта в связке

В идеальном мире вы используете и тот, и другой:

  • 26514 — чтобы проектировать и создавать документацию.
  • 26513 — чтобы проверять, что созданное соответствует требованиям.

Это как строительство и приемка. Строить можно и без приемки, но результат будет непредсказуемым.

С чего начать внедрение нормативов

Если вы работаете в компании, где нормативы не применяются, не пытайтесь внедрить их "сверху" за один день. Начните с малого:

  1. Возьмите чек-лист из 26513 (приложение A). Пройдите по нему с текущим материалом. Зафиксируйте, что не соответствует.
  2. Посмотрите на структуру глазами 26514. Есть ли в ней всё, что требуется? Хватает ли информации пользователю?
  3. Встройте проверку в процесс ревью. Не как "посмотреть, красиво ли", а как системную проверку по критериям из стандарта.
  4. Постепенно внедряйте процесс проектирования: сначала определяйте потребности пользователей, потом — способы подачи информации, потом — пишите.

Скрытые сложности стандартов документации ISO/IEC/IEEE 26513 и 26514

Нормативы есть — компетенций нет

26514 требует от техписателя навыков информационного архитектора. 26513 требует понимания процессов тестирования.

На практике это означает, что внедрение нормативов тянет за собой обучение или найм людей с соответствующими компетенциями. И это затраты, которые часто не закладывают в бюджет заранее.

Стандарты не диктуют инструменты

26514 не говорит, в каком редакторе работать. 26513 не говорит, как автоматизировать проверку. Это осознанное решение — требования про что, а не про как. Но для команды, привыкшей к готовым решениям, это превращается в проблему: "Мы прочитали стандарт, но не знаем, с чего начать".

Решение — сочетать нормативы с практическими руководствами. В частности, IEC/IEEE 82079-1:2019 задаёт общие принципы подготовки информации по применению и дает конкретику по структуре и формату, а 26514 дополняет их требованиями к электронной документации и процессам разработки.

Тестирование доступности и локализации

Стандарты требуют тестирования доступности, локализации, юзабилити. Но в реальных проектах на это редко выделяют ресурсы.

Что делать: начинать с малого. Не проводить полноценное юзабилити-тестирование, а хотя бы показывать документацию реальным пользователям и смотреть, понимают ли они ее. Это уже лучше, чем ничего.

Актуальные версии стандартов: 26513:2017 и 26514:2022

ISO/IEC 26514:2008 отменен. Актуальная версия — ISO/IEC/IEEE 26514:2022. Старая версия ISO/IEC 26513:2009 была заменена версией ISO/IEC/IEEE 26513:2017, которая действует до сих пор. Новая редакция находится в разработке: черновик ISO/IEC/IEEE DIS 26513 был опубликован в 2026 году, но пока не заменил действующую версию.

Следить за обновлениями — отдельная работа. Если вы ссылаетесь на стандарт в документации или контракте, убедитесь, что ссылаетесь на актуальную версию.

Стандарты — это минимум: что делать дальше

И 26513, и 26514 устанавливают минимальные требования. Это не означает, что, выполнив их, вы сделали идеальную документацию. Это означает, что вы сделали документацию, которая не проваливает проверку.

А если и этот минимум не выполнен — вопрос переходит из плоскости качества в плоскость ответственности. Кто несет ответственность за ошибку в инструкции, если оператор пострадал из-за неоднозначной формулировки? Эти вопросы мы разбираем в отдельной статье: Кто отвечает за ошибки в руководстве пользователя: правовая ответственность в 2026 году.

Хорошая документация требует большего: понимания пользователей, итеративной доработки, постоянного тестирования.

Заключение

ISO/IEC/IEEE 26513 и 26514 — не конкурирующие документы, а две половины одного процесса. Один описывает, как проектировать и создавать пользовательскую информацию. Второй — как проверять, что созданное работает. Вместе они закрывают полный цикл: от анализа потребностей пользователя до подтверждения качества документации.

  • Стандарты ISO/IEC/IEEE 26513 и 26514 покрывают полный цикл работы с документацией для промышленного оборудования: от создания до тестирования. 26514 — про то, как проектировать и разрабатывать документацию. 26513 — про то, как проверять, что она соответствует требованиям.
  • 26514 детальнее, чем 26513. Он требует проектирования документации как части жизненного цикла продукта, а не отдельного этапа.
  • На практике они применяются не изолированно. 26514 помогает спроектировать документацию, 26513 — проверить, что она соответствует требованиям.
  • Их внедрение упирается не в покупку документа, а в компетенции команды.
  • Стандарты устанавливают минимум. Хорошая документация требует большего: понимания пользователей, тестирования, итераций.
  • Следите за актуальными версиями. Требования обновляются, и ссылаться на устаревшие — рисковать.
  • Начинайте с малого: возьмите чек-лист из 26513, проверьте по нему текущую документацию. Это даст больше пользы, чем чтение от корки до корки.
  • Документация — это не текст. Это информация, которая позволяет пользователю работать с продуктом. Стандарты помогают сделать эту информацию качественной, но не заменяют здравый смысл и знание своей аудитории.

Практический вывод простой: не нужно внедрять всю серию 265xx сразу. Достаточно взять чек-лист из приложения A стандарта 26513, пройти по нему с текущей документацией и зафиксировать разрывы. Если же вопрос стоит шире — как создать пользовательскую документацию, которая пройдёт проверку и не потребует переделки, — начните с проектирования по 26514, а затем проверьте результат по 26513.


Смотрите также