Как написать руководство пользователя информационной системы
Руководство пользователя - эксплуатационный документ, по которому сотрудник осваивает программу без помощи разработчика. Для автоматизированной системы оно строится по ГОСТ 34 из шести разделов: введение, назначение, подготовка к работе, описание операций, аварийные ситуации и рекомендации по освоению. Ниже порядок работы, примеры формулировок и список типичных ошибок.

Содержание
- Что такое руководство пользователя и кому оно нужно
- Какие стандарты применяются к руководству пользователя
- Из каких разделов состоит документ
- Как подготовиться к написанию
- Как описывать операции
- Описание ошибок и нестандартных ситуаций
- Оформление и проверка документа
- Типичные ошибки при написании
- Частые вопросы
Что такое руководство пользователя и кому оно нужно
Руководство пользователя - эксплуатационный документ, по которому сотрудник учится работать с программой или информационной системой без помощи разработчика. Оно отвечает на три вопроса: что система умеет, как подготовиться к работе и какие кнопки нажимать, чтобы получить нужный результат.
Читает его не аналитик и не программист, а бухгалтер, менеджер, диспетчер, оператор склада. У такого читателя нет задачи изучить систему. Есть конкретная задача на сегодня: создать заявку, выгрузить отчет, исправить ошибку в карточке клиента. Руководство пользователя должно давать ответ на нее за пару минут.
Если система сдается заказчику по договору, руководство входит в комплект обязательной документации, и без него акт приемки подписывают с замечаниями. Если система внутренняя, документ все равно окупается: новичков вводят в работу быстрее, а нагрузка на поддержку падает.
Какие стандарты применяются к руководству пользователя
Выбор стандарта зависит от того, что именно вы создаете. Для автоматизированной системы в целом действует комплекс ГОСТ 34, где руководство пользователя - один из документов эксплуатационной группы. Требования к его содержанию собраны в методических указаниях РД 50-34.698-90, а перечень документов - в ГОСТ 34.201-89.
Для отдельной программы применяется Единая система программной документации. Там аналогом служит руководство оператора по ГОСТ 19.505-79. Если у вас продукт с аппаратной частью, возможна и ЕСКД: правила эксплуатационных документов собраны в ГОСТ 2.601 и ГОСТ 2.610, а чем различаются эти семейства, разобрано в статье ЕСПД и ЕСКД.
| Что создается | Название документа | Где искать требования |
|---|---|---|
| Автоматизированная система | Руководство пользователя | ГОСТ 34.201 и РД 50-34.698 |
| Программа или программный комплекс | Руководство оператора | ГОСТ 19.505-79 |
| Изделие с программой и оборудованием | Руководство по эксплуатации | ГОСТ 2.601 и ГОСТ 2.610 |
| Коммерческий веб-сервис без госзаказа | Справка или инструкция в свободной форме | Требования заказчика, договор |
Готовая заготовка есть на сайте: шаблон руководства пользователя по ГОСТ 34 с разделами и подсказками. Ее можно взять за основу и заменить условный текст вашими данными.
Из каких разделов состоит документ
По методическим указаниям документ строится из шести частей. Порядок логичный: сначала общие сведения, затем подготовка, потом основная часть с операциями и в конце то, что нужно знать, когда что-то пошло не так.

| Раздел | Что в него входит | Пример для системы "Учет заявок" |
|---|---|---|
| Введение | Область применения, краткое описание возможностей, уровень подготовки пользователя, перечень связанных документов | Система предназначена для приема и обработки заявок сотрудников. Пользователь должен уметь работать в браузере |
| Назначение и условия применения | Для чего система, при каких условиях она работает, требования к рабочему месту | Браузер последних версий, доступ к корпоративной сети, учетная запись из каталога сотрудников |
| Подготовка к работе | Вход в систему, настройка рабочего места, проверка, что все запустилось | Открыть адрес системы, ввести логин, проверить, что виден список заявок |
| Описание операций | Пошаговые инструкции по каждой функции | Создание заявки, назначение исполнителя, закрытие, выгрузка отчета |
| Аварийные ситуации | Сообщения об ошибках, причины и действия пользователя | Сообщение "Нет доступа": обратитесь в службу поддержки с номером заявки |
| Рекомендации по освоению | С чего начать, в каком порядке изучать функции | Сначала создать пробную заявку в тестовом разделе |
Названия и порядок можно адаптировать под проект, если заказчик не требует жесткого соответствия. Главное, чтобы не терялась логика: введение, подготовка, операции, ошибки.
Как подготовиться к написанию
Самая частая причина слабых руководств - автор описывает то, что видит в техническом задании, а не то, что реально увидит пользователь. Поэтому первым шагом всегда идет знакомство с работающей системой, пусть даже тестовой версией.
Соберите исходные данные: техническое задание, список ролей, описание бизнес-процессов, макеты экранов. Затем поговорите с двумя-тремя будущими пользователями. Их вопросы и есть оглавление вашего документа.
- Определите роли и разделите пользователей на группы: рядовой сотрудник, руководитель, оператор поддержки. У каждой группы свой набор операций.
- Выпишите задачи каждой роли глаголами: создать, найти, согласовать, выгрузить. Каждая задача станет отдельным подразделом.
- Пройдите каждую задачу в системе сами и фиксируйте экраны, кнопки и сообщения дословно, с теми названиями, что стоят в интерфейсе.
- Определите уровень подготовки читателя и напишите его во введении. От этого зависит, нужно ли объяснять, что такое вкладка или фильтр.
- Согласуйте оглавление с руководителем проекта до того, как писать текст.
Не забудьте уточнить, в какой версии системы документ будет сдаваться. Интерфейс меняется, и документ, написанный по сборке трехмесячной давности, ввел в заблуждение не одну команду.
Как описывать операции
Раздел с операциями занимает до двух третей объема документа, и здесь работает один принцип: одна операция - один подраздел с названием из глагола. Не "Заявки", а "Создание заявки". Внутри идет нумерованный список шагов, где каждый шаг - одно действие.
Название кнопок и полей пишите так, как они выглядят на экране, прямыми кавычками: нажмите "Создать заявку". Если на кнопке иконка, укажите ее вид и подсказку. Результат шага не забывайте: пользователь должен понимать, что получилось.

Скриншоты со стрелками и номерами экономят много слов. Подписывайте их так, чтобы номер на рисунке совпадал с номером шага в тексте. Если интерфейс часто меняется, вставляйте не все экраны подряд, а только ключевые: форму, где легко запутаться, и результат операции.
Пример формулировок шагов
Хороший шаг короток и однозначен: "Откройте раздел "Заявки" и нажмите "Создать заявку". Откроется форма с пустыми полями". Плохой шаг расплывчат: "Создайте заявку в соответствующем разделе".
- Начинайте шаг с глагола в повелительном наклонении: откройте, введите, выберите, нажмите.
- Одно действие в одном шаге. Если нужно нажать две кнопки, это два шага.
- Не смешивайте инструкцию и пояснения. Причины и ограничения выносите в абзац после списка или в примечание.
- Для необязательных шагов пишите прямо: "Если нужно приложить файл, нажмите...".
Описание ошибок и нестандартных ситуаций
Раздел об аварийных ситуациях читают в самый нервный момент, поэтому он должен быть самым четким. Для каждого сообщения системы нужны три вещи: что оно означает, почему появилось и что делать пользователю.
| Сообщение системы | Причина | Что делать пользователю |
|---|---|---|
| Не заполнено обязательное поле | Поле "Тема заявки" осталось пустым | Введите тему и повторно нажмите "Создать заявку" |
| Сеанс завершен | Долгое отсутствие активности | Войдите в систему заново, несохраненные данные могут быть потеряны |
| Нет доступа к разделу | Роль пользователя не предусматривает эту функцию | Обратитесь к администратору и укажите название раздела |
Если система сообщает код ошибки, приведите код в таблице и добавьте контакты поддержки. Описание внутренних причин, настройки сервера и работу с журналами в руководство пользователя не включают: это материал для руководства администратора, подробности в статье руководство администратора.
Оформление и проверка документа
Руководство пользователя оформляют как любой текстовый документ проекта: титульный лист, лист утверждения, содержание, нумерация разделов и страниц. Если проект идет по ГОСТ, поля, шрифт и нумерацию берут из оформление по ГОСТ 2.105-2019, а таблицы и рисунки подписывают по правилам из оформление таблиц и рисунков.
Руководство не живет в изоляции. Оно входит в состав эксплуатационной документации, которая перечисляется в ведомости эксплуатационных документов. Какие документы нужны на каждой стадии проекта, поможет посмотреть инструмент ниже.
Перед сдачей проведите проверку на живом человеке. Посадите сотрудника, который не участвовал в разработке, и попросите выполнить задачи только по тексту. Все места, где он остановился, нужно переписать.
Типичные ошибки при написании
Большинство замечаний заказчика к руководствам пользователя повторяются от проекта к проекту. Их легко предупредить, если знать список заранее.
- Текст пересказывает техническое задание и не содержит ни одного шага работы.
- Названия кнопок в документе не совпадают с названиями в интерфейсе после очередного обновления.
- Описаны только правильные сценарии, ошибки и ограничения пропущены.
- Один документ пытается обслуживать и пользователя, и администратора, поэтому читать его неудобно обоим.
- Нет сквозной нумерации рисунков, и ссылки "см. рисунок выше" теряются.
- Нет версии документа и даты актуальности, непонятно, к какой сборке он относится.
Сопоставьте также свой документ с общей схемой комплекта: руководство пользователя дополняют паспорт и формуляр (подробнее о паспорте и формуляре), программа испытаний (как написать ПМИ) и другие материалы, описанные в обзоре эксплуатационной документации.
Частые вопросы
Чем руководство пользователя отличается от руководства администратора?
Руководство пользователя объясняет, как выполнять рабочие операции в интерфейсе. Руководство администратора описывает установку, настройку, права доступа, резервное копирование и устранение сбоев. Читатели у них разные, поэтому документы не объединяют.
Нужно ли оформлять руководство пользователя по ГОСТ?
Если система создается по ГОСТ 34 или договор требует соответствия стандартам, да. Для внутреннего сервиса достаточно понятной структуры и аккуратного оформления, но разделы по ГОСТ все равно хорошая основа.
Сколько страниц должно быть в руководстве?
Строгого объема нет. Для небольшой программы хватает 15-25 страниц, для сложной системы с несколькими ролями документ разбивают на отдельные руководства по ролям. Ориентируйтесь на то, сколько задач решает читатель.
Можно ли делать руководство в виде видеоинструкции?
Видео хорошо дополняет текст, но не заменяет его: по документу удобнее искать нужный шаг, а в договоре обычно названа текстовая форма. Короткие ролики можно подключить ссылками из раздела с операциями.
Как часто обновлять руководство пользователя?
После каждого релиза, который меняет интерфейс или порядок работы. В документе указывают версию системы и дату актуальности, а изменения фиксируют в листе регистрации изменений.