Определение руководства пользователя

Руководство пользователя – это основной документ в составе эксплуатационной документации на автоматизированную систему (ГОСТ 34). Очевидно ли это?

Назначение руководства пользователя

Цель создания документа заключается в том, чтобы предоставить пользователю возможность самостоятельно решать свои прикладные задачи с помощью системы. Этой цели может служить и введение в предметную область, и ознакомление со всеми возможностями программы, и описание конкретных процедур решения задач, и приведение различных инструкций. Иногда Руководство пользователя больше похоже на справочник, к которому можно обращаться в процессе работы, а иногда – на учебник, который позволяет изучить принципы работы с программой и ее возможности, а затем применять их на практике.

Состав типового руководства пользователя

Конкретный подход к написанию определяется многими факторами:

– назначением программы и областью ее применения;

– сложностью программы;

– количеством разнообразных вариантов использования.

Принимая во внимание все различия и особенности, сложно привести структуру любого Руководства пользователя к одному виду. Тем не менее, РД 50-34.698 предлагает нам такой список разделов:

– Введение, где указывают область применения ПО, краткое описывают его возможности, требуемый уровень знаний пользователя и список документов, которые необходимо изучить помимо настоящего руководства;

– Назначение и условия применения, где описывают виды деятельности и функции, которые автоматизированы и условия, при соблюдении которых автоматизация используется;

– Подготовка к работе, где описывают комплектность дистрибутива, порядок установки и загрузки программы, а также способ проверки ее работоспособности;

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

– Аварийные ситуации, где описывают действия в нештатных ситуациях – сбоях в программе, ошибок в данных и т.д.;

– Рекомендации по освоению, где приводят методические рекомендации по изучению программы и примеры использования.

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

Стандарты для руководства пользователя

Наличие Руководства пользователя регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства пользователя могут отличаться друг от друга по способу, методике и стилю изложения.

Стоимость разработки руководства пользователя

Грамотно написанное Руководство пользователя может сэкономить значительное количество времени на обучение и адаптацию пользователя к программе, а также снизить количество ошибок в работе что, в свою очередь, повышает экономическую эффективность системы. Если вы не хотите вникать во все тонкости создания Руководства пользователя, но хотите иметь полный, качественный и полезный документ – обратитесь в компанию ТехРайтКонсалт, и мы применим весь наш опыт и знания для решения вашей задачи по доступной цене!

Возможно, вас также заинтересует:

– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства оператора.

From Wikipedia, the free encyclopedia

For a full guide to an item owned by its operator, see Owner’s manual.

A user guide, also commonly known as a user manual, is intended to assist users in using a particular product, service or application. It’s usually written by a technician, product developer, or a company’s customer service staff.

Most user guides contain both a written guide and associated images. In the case of computer applications, it is usual to include screenshots of the human-machine interface(s), and hardware manuals often include clear, simplified diagrams. The language used is matched to the intended audience, with jargon kept to a minimum or explained thoroughly.

Contents of a user manual[edit]

The sections of a user manual often include:

• A cover page
• A title page and copyright page
• A preface, containing details of related documents and information on how to navigate the user guide
• A contents page
• A Purpose section. This should be an overview rather than detail the objective of the document
• An Audience section to explicitly state who is the intended audience who is required to read, including optionals
• A Scope section is crucial as it also serves as a disclaimer, stating what is out-of-scope as well as what is covered
• A guide on how to use at least the main function of the system
• A troubleshooting section detailing possible errors or problems that may occur, along with how to fix them
• A FAQ (Frequently Asked Questions)
• Where to find further help, and contact details
• A glossary and, for larger documents, an index

History[edit]

User guides have been found with ancient devices. One example is the Antikythera Mechanism,^[1] a 2,000 year old Greek analogue computer that was found off the coast of the Greek island Antikythera in the year 1900. On the cover of this device are passages of text which describe the features and operation of the mechanism.

As the software industry was developing, the question of how to best document software programs was undecided. This was a unique problem for software developers, since users often became frustrated with current help documents.^[2] Some considerations for writing a user guide that developed at this time include:

• the use of plain language^[2]
• length and reading difficulty^[2]
• the role of printed user guides for digital programs^[3]
• user-centered design^[3]

Computer software manuals and guides[edit]

User manuals and user guides for most non-trivial software applications are book-like documents with contents similar to the above list. They may be distributed either in print or electronically. Some documents have a more fluid structure with many internal links. The Google Earth User Guide^[4] is an example of this format. The term guide is often applied to a document that addresses a specific aspect of a software product. Some usages are Installation Guide, Getting Started Guide, and various How to guides. An example is the Picasa Getting Started Guide.^[5]

In some business software applications, where groups of users have access to only a sub-set of the application’s full functionality, a user guide may be prepared for each group. An example of this approach is the Autodesk Topobase 2010 Help^[6] document, which contains separate Administrator Guides, User Guides, and a Developer’s Guide.

See also[edit]

• Owner’s manual
• Release notes
• Moe book
• Technical writer
• Manual page (Unix)
• Instruction manual (gaming)
• Reference card
• RTFM
• HOWTO

References[edit]

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

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

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

Учитывая его сложность, все электронные или компьютерные продукты обычно имеют свое собственное руководство пользователя. Самые простые предметы (такие как шарик или стол) не требуют объяснений, чтобы потребители знали, как их использовать.

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

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

Во многих случаях переводы руководств пользователя часто ненадежны, что свидетельствует о том, что первоначальный документ был написан на другом языке. Частично эта проблема может быть оправдана, если принять во внимание, что некоторые технологии получают конкретное название в стране их происхождения, которое содержит ряд культурных и языковых элементов, которые очень трудно адаптировать к другим языкам. В настоящее время, учитывая переполненность Интернета и таких продуктов, как смартфоны (примеры названия на иностранном языке), редко кто-то чувствует себя перегруженным такими терминами, как «электронная почта», «домашний» или «сенсорный» «; однако два десятилетия назад реальность была совсем иной.

Руководства пользователя страдают от очень специфического явления, которое имеет как комические нюансы, так и трагические окончания: очень немногие обращаются к ним. В общем, решение не читать руководство тесно связано с личностью, типом человека и не происходит спонтанно; Другими словами, есть те, кто никогда не делает этого и кто не заканчивает раскручивать продукт, пока они не изучат свои функции от a до z .

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

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

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

Документ, который сопровождает приобретенный товар или услугу и позволяет подробно узнать его характеристики и то, как заставить его работать

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

Вообще говоря, Справочник это термин, обозначающий, что книга, документ, который объединяет все основное и существенное по данной теме.

Пока, руководство пользователя следуйте и уважайте эту изначальную предпосылку и причину того, что это текст этого типа, и тогда это документ, техническая книга, соответствующая конкретной системе и, следовательно, включает в себя все, что касается ее: части Y

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

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

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

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

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

Общие функции и содержание

Руководства пользователя сделаны как любое руководство, переплетенные листы, с переменным номером, факт, который зависит от сложность обращение с рассматриваемым устройством, как правило, имеют стандартизированную структуру и разделы, включая следующие: они начинаются с презентация о продукте, функциях и частях, введение, в котором содержится информация о том, как использовать данное руководство; индекс; краткое руководство, рассказывающее об основных функциях системы; раздел для решения типичных проблем, которые могут возникнуть при вмешательстве в систему и являются общими; FAQ или Часто задаваемые вопросы, который представляет собой сборник наиболее распространенных вопросов и ответов, связанных с использованием рассматриваемой системы.

В тех случаях, когда изделие разбирается, указываются составные части и способ их сборки.

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

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

Также для тех случаев, когда ответ не найден в этих предупреждениях, указывается номер технической службы, по которому пользователь может связаться, чтобы найти решение к вашей проблеме использования.

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

Другая общая характеристика этого типа книг — то, что они написаны на наиболее широко используемых языках, испанском, Английский, французский, немецкий языки, а также иллюстративные изображения, помогающие найти кнопки и функции. вовлеченный.

Темы в руководстве пользователя

Руководство пользователя (англ. 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
• Бесплатные инструкции по эксплуатации бытовой электроники
• Как писать руководство пользователя? Часть I
• Как писать руководство пользователя? Часть II
• Сайт разработчиков технической документации (технических писателей)

• MetaGuide — руководство для разработчиков технической документации к программному обеспечению
• Типичные ошибки в справке пользователя для ПО и как их избежать
• Руководства по ремонту автомобилей
• Руководства по эксплуатации автомобильной техники
• Руководства по эксплуатации бытовой техники