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 — требования для тестировщиков и рецензентов

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

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

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

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 — это горизонтальный стандарт: он задаёт общие принципы для широкого класса продуктов, в том числе про цифровые носители. Но задачи у него и у линейки 26513/26514 разные: 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: версия 2017 года прямо сейчас пересматривается, новая редакция уже на выходе. Если вы сослались на неё в контракте год назад, через несколько месяцев ссылка может оказаться на устаревшую редакцию. Поэтому в документации и контрактах мало просто указать номер стандарта — нужно проверять, что редакция актуальна на момент подписания.

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

И 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.


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