Генерация трафика что. Источники генерации трафика. Как выявить проблемы в дизайне и юзабилити
Документ «Руководство пользователя» относится к пакету эксплуатационной документации. Основная цель руководства пользователя заключается в обеспечении пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой.
Таким образом, документ Руководство пользователя должен отвечать на следующие вопросы: что это за программа, что она может, что необходимо для обеспечения ее корректного функционирования и что делать в случае отказа системы.
Руководящими стандартами для создания документа Руководство пользователя могут являться как РД 50-34.698-90 в п.п. 3.4. «Руководство пользователя» , так и ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению» . Ниже для сравнения приведены структуры документа согласно двум перечисленным стандартам.
| РД 50-34.698-90 (п.п. 3.4 Руководство пользователя) | ГОСТ 19.505-79 Руководство оператора |
Введение | |
Область применения | |
Описание возможностей | |
Уровень подготовки пользователя | |
Перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю | |
Назначение и условия применения | |
Виды деятельности и функции, для автоматизации которых предназначена программа | Назначение программы |
Условия, при которых обеспечивается применение программы | Условия выполнения программы |
Подготовка к работе | Выполнение программы |
Порядок загрузки данных и программ | Порядок загрузки, запуска и завершения программы |
Проверка работоспособности | |
Описание операций | Описание функций |
Описание всех выполняемых функций, задач, комплексов задач, процедур | |
Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур | |
Аварийные ситуации (действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных, и т.п.) | Сообщения оператору |
Таким образом, мы можем выделить следующие основные разделы руководства пользователя:
- Назначение системы;
- Условия применения системы;
- Подготовка системы к работе;
- Описание операций;
- Аварийные ситуации.
Назначение системы
Данный раздел документа Руководство пользователя должен содержать информацию о назначении системы, ее целях и задачах.
Пример:
«Корпоративный интранет портал предназначен для повышения корпоративной культурыр организации эффективного взаимодействия сотрудников.
Основной целью Порта является создание единого информационного пространства предприятия и оптимизация работы сотрудников путем облегчения коммуникаций между ними и оптимизации ряда бизнес-процессов.»
Условия применения системы
Данный раздел документа Руководство пользователя должен включать все те факторы, которые необходимы для корректной работы системы. Здесь можно выделить несколько подразделов:
- Требования к аппаратному обеспечению - сюда можно включить требования к конфигурации компьютера пользователя, программное обеспечение необходимое для работы Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.), если таковое необходимо;
- Квалификация пользователя - данный подраздел должен содержать требования к навыкам и знаниям пользователя (пример: «Пользователи должны обладать навыками работы с операционной системой Windows XP» );
Подготовка системы к работе
Данный раздел документа Руководство пользователя должен содержать пошаговую инструкцию для запуска приложения. К этапу подготовки системы к работе можно отнести установку дополнительных приложений (при необходимости), идентификацию, аутентификацию и т.п.
Описание операций
Это основной раздел документа Руководство пользователя, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем.
Если работа автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе.
Далее в документе Руководство пользователя следует представить описание функций разбитых на отдельные операции. Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения.
Пример:
«4.1 Согласование проекта
Данный процесс предназначен для организации работы сотрудников, участвующих в разработке и согласовании проекта.
Автор проекта создает запись в Системе и прикрепляет пакет необходимой документации, далее проект передается на согласование руководящими лицами. Руководители после ознакомления с проектом могут подтвердить его или отправить на доработку Автору.
4.1.1 Создание проекта
Для того чтобы создать Проект необходимо на панели «…» нажать на кнопку «…» и в появившейся форме заполнить следующие поля:
- Наименование проекта;
- Описание проекта;
Следующие поля заполняются автоматически:
- Дата создания проекта - текущая дата;
- Автор - ИФО и должность автора проекта.»
Руководство пользователя может представлять собой как краткий справочник по основному функционалу программы, так и полное учебное пособие. Методика изложения материала в данном случае будет зависеть от объема самой программы и требований заказчика.
Чем подробнее будут описаны действия с системой, тем меньше вопросов возникнет у пользователя. Для более легкого понимания всех принципов работы с программой стандартами в документе Руководство пользователя допускается использовать схемы, таблицы, иллюстрации с изображением экранных форм.
Для крупных автоматизированных систем рекомендуется создавать отдельное руководство для каждой категории пользователя (пользователь, модератор и т.п.). Если в работе с системой выделяются дополнительные роли пользователей, то в документе Руководство пользователя целесообразно поместить таблицу распределения функций между ролями.
Аварийные ситуации
Данный раздел документа Руководство пользователя должен содержать пошаговые инструкции действий пользователя в случае отказа работы Системы. Если к пользователю не были предъявлены особые требования по администрированию операционной системы и т.п., то можно ограничиться фразой «При отказе или сбое в работе Системы необходимо обратиться к Системному администратору».
Вам понадобится
- - стопроцентное знание устройства или программного продукта, для которого пишется руководство;
- - познания в области языкознания;
- - навыки писательского мастерства.
Инструкция
Руководство пользователя или, другими словами, руководство по эксплуатации – документ, призванный предоставить помощь в использовании некоторой системы ее пользователя м. Для составления руководства пользователя вам необходимо знать описываемую систему на все сто процентов, однако смотреть на нее глазами ничего не смыслящего . Предположим, руководство пользователя для некой программной утилиты, аналогов которой еще не было. Представьте, что вы столкнулись с этой программой впервые. С чего нужно начинать? Что необходимо знать в первую очередь? Систематизируйте эти знания, разбив их на категории важности.
Разбив всю информацию, касающуюся вашего творения, на группы, вы составили план для написания руководства пользователя . Начните описывать работу в вашей программе с азов, оставляя напоследок самые сложные детали, касающиеся, скажем, перепрограммирования возможностей или работе с критическими ошибками. На этом этапе у вас должно быть готово содержание руководства пользователя – одна из обязательных частей этого документа.
Если создаваемое вами руководство предназначено для использования в крупной компании, то стоит обратить внимание на принятые там корпоративные стандарты. К примеру, во многих российских компаниях руководство пользователей не принимаются без иллюстративного сопровождения, проще говоря, картинок, поясняющих написанное. В руководстве пользователя помимо содержания должны быть и другие обязательные части:- Аннотация, то есть пояснение общих задач руководства и описываемого продукта;- введение, в котором рассказывается о связанных с руководством пользователя документах и методах использования руководства;- разделы, поясняющие об использовании продукта на разных стадиях его использования, например, первые шаги, ремонт или профилактика;- раздел часто задаваемых вопросов и ответов на них;- глоссарий или .
Обычно созданием руководства пользователя занимается технический писатель – человек, имеющий все не обходимые познания как в языке, так и в описываемом продукте. Занимаясь деятельностью технического писателя без соответствующей подготовки, нужно помнить о нескольких правилах. Во-первых, нельзя злоупотреблять специальными терминами, не понятными для рядового пользователя . Во-вторых, каждый используемый термин должен быть подробно расписан и объяснен. В-третьих, писать нужно максимально понятно и лаконично. Наконец, технический писатель должен уметь смотреть на собственный текст глазами рядового пользователя , чтобы видеть недостатки собственного текста.
Руководство пользователя
Руководство пользователя (англ. user guide или user manual ), руководство по эксплуатации , руководство оператора - документ, назначение которого - предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем .
Большинство руководств пользователя помимо текстовых описаний содержит изображения. В случае программного обеспечения , в руководство обычно включаются снимки экрана , при описании аппаратуры - простые и понятные рисунки или фотографии. Используется стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до минимума либо подробно объясняется.
Типичное руководство пользователя содержит:
- Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение
- Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство
- Страницу содержания
- Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы
- Глава, описывающая возможные проблемы и пути их решения
- Часто задаваемые вопросы и ответы на них
- Где ещё найти информацию по предмету, контактная информация
- Глоссарий и, в больших документах, предметный указатель
Все главы и пункты, а также рисунки и таблицы, как правило, нумеруются, с тем, чтобы на них можно было сослаться внутри документа или из другого документа. Нумерация также облегчает ссылки на части руководства, например, при общении пользователя со службой поддержки.
Стандарты
Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора , Руководство программиста , Руководство системного программиста регламентированы ГОСТ 19.505-79 , ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
- Комплекс стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)
- РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
- Единая система конструкторской документации (ЕСКД) определяет документ «Руководство по эксплуатации» и другие документы:
- ГОСТ 2.601-2006 Эксплуатационные документы
- ГОСТ 2.610-2006 Правила выполнения эксплуатационных документов
- Единая система программной документации (ЕСПД) определяет документы «Руководство оператора», «Руководство по техническому обслуживанию» и их структуру:
- ГОСТ 19.101-77 Виды программ и программных документов
- ГОСТ 19.105-78 Общие требования к программным документам
- ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению
- ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению
См. также
Ссылки
- Руководство пользователя. Пример оформления по РД 50-34.698-90
- Бесплатные инструкции по эксплуатации бытовой электроники
- Сайт разработчиков технической документации (технических писателей)
- MetaGuide - руководство для разработчиков технической документации к программному обеспечению
- Типичные ошибки в справке пользователя для ПО и как их избежать
Wikimedia Foundation . 2010 .
Смотреть что такое "Руководство пользователя" в других словарях:
Сущ., кол во синонимов: 4 инструкция (28) мануалка (5) паспорт (17) … Словарь синонимов
руководство пользователя - — [Е.С.Алексеев, А.А.Мячев. Англо русский толковый словарь по системотехнике ЭВМ. Москва 1993] Тематики информационные технологии в целом EN user guidemanual …
руководство пользователя
руководство пользователя по аккредитации и подаче заявок на Олимпийские игры - [Департамент лингвистических услуг Оргкомитета «Сочи 2014». Глоссарий терминов] Тематики спорт (службы Игр) EN accreditation and entries at the Olympic Games users guide … Справочник технического переводчика
Руководство: Руководство контроль поведения других людей (см. Власть). Руководство набор правил для осуществления или использования чего либо (см. Инструкция). См. также Руководство пользователя Организационное руководство Руководство … Википедия
руководство для пользователя - — [А.С.Гольдберг. Англо русский энергетический словарь. 2006 г.] Тематики энергетика в целом EN user directory … Справочник технического переводчика
руководство для пользователя - vartotojo instrukcija statusas T sritis automatika atitikmenys: angl. user guide; user manual vok. Benutzeranleitung, f; Benutzerhandbuch, n rus. руководство для пользователя, n pranc. notice de présentation, f … Automatikos terminų žodynas
РУКОВОДСТВО ПО РАЗРАБОТКЕ БЮДЖЕТА - BUDGET MANUALРазработка бюджета может быть упрощена до определенной степени, если у фирмы имеется руководство по разработке бюджета, к рое документирует процедуру разработки и определяет основные направления, к рым необходимо следовать на… … Энциклопедия банковского дела и финансов
справочник пользователя - vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas
Р 50.1.041-2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации-пользователя - Терминология Р 50.1.041 2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации пользователя: 3.1.1 аккредитованная организация разработчик стандартов (accredited standards development… … Словарь-справочник терминов нормативно-технической документации
Книги
- Язык UML. Руководство пользователя , Буч Грэди. Эта книга будет изготовлена в соответствии с Вашим заказом по технологии Print-on-Demand. Унифицированный язык моделирования (Unified Modeling Language, UML) является графическим языком для…
Снова здравствуй, уважаемый хабралюд!
В продолжении своего поста решил написать, как лучше всего создавать инструкции для пользователей и администраторов.
Всем, кому интересно, прошу под хабракат.
KISS
Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.Для начала напишу несколько правил, которые помогут создать рабочий и удобный документ:
1.
Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2.
Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3.
Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4.
Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5.
Психологический момент - инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому - НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!
Пример инструкции для пользователей
Ниже приведен пример инструкции по заведению аккаунта пользователя в корпоративной сети.Clear screen/clear desk
Специфика российских организаций, работающих с советских времен и таких же умудренных опытом сотрудников такова, что у них, как правило, стол завален бумагами. Компьютер порой не выключается и не блокируется, даже когда уходят домой. Недавно лично видел, проходя поздно вечером мимо одного муниципального предприятия, как за открытыми жалюзи в закрытом на замок здании горел монитор с открытым на нём вордовским документом.Пользователи порой не догадываются о возможных непреднамеренных утечках информации. Пускай она не конфиденциальна, возможно она только для внутреннего пользования. Но это даёт понимание, что в этой организации не заботятся о своей безопасности и могут так поступить с конфиденциалкой. А так же возможно там будет информация, ещё не отнесенная к закрытой, но уже существующая во внутреннем обороте организации.
Хорошим примером из лучших практик здесь является политики чистого стола и чистого экрана. Их можно описать так же, как я приводил пример ранее, но это будет выглядеть немного глупо, так как действия там простейшие. Лучше просто сделать набором правил:
P.S. В посте приведены скрины реально внедренных и работающих инструкции и политик. Все совпадения с существующими организациями случайны. Все названия отделов и бюро изменены.
