Руководство пользователя - это руководство в бумажном или электронном формате (PDF или XPS), которое содержит инструкции по процедуре или использованию чего-либо. Хотя «руководства пользователя» часто связаны с руководствами по компьютерным приложениям, руководства пользователя также прилагаются к компьютерам и другим электронным устройствам, таким как телевизоры, стереосистемы, телефонные системы, MP3-плееры, а также домашнее и садовое оборудование. Хорошее руководство пользователя знакомит пользователей с функциями продукта, одновременно обучая их эффективному использованию. Руководство пользователя построено таким образом, чтобы его было легко читать и ссылаться на него. Вот несколько шагов, которые необходимо учитывать при разработке эффективного контента и макетов руководств пользователя.
Шаг
Часть 1 из 3: Создание подходящего руководства пользователя
Шаг 1. Решите, кто будет использовать руководство
Чтобы написать хорошее руководство пользователя, вам необходимо разработать профиль пользователя либо формально, создав письменный профиль, либо неформально, потратив время на то, чтобы сделать разумные предположения о характеристиках пользователя. Такие профили полезны, когда вы являетесь частью команды разработчиков руководств пользователя и при работе над предполагаемым продуктом от концепции до окончательной формы. При создании профиля пользователя учитывайте следующие факторы:
- Местоположение пользователя будет использовать руководство, например, дома, в офисе, на удаленном рабочем месте или в машине. Этот фактор определяет не только содержание, но и стиль написания руководства.
- Как пользователь будет использовать руководство. Если они редко пользуются им или нуждаются в нем только для поиска информации, лучше всего, если руководство будет выполнено в виде справочного документа. С другой стороны, если пользователь будет использовать его регулярно вначале, справочный раздел должен сопровождаться разделом «Как приступить к работе» и инструкциями по наиболее распространенным функциям, которые будет выполнять продукт.
- Сколько опыта у пользователя в использовании продукта или аналогичного предмета. Если продукт новый или сильно отличается от аналогичных продуктов, вы должны включить объяснение того, чем он отличается от других, и инструкции по его использованию. Если продукт имеет дело с чем-то, что пользователи часто считают трудным, например с компьютерным приложением, вы должны предоставить соответствующую информацию и подробности в понятной форме.
Шаг 2. Создайте руководство, которое соответствует потребностям пользователя в понятной им форме
Если пользователи не являются технически подкованными людьми, вероятно, лучше избегать слишком технических формулировок и давать ясные и простые объяснения. Текст также должен быть организован таким образом, чтобы походить на то, как думает пользователь. Перечисление функций продукта, сгруппированных по функциям, часто имеет больше смысла, чем по наиболее часто используемым функциям.
Иногда использование технических терминов неизбежно, например, для графических приложений, которые включают диаграммы Фибоначчи вместе с круговыми диаграммами и более распространенными гистограммами. В таком случае было бы лучше, если бы вы определили термины и предоставили информацию, например, объяснение того, что такое диаграмма Фибоначчи и как она используется в финансовом анализе
Шаг 3. Опишите проблему, которую пытается решить пользователь, а затем предложите решение этой проблемы
Предложение функций в качестве решения распространенных проблем - это нормально при рекламе продукта, но когда клиент становится владельцем продукта, он или она должны понимать, как его использовать. Определите проблему, с которой столкнется пользователь, опишите ее в руководстве пользователя, а затем дайте инструкции по ее решению.
Если проблема сложная, разбейте ее на более мелкие части. Запишите каждый раздел с инструкциями о том, как решить эту проблему или как с ней справиться, а затем следуйте друг за другом по порядку. Такое разделение информации известно как метод кластеризации или разделения
Часть 2 из 3: Компоненты руководства пользователя
Шаг 1. Создайте подходящую обложку и титульный лист
Вам понадобится обложка для любого руководства пользователя, которое представляет собой нечто большее, чем справочная карточка, и титульный лист для руководства, которое включает в себя не только сложенный лист бумаги (4 страницы или более).
- Если руководство защищено авторскими правами, уведомление об авторских правах должно быть размещено на передней и задней обложках, а также на титульном листе.
- Если есть условия использования руководства и связанных с ним продуктов, пожалуйста, укажите их на внутренней стороне передней обложки.
Шаг 2. Поместите ссылку на соответствующий документ во введении
Если существует несколько руководств пользователя, пожалуйста, дайте ссылку на другой документ, включая правильный номер версии, здесь. В предисловии также можно разместить раздел «Как пользоваться этим руководством», если он есть.
Шаг 3. Включите оглавление, если руководство превышает 10 страниц
Шаг 4. Поместите инструкции / процедуры и справочные материалы на корпус руководства
В большинстве случаев и процедура, и справочный материал должны иметь свой собственный раздел. Однако вы можете указать пользователям ссылаться на конкретный контент в одном разделе и отличать его от других разделов. Таким образом, пользователь может быстро найти нужную информацию.
- Процедуры должны быть записаны в единой структуре по всем инструкциям в руководстве. Начните с обзора функциональности продукта, затем объясните, что должен делать пользователь и какие результаты он получит или увидит. Шаги должны быть пронумерованы и начинаться с глагола действия, как они описаны в каждом разделе этой статьи.
- Справочные материалы могут включать контрольные списки, советы по устранению неполадок и часто задаваемые вопросы. Глоссарий и указатель могут быть добавлены в конце руководства, хотя глоссарий часто используемых терминов может быть предоставлен в начале. Индекс можно не указывать, если в справочнике меньше 20 страниц.
Шаг 5. Используйте графические изображения по мере необходимости для поддержки текста
Графические изображения или снимки экрана могут лучше проиллюстрировать определенные моменты в руководстве, чем текст, особенно в сложных процедурах, когда пользователям требуется визуальное подтверждение, чтобы убедиться, что они правильно выполняют шаги. Графические рисунки можно создавать с помощью приложений для автоматизированного черчения (САПР) или редактирования графики, приложений для цифровой камеры и обработки фотографий, или, если вы хотите использовать снимки экрана, используйте встроенные в компьютер функции снимков экрана или графическую программу с возможностью захвата экрана.
- Создав графическое изображение, сохраните его в сжатом формате, чтобы вы могли использовать его в текстовом редакторе или настольном издательском приложении. Вам также необходимо уменьшить размер изображения, чтобы оно лучше вписывалось в страницу, но при этом предоставляло пользователю полную информацию. (При необходимости вы можете обрезать исходное изображение на разделы и показать соответствующие разделы вместе с вспомогательным текстом).
- Если вы используете несколько графических изображений в процедуре, убедитесь, что изображения созданы с одинаковым размером, либо с одинаковыми размерами длины и ширины, либо пропорциональными размеру исходного изображения. Таким образом изображение будет выглядеть более привлекательно для пользователей. То же самое и при создании снимков экрана с компьютера; убедитесь, что компьютер отображает стандартную цветовую схему при съемке, в противном случае мастер отобразит цветной снимок экрана.
- В то время как приложения для редактирования изображений, такие как Photoshop и Paint Shop Pro, обладают хорошими возможностями захвата изображений, программы, предназначенные для создания снимков экрана, такие как Snagit, также предлагают возможность легко изменять, каталогизировать и комментировать снимки экрана.
Часть 3 из 3: Разработка простого в использовании руководства пользователя
Шаг 1. Выберите несколько удобных для чтения шрифтов
Хотя компьютер может поддерживать несколько шрифтов, цель создания руководства пользователя легко читается. Выбор нескольких подходящих шрифтов - лучший способ достичь этой цели. Шрифты можно разделить на два типа: с засечками и без засечек.
- Шрифты с засечками имеют небольшие декоративные линии на концах основных линий, составляющих буквы. К шрифтам с засечками относятся Times New Roman, Baskerville и Book Antiqua. Шрифты с засечками идеально подходят для большинства текстов, отображаемых размером 10–12 в основной части руководств по печати.
- Шрифты без засечек содержат только линии, составляющие буквы, без каких-либо украшений. Шрифты, принадлежащие к группе без засечек, включают Arial, Calibri и Century Gothic. Шрифты без засечек можно использовать для большинства размеров текста от 8 до 10 в файлах PDF или онлайн-руководствах, хотя отсутствие украшений затрудняет чтение предложений, отображаемых шрифтом 12 или больше. Однако шрифты большего размера можно эффективно использовать для отображения заголовков и заголовков, а меньшего размера они идеально подходят для сносок и чисел в столбцах и таблицах.
- В общем, для руководства лучше всего выбрать простой шрифт, например Arial или Times New Roman, хотя вы можете использовать декоративный шрифт для цитат или заголовков, если пишете руководство для видеоигры, действие которой происходит в фэнтезийной или научной фантастике.. (В случае цитат вы часто можете использовать простой шрифт и вывести полную цитату курсивом).
- Решив, какие шрифты использовать, создайте образцы страниц, чтобы убедиться, что они хорошо смотрятся на бумаге. Вы также должны показать этот образец страницы лицу, ответственному за утверждение показа руководства, прежде чем приступить к процессу написания.
Шаг 2. Продумайте макет
После того, как вы выбрали шрифт для руководства, вам нужно решить, как структурировать контент в верхней части страницы.
- В общем, вам, вероятно, следует поместить заголовок документа или заголовок главы в верхний или нижний колонтитул, возможно, используя заголовки руководства в левой части страницы и заголовки глав в правой части страницы. Вы должны разместить номер страницы в верхнем или нижнем колонтитуле либо снаружи (верхний или нижний колонтитул), либо по центру (только в нижнем колонтитуле). Вам также может потребоваться отличить первую страницу каждого раздела или главы от других страниц, разместив номер страницы в середине нижнего колонтитула, а следующую страницу - во внешнем углу верхнего колонтитула.
- Вам может потребоваться вставить текст внутри цветного или блочного поля, чтобы отличать его от остального текста. Убедитесь, что вы выбрали цвет или уровень блокировки, чтобы текст не был затруднен для чтения.
- Оставьте достаточно широкие поля со всех сторон с дополнительным пространством по краям для сшивания.
Шаг 3. Рассмотрите тип тома для руководства пользователя
Если руководство длиннее 4 страниц, страницы должны быть переплетены определенным образом. Хотя внутренние документы можно сшить с помощью степлера в углу страницы, внешнее руководство пользователя, которое поставляется вместе с продуктом, обычно сшивается одним из следующих трех методов:
- Метод бокового сшивания (прижатие к краям страницы с помощью степлера) для направляющих, напечатанных на фальцованной бумаге 21 x 27,5 см, 21 x 35 см или 27,5 x 42,5 см. Таким образом переплетаются самые недорогие справочники объемом не более 48 страниц.
- Метод сшивания внакидку (сшивание сбоку страницы) чаще используется для справочников сторонних производителей, чем для руководств, поставляемых с продуктами, отличными от автомобилей, хотя некоторые более длинные руководства связаны таким образом. (Руководство Paint Shop Pro изначально включало руководство по шитью внакидку, но все еще выпускалось JASC Software).
- Спиральный переплет лучше всего подходит для направляющих, используемых в более суровых условиях, например на открытом воздухе (в этом случае методы бокового сшивания и сшивания внакидку недостаточно сильны, чтобы страницы соскользнули). Некоторые направляющие со спиральным переплетом могут также иметь страницы, ламинированные пластиком, чтобы предотвратить их повреждение при намокании или попадании в грязь.
Шаг 4. Создайте шаблон документа для руководства
Многие текстовые редакторы и настольные издательские приложения предлагают возможность создания шаблонов документов для руководств пользователя. Таким образом, по мере ввода текст будет автоматически отображаться с шрифтом, который вы выбрали для той части мастера, над которой вы работаете. (Собственно, эта статья изначально была написана с использованием шаблона Microsoft Word). Большинство этих программ также включают стандартный набор шаблонов, которые вы можете изменять по мере необходимости, чтобы вам не приходилось создавать свои собственные с нуля.
