что такое user guide и зачем он нужен
Руководство пользователя
Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.
Большинство руководств пользователя помимо текстовых описаний содержит изображения. В случае программного обеспечения, в руководство обычно включаются снимки экрана, при описании аппаратуры — простые и понятные рисунки или фотографии. Используется стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до минимума либо подробно объясняется.
Содержание
Содержание
Типичное руководство пользователя содержит:
Все главы и пункты, а также рисунки и таблицы, как правило, нумеруются, с тем, чтобы на них можно было сослаться внутри документа или из другого документа. Нумерация также облегчает ссылки на части руководства, например, при общении пользователя со службой поддержки.
Стандарты
Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
Руководство пользователя для пользователя
Екатерина Филатова, 12.06.2006
Известно, что пользователи часто даже не заглядывают в инструкции, прилагаемые к программным продуктам, предпочитая постигать все премудрости работы программы на практике. Получается, что руководство, призванное помочь пользователю, никак не облегчает его жизнь, а многие полезные функции программного продукта так и остаются недопонятыми и невостребованными. Почему так происходит?
Очевидны две базовые проблемы. Авторы руководств:
Выход прост, но используется лишь частично: создаваемое руководство пользователя должно соответствовать своему названию — объяснять и помогать, а не просто описывать функциональность программы. То есть автору руководства следует хорошо представлять себе:
И с учетом этих представлений создавать текст руководства.
Главными составляющими качества руководства пользователя, безусловно, являются его структура и собственно текст. И от того, насколько эти составляющие отвечают нуждам пользователя, зависит качество всего руководства.
Структура руководства
Большая, детально разработанная и разветвленная структура руководства, с одной стороны, является показателем профессионализма технического писателя, однако, с другой стороны, часто запутывает пользователя. В поисках нужной информации приходится долго и нудно просматривать многостраничное содержание, состоящее из множества пунктов и подпунктов. А ответ на вопрос, как лучше выполнить ту или иную задачу, может находиться в нескольких различных разделах, посвященных разным функциям программного продукта, причем последовательность в описании действий пользователя иногда нарушается.
Заглянув в такое руководство и потратив впустую некоторое время, пользователь вряд ли воспользуется им вновь. Поэтому очевидно, что:
Попробуем применить эти принципы к конкретному руководству. Проанализируем структуру руководства пользователя для работы с Автоматизированной информационно-аналитической системой «Библиотека». Его содержание:
Как видно, структура этого руководства довольно большая и нечеткая, формулировки расплывчаты, разделы дублируют друг друга. Рассмотрим наиболее характерные ошибки и способы их решения:
С учетом обозначенных замечаний получаем более простую и логичную структуру руководства:
Приведенное в качестве примера руководство вполне обычно. Инструкций подобного качества, к сожалению, множество. Собственно именно это и заставляет многих авторов и пользователей считать, что руководство пишется ради самого руководства («чтобы было»), и никто его не читает. Но эту ситуацию вполне можно изменить.
Безусловно, помимо правильной разбивки текста существуют и другие важные условия, необходимые для создания практичного руководства, например:
Игнорирование любой из этих деталей способно испортить руководство и затруднить восприятие текста пользователем. Однако здесь нужно не перестараться и не перегрузить текст лишними деталями. Пестрящий подчеркиваниями, предупреждениями и ссылками текст рассеивает внимание читателя. Обо всех особенностях текста и верстки необходимо рассказать пользователю в начале руководства.
Краткость и стиль
Хорошее руководство пользователя отличается не только продуманной структурой, но и качеством текста. Установленных критериев здесь нет, так же как нет единого стиля. Главные принципы — текст руководства должен давать пользователю четкие и исчерпывающие ответы, не перегружать читателя лишними и не нужными ему техническими деталями, легко читаться и быть грамотным.
Как применить эти принципы на практике рассмотрим на примерах с типичными ошибками.
Список может содержать информацию ссылочного типа. Стандартным действием для просмотра этой информации является нажатие клавиши Enter для выбранной строки списка. В том случае, когда для ссылочной информации предусмотрен режим редактирования в отдельной форме, открывается эта форма. Если информация для списка находится в состоянии «Только просмотр» (не разрешено редактирование), то информация в открываемой форме тоже будет недоступна для редактирования.
Это тяжело читаемый, слишком большой и стилистически неправильный текст, отдающий канцеляризмом. В него приходится вчитываться, чтобы понять, о чем же идет речь. Пользователю придется потратить много сил, чтобы выудить из такого руководства нужную информацию. А ведь достаточно всего лишь сообщить, что пункты списка могут быть ссылками, ведущими на отдельную форму с подробной информацией, а также объяснить, в каких ситуациях и для чего он может менять эту информацию.
Пользователей в системе могут заводить администраторы или руководители подразделений. Существует еще один способ заведения пользователей в системе. Пользователь может сам подать заявку на регистрацию, которая должна быть одобрена администратором.
Расплывчатая формулировка с повторами, не объясняющая разницу в регистрации. Следует указать, что существуют именно два способа, и разъяснить когда именно применяется каждый их них.
Перед тем, как начинать вводить данные в программу, необходима предварительная настройка программы, т.к. не всегда значения по умолчанию могут отвечать специфике вашей организации.
Нет нужды изъясняться так длинно и витиевато, к тому же это предложение несогласованно. Достаточно написать Перед началом работы установите параметры, соответствующие вашей организации.
В этой части базы данных отображается вся информация об учете. Выражаясь более подробно, можно сказать, что здесь находятся все акты, сопроводительные документы, личные дела сотрудников, формы суммарного и индивидуального учета, читательские формуляры.
Лишние и вводные слова затрудняют восприятие текста. Кроме того, создается впечатление, что автор сам не уверен в написанном. Здесь хранится вся учетная информация: акты документы, формы и т.д.
Ниже приведена рекомендуемая последовательность действий, которую необходимо произвести перед началом работы.
Такой шаблонно-бюрократический текст не только непонятен, но и отпугивает пользователя. Руководство, написанное похожим языком, вряд ли когда-либо будут читать. Фраза Перед началом работы выполните следующие действия проще в разы.
Для возможности составления акта поступления литературы необходимо составить список источников поступления.
Главным действующим лицом здесь должен быть не некий документ, а пользователь, который собственно и должен уяснить, что без списка источников он не сможет создать нужный документ. Помимо этого, фраза для возможности составления безграмотна.
Для работы с программой необходимо, чтобы в базе данных было зарегистрировано ваше учреждение, были назначены подразделения библиотеки, было сформировано строение книг суммарного и индивидуального учета, был подготовлен список читателей.
Элементарные грамматические ошибки или обычные недочеты, как в данном случае — многократное повторение слова «было», не добавят доверия к руководству и его автору.
Выводы
Итак, если руководство пользователя создается для пользователя, а не для описания программного продукта, оно должно отвечать нескольким требованиям:
Что такое UserGuide.exe? Это безопасно или вирус? Как удалить или исправить это
Что такое UserGuide.exe?
UserGuide.exe это исполняемый файл, который является частью Руководства пользователя Программа, разработанная Lenovo, Программное обеспечение обычно о 26.11 MB по размеру.
UserGuide.exe безопасный, или это вирус или вредоносная программа?
Первое, что поможет вам определить, является ли тот или иной файл законным процессом Windows или вирусом, это местоположение самого исполняемого файла. Например, такой процесс, как UserGuide.exe, должен запускаться из C: \ Program Files \ Lenovo \ UserGuide \ UserGuide.exe, а не где-либо еще.
Если статус процесса «Проверенная подписывающая сторона» указан как «Невозможно проверить», вам следует взглянуть на процесс. Не все хорошие процессы Windows имеют метку проверенной подписи, но ни один из плохих.
Наиболее важные факты о UserGuide.exe:
Если у вас возникли какие-либо трудности с этим исполняемым файлом, перед удалением UserGuide.exe вы должны определить, заслуживает ли он доверия. Для этого найдите этот процесс в диспетчере задач.
Найдите его местоположение (оно должно быть в C: \ Program Files \ Lenovo \ UserGuide \) и сравните его размер с приведенными выше фактами.
Если вы подозреваете, что можете быть заражены вирусом, вы должны немедленно попытаться это исправить. Чтобы удалить вирус UserGuide.exe, вам необходимо Загрузите и установите приложение полной безопасности, например Malwarebytes., Обратите внимание, что не все инструменты могут обнаружить все типы вредоносных программ, поэтому вам может потребоваться попробовать несколько вариантов, прежде чем вы добьетесь успеха.
Могу ли я удалить или удалить UserGuide.exe?
Не следует удалять безопасный исполняемый файл без уважительной причины, так как это может повлиять на производительность любых связанных программ, использующих этот файл. Не забывайте регулярно обновлять программное обеспечение и программы, чтобы избежать будущих проблем, вызванных поврежденными файлами. Что касается проблем с функциональностью программного обеспечения, проверяйте обновления драйверов и программного обеспечения чаще, чтобы избежать или вообще не возникало таких проблем.
Распространенные сообщения об ошибках в UserGuide.exe
Наиболее распространенные ошибки UserGuide.exe, которые могут возникнуть:
• «Ошибка приложения UserGuide.exe».
• «Ошибка UserGuide.exe».
• «Возникла ошибка в приложении UserGuide.exe. Приложение будет закрыто. Приносим извинения за неудобства».
• «UserGuide.exe не является допустимым приложением Win32».
• «UserGuide.exe не запущен».
• «UserGuide.exe не найден».
• «Не удается найти UserGuide.exe».
• «Ошибка запуска программы: UserGuide.exe».
• «Неверный путь к приложению: UserGuide.exe».
Как исправить UserGuide.exe
Если у вас возникла более серьезная проблема, постарайтесь запомнить последнее, что вы сделали, или последнее, что вы установили перед проблемой. Использовать resmon Команда для определения процессов, вызывающих вашу проблему. Даже в случае серьезных проблем вместо переустановки Windows вы должны попытаться восстановить вашу установку или, в случае Windows 8, выполнив команду DISM.exe / Online / Очистка-изображение / Восстановить здоровье, Это позволяет восстановить операционную систему без потери данных.
Чтобы помочь вам проанализировать процесс UserGuide.exe на вашем компьютере, вам могут пригодиться следующие программы: Менеджер задач безопасности отображает все запущенные задачи Windows, включая встроенные скрытые процессы, такие как мониторинг клавиатуры и браузера или записи автозапуска. Единый рейтинг риска безопасности указывает на вероятность того, что это шпионское ПО, вредоносное ПО или потенциальный троянский конь. Это антивирус обнаруживает и удаляет со своего жесткого диска шпионское и рекламное ПО, трояны, кейлоггеры, вредоносное ПО и трекеры.
Мы рекомендуем вам попробовать это новое программное обеспечение, которое исправляет компьютерные ошибки, защищает их от вредоносных программ и оптимизирует производительность вашего ПК. Этот новый инструмент исправляет широкий спектр компьютерных ошибок, защищает от таких вещей, как потеря файлов, вредоносное ПО и сбои оборудования.
Загрузите или переустановите UserGuide.exe
Вход в музей Мадам Тюссо не рекомендуется загружать заменяемые exe-файлы с любых сайтов загрузки, так как они могут содержать вирусы и т. д. Если вам нужно скачать или переустановить UserGuide.exe, мы рекомендуем переустановить основное приложение, связанное с ним Руководства пользователя.
Информация об операционной системе
Ошибки UserGuide.exe могут появляться в любых из нижеперечисленных операционных систем Microsoft Windows:
Как с помощью руководства пользователя повысить качество информационной системы
В действительности все совершенно иначе, чем на самом деле.
Антуан де Сент-Экзюпери
Многое в разработке руководства пользователя регламентировано и описано ГОСТами. Но при создании больших гетерогенных систем могут возникать вопросы, не до конца освещенные этими документами.
Отношение к руководству пользователя бывает разным. Многие совсем не задаются вопросом, каковы место и роль документа в процессе разработки больших гетерогенных информационных систем, для других же все и так ясно. Не спешите. В статье мы рассмотрим подходы к организации процесса создания и поддержания в актуальном состоянии этого важного документа, оценим значимость руководства пользователя для всей информационной системы в целом и придем к некоторым неожиданным выводам.
Статья будет полезна для тестировщиков, технических писателей, аналитиков и даже для руководителей проектов.
Описание проблемы
Некоторое время назад я в качестве аналитика начала работу на проекте по разработке информационной системы федерального масштаба. Для быстрого погружения в предметную область мне было предложено заняться руководством пользователя: провести аудит и организовать процесс доработки документа под стремительно расширяющийся функционал системы.
Отдельно остановлюсь на особенностях проекта, поскольку подходы и принципы, о которых пойдет речь, разработаны и адаптированы специально для следующих условий.
1. Масштаб.
Большая гетерогенная распределенная информационная система, которая включает десятки взаимодействующих между собой подсистем.
2. Параллельная разработка.
Из-за масштаба системы над ней работают изолированные команды аналитиков, разработчиков и тестировщиков.
3. Частые изменения.
Опять же следствие масштаба — постоянный поток изменений и доработок.
4. Относительно универсальный и стандартизированный набор бизнес-процессов в рамках проекта.
БОльшая часть процессов имеет постоянную сходную с другими бизнес-процессами часть.
Даже поверхностный взгляд на актуальную на тот момент версию руководства пользователя позволил сделать вывод о невысоком качестве документа. Основных проблем было две: неактуальность и отсутствие единообразия при описании сходных функций и процессов.
Низкое качество руководства пользователя может привести к ряду негативных последствий для всего проекта. Выделю основные:
Поиск решения
Для каждой проблемы был разработан собственный подход. Рассмотрим каждую проблему и каждый подход более подробно.
Неактуальность документа
Неактуальность документа содержит два класса проблем: устаревшее описание имеющегося функционала и отсутствие описания новых возможностей системы. Алгоритм устранения проблемы был выбран такой.
После этого была проведена каталогизация всех описаний (актуальная проблема, поскольку общее количество описаний превышало 100 шт.). Если процесс был описан в руководстве пользователя, то в ячейке на пересечении соответствующих строки и столбца проставлялся номер пункта (раздела).
Далее наглядным индикатором «Светофор» были отмечены результаты сравнения:
Рисунок 1
Началась работа над документом. Подспорьем на данном этапе опять же стала таблица: если процесс редактируется в одном блоке, то и в другом он создается схожим процентов на 80 образом.
Общее количество описаний функций в руководстве пользователя – более сотни, типовых – 25.
Дальнейшая обработка описаний потребовала дополнительной градации: ярко-зелёный — для сценариев, в которых всё хорошо и правки не требуются; светло-зеленый – для сценариев, которые в целом описаны правильно и нуждаются только в исправлении некоторых моментов; оранжевый – для тех, которые принципиально неправильно описаны и которые необходимо править в первую очередь.
Рисунок 2
В итоге общая картина предстала в цвете: были видны обширные оранжевые пятна проблемных областей, много светло-зеленого и практически отсутствие ярко-зеленого.
Таблица соответствия в ходе работы над документом:
Рисунок 3
По завершении «покрасочных» работ обозначились приоритеты:
Отсутствие единообразия
При решении этой проблемы ставилась задача обеспечить единообразие при описании сходных процессов (кейсов) и существенно сократить трудозатраты на обновление и поддержание документа. Был выбран подход, в соответствии с которым описание каждого процесса представляется в виде строительного блока (1), а сам документ – их комбинации (3). Все строительные блоки должны располагаться в репозитории (Wiki) с обязательным контролем изменений и поддержкой версионности (2).
Рисунок 4
Основное преимущество данного подхода заключается в существенном сокращении трудозатрат: при создании и редактировании общей части строительного блока правки вносятся только один раз. Сборка руководства пользователя из строительных блоков происходит также гораздо быстрее по сравнению с традиционным вариантом.
Принципиально важный момент: доступ к репозиторию должен быть обеспечен всем командам, работающим над проектом, согласно сформированному регламенту его использования.
Используя такой подход для актуализации и метод «строительных блоков» для сборки, документ удалось за короткий срок привести в надлежащее состояние. Трудозатраты сократились более чем на 30%, по сравнению с традиционным методом формирования документа. Казалось бы, на этом месте можно было бы обозначить happy end, но мне бы хотелось продолжить. Будет интересно.
Место руководства пользователя в цикле управления требованиями
Качественное руководство пользователя получило новые функции, отлично встроилось в систему управления требованиями и общий цикл разработки (независимо от того, последовательная она или итеративная) информационной системы.
В классический цикл разработки от анализа требований (1) до тестирования (4) добавляется этап подготовки документов, среди которых особое место занимает руководство пользователя. Почему же так важен этот документ? По нескольким причинам. В случае параллельной независимой разработки отдельных подсистем возможна потеря унификации (например, расположение управляющих элементов, наименования и т.д.). Именно при подготовке руководства пользователя становятся видны неувязки/несоответствия, как в функциональной плоскости, так и на уровне пользовательских интерфейсов.
Рисунок 5
Только на уровне руководства пользователя система видна целиком, а не как набор отдельных подсистем. Концепция строительных блоков позволяет решить проблему неувязок, но только в случае использования репозитория при разработке постановочной части в качестве справочных материалов. Таким образом, у руководства появляется новая категория пользователей – аналитики и тестировщики. И, конечно, документ должен быть синхронизирован и полностью соответствовать пользовательским требованиям. На этом этапе проводится дополнительная верификация на предмет соответствия пользовательских требований разработанным функциям (руководство пользователя, фактически, содержит бизнес-описание системы).
Из рисунка 5 хорошо видно, что процесс разработки финализируется созданием руководства. Этот документ также активно используется на других этапах разработки.
Рисунок 6
Выводы
Качественно и грамотно составленное руководство, которое содержит актуальное описание автоматизируемых функций, становится важным и востребованным у конечных пользователей и разработчиков документом и приобретает некоторые новые функции:
P.S. В статью не вошли вопросы содержательности элементов и разделов руководства пользователя. Подробно это рассмотрено и регламентировано подразделом 3.4 документа РД 50-34.698-9 и стандартом IEEE 1063-2001.
Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
Обобщенная структура руководства пользователя, построенная на основе анализа перечисленных стандартов, приведена здесь. Общую методологию можно посмотреть в этой статье.
Зачем нужен мануал
Представить трудно, но в наше время некоторые люди до сих пор не умеют правильно читать. Это надо понимать так: люди не умеют читать инструкции, люди не умеют получить нужную им в данный конкретный момент информацию.
А если человек не умеет «читать» на необходимом уровне, то его ждет беда. Вот почему президент Ассоциации школьных библиотек России Татьяна Жукова считает, что именно это приводит к всевозможным техногенным катастрофам.
Наверное, в наше время найдется еще немало каких-то других причин, которые приводят к чрезвычайным происшествиям. Однако так называемая функциональная неграмотность будет не на последнем месте в печальном списке возможных причин аварий и катастроф. И для того, чтобы ничего подобного не происходило, и существуют так называемые инструкции по эксплуатации.
Что представляет собой этот документ, понять нетрудно. В нем подробно описывается какое-то устройство, а также приводятся правила того, как необходимо пользоваться им. И совсем неважно, что представляет собой это устройство. Это может быть телевизор или компьютер, микроволновая печь или стиральная машина.
Однако все они требует к себе пристального внимания. В том смысле, что во время работы с ними обязательно необходимо соблюдать всё, что написано в инструкции. В противном случае любая машина выходит из строя, а хуже всего, когда это сопровождается травматизмом.
Проявляя заботу о своем клиенте и потребителе, производители всех изделий готовят для них специальные буклеты с подробной инструкцией по эксплуатации. Они обязательно входят в комплект поставки.
Если кто-то называет эту инструкцию по эксплуатации мануалом (manual), то не удивляйтесь. Речь идет об одном и том же. А user guide или user manual в переводе с английского, как нетрудно догадаться, означает руководство по эксплуатации, руководство оператора.
Там есть вся необходимая информация. Что представляет собой изделие? Какие у него части и механизмы? Как необходимо последовательно производить сборку? Как настраивать машину? Как включать и выключать? Ответы на эти и многие другие вопросы, вы найдете в том самом буклете.
Кстати, мануал необходимо воспринимать как солидную работу технического писателя. Это именно он порой очень сложные процессы во всевозможных устройствах описывает так, чтобы перенасыщенный терминами и понятиями язык технических работников был понятен каждой домохозяйке.
А чтобы читать такие тексты было несложно, в буклете обычно в помощь потребителю находится место и для всевозможных иллюстраций, чертежей, схем.
И все для того, чтобы человек все сделал по инструкции, а не как-то иначе. Причем на сегодня существует такое понятие, как пошаговая инструкция. Это означает, что постепенно, шаг за шагом, в определенном порядке, а не иначе следует выполнять требования руководства пользователя. И тогда все получится. Найдется там место и для правил безопасности при работе с оборудованием. Это обязательно! К сожалению, человеку всегда нужно напоминать о том, что электрический ток, работа всевозможных механизмов представляет опасность. Поэтому об этом обязательно пишут в руководствах пользователя тоже.
Причем необходимо подчеркнуть, что пишут все тексты на русском языке, если товар реализуется на территории России. Для любого товара, а уж тем более для какого-либо сложного технического устройства, это очень важно! И совсем не имеет значения, в какой стране произвели ту или иную машину, прибор, аппарат. Инструкция по эксплуатации должна быть только на русском языке.
Производитель обязан собственными силами разрабатывать инструкции по эксплуатации, но он также и заинтересован в этом сам. И потому он ищет неординарные формы подачи материала. То есть он может выполнить инструкцию не только в форме буклета, но в форме наклейки или надписей краской на самом устройстве. Когда мануал находится всегда перед глазами, то его предназначение в таком случае оправдано вдвойне.
Есть и другие формы достучаться до потребителя. Многие компании, особенно всемирно известные, считают необходимым размещать инструкции по эксплуатации в глобальной сети. Отдача от таких Интернет-ресурсов достаточно большая. Ведь при необходимости пользователь может посетить нужный ему сайт, чтобы что-то прочитать, что-то посмотреть и в итоге правильно пользоваться устройством, а тем самым значительно продлить сроки его эксплуатации.
Электронные версии инструкции по эксплуатации, причем в любом формате, сейчас приобретают все большую популярность и находят все большее использование. Пользователь, которому, например, нужен мануал по эксплуатации, может скачать его в pdf, doc, как и в любом другом формате. С учетом того, что у многих дома есть компьютер, электронная версия становится реальностью.
Но иногда бывают такие товары, которые сегодня уже в себе носят пошаговую инструкцию по эксплуатации. Таковым может быть, скажем, телевизор. Достаточно посмотреть на этом самом телевизоре соответствующие видеоролик, чтобы получить ответы на интересующие вопросы по эксплуатации.
Также при покупке можно получить компакт-диск с PDF-файлами. А это предполагает, что у владельца даже полностью автономного ИТ-гаджета обязательно есть дома или на работе компьютер или иное устройство, умеющее выводить PDF-файлы на экран, или печатающее устройство. Действующее законодательство поддерживает такой способ просвещения потребителей.
Остается добавить, что в документации, которая прилагается к товару, вы, конечно, можете найти информацию и о том, как ремонтируют устройство, а самое главное, где находится тот самый сервисный центр, который возьмется за восстановление нормальной работы вашего агрегата.