Руководство по использова

1. 

   1

   Определите, кто ваш читатель. Чтобы создать хорошее руководство пользователя, нужно понимать, какой человек купит то устройство, к которому вы создаете инструкцию. Можно записать свои мысли, а можно просто представить себе этого человека. Это полезно делать, если вы работаете в команде по созданию документации и если вы участвуете в разработке продукта от самого начала до конца. Подумайте о следующем:

   • Где человек будет пользоваться инструкцией по эксплуатации: дома, на работе, в машине, в интернете? Это определит не только содержание, но и стиль документации.
   • Как человек будет пользоваться инструкцией? Если человеку потребуется лишь изредка заглядывать в руководство пользователя, значит, инструкция должна быть оформлена в сжатой форме. Если руководством будут пользоваться часто, особенно в самом начале, вам следует включить целый раздел о том, как начать пользоваться устройством или программным продуктом, и подробно описать все самые важные функции.
   • Как много опыта должно быть у человека? Если ваш товар относительно новый или существенно отличается от похожих товаров, вам нужно будет включить информацию о том, чем этот товар отличается от аналогов, и предоставить пользователю подробные инструкции. Если товар связан с частыми проблемами (например, с большим количеством программ), опишите, что следует делать, когда проблема возникнет.

2. 

   2

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

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

3. 

   3

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

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

   Реклама

1. 

   1

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

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

2. 

   2

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

3. 

   3

   Если количество страниц превышает 10 штук, вам понадобится оглавление.

4. 

   4

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

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

5. 

   5

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

   • После того, как получите графическое изображение, сохраните его в сжатом формате. Вам также может потребоваться уменьшить размер рисунка, чтобы он помещался на страницу, но размер не должен быть слишком маленьким, так как иначе пользователь не сможет рассмотреть, как и что следует делать. Если потребуется, можно разбить изображение на несколько частей и описать каждую из них.
   • Если вы используете несколько изображений, они должны иметь одинаковый размер, пропорции и разрешение. Такие изображения будут более понятны и приятны читателю. При создании скриншотов убедитесь, что вы используете стандартную цветовую схему (для случаев, когда руководство печатается в цвете).
   • Хотя графические редакторы (например, Photoshop и Paint Shop Pro) удобны для создания скриншотов, лучше пользовать специальными программами (например, SnagIt), поскольку они позволяют сразу же быстро и легко отредактировать, сохранить и подписать все изображения.

   Реклама

1. 

   1

   Выберите читаемый шрифт. Хотя компьютеры поддерживают разные шрифты, руководство пользователя должно быть хорошо читаемым, поэтому отдавайте предпочтение самым простым. Лучше всего подобрать несколько шрифтов, которые хорошо смотрятся вместе. Есть два типа шрифтов: с засечками и без засечек.

   • У шрифтов с засечками есть небольшие черточки по краям линий. К таким шрифтам относятся Times New Roman, Baskerville и Book Antiqua. Такие шрифты подойдут большим объемам текста, напечатанного 10 или 12 размером и составляющего основу руководства пользователя.
   • Шрифты без засечек имеют простые линии без украшений. Это такие шрифты, как Arial, Calibri и Century Gothic. Шрифты без засечек лучше смотрятся в текстах, напечатанных 8 или 10 шрифтом в руководствах в формате PDF или web-документа. Чем крупнее шрифт, тем сложнее его читать без засечек. Однако эти шрифты можно использовать и для крупного текста — например, для набора заголовков. Шрифты без засечек подходят для набора цифр в таблицах и колонках.
   • Следует выбирать простые шрифты наподобие Arial или Times New Roman, хотя для цитат подойдет какой-нибудь более сложный шрифт. Если вы пишете руководство пользователя для фэнтезийной игры, можно выделить витиеватым шрифтом названия глав. Допускается также выделение цитат курсивом.
   • После того, как выберите шрифты, создайте тестовую страницу, чтобы убедиться, что эти шрифты сочетаются между собой на бумаге. Покажите эту страницу человеку, который одобряет макеты, прежде чем отдать руководство пользователя в печать.

2. 

   2

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

   • Как правило, название руководства пользователя и названия глав размещаются сверху или снизу страницы вместе с нумерацией страниц. Цифры могут располагаться с внешней стороны (для верха и низа страницы) или по середине (для низа). Первая страница каждого раздела может отличаться от остальных, поэтому вы можете разместить номер ее страницы по середине снизу, а номера всех остальных страниц — с внешней стороны.
   • Отдельные фрагменты текста можно выделить цветом, поместив их в специальные блоки. Важно выбрать такой оттенок, который не забивал бы текст.
   • Оставьте достаточно большие отступы со всех сторон. Со стороны переплета отступ должен быть шире.

3. 

   3

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

   • Скрепление скобой. Этот тип подходит для брошюр размерами 21x 27.5 см, 21×35 см или 11 x 27.5×42.5 см. Большинство недорогих инструкций по эксплуатации, которые состоят из 48 страниц и менее, переплетаются таким образом.
   • Переплет внакидку. Так переплетают большинство обычных инструкций по эксплуатации, не считая инструкций к автомобилям, хотя некоторые длинные руководства также переплетаются таким образом. (Paint Shop Pro изначально поставлялся именно с таким руководством пользователя.)
   • Переплет с проволочной спиралью. Таким способом переплетают руководства, которые используются в более суровых условиях, например, на улице, где скобы могут с легкостью сломаться или разойтись. В некоторых инструкциях по применению с таким переплетом также встречаются ламинированные страницы, которые не промокают и не пачкаются в грязи.

4. 

   4

   Сверстайте документ. В большинстве текстовых редакторов и программ для публикации текста в интернете предусмотрена возможность верстки. По мере того, как вы будете набирать текст, он будет автоматически отображаться в выбранном шрифте. (Эта статья была изначально написана с помощью шаблона в Microsoft Word.) В этих программах также есть уже готовые шаблоны, которые вы можете изменить с учетом своих потребностей, вместо того, чтобы создавать шаблон с нуля.

   • В текстовых редакторах и программах для публикации текста в интернете также есть функция создания «стилей», сохранения шрифтов и задания размеров для оглавлений, колонтитулов и основного текста. Можно выбрать из уже существующих стилей («Заголовок1», «Обычный», «Цитата») или создать свой собственный стиль и дать ему свое название. Рекомендуется называть стили по такой же системе, как это предусмотрено в программе. (Например, Microsoft Word создает такие названия, как «Заголовок1», «Заголовок2»; кроме того, есть еще подзаголовки.) Настраивайте программу заранее, чтобы вам не пришлось возвращаться к этому, когда вы будете заниматься написанием текста.

   Реклама

Советы

• По возможности пользуйтесь кодами полей или текстовыми переменными. Можно изменять их значения (например, название продукта, название главы руководства пользователя) и помещать их в документ в места, где вы обычно стали бы набирать слова вручную. Когда вы сделаете предпросмотр документа или подготовите его к печати, нужный текст подставится в переменные. Если изменится название товара либо если вы решите изменить название главы, вам будет проще поменять текст, заменив значение переменной.

Реклама

Что вам понадобится

• Текстовый редактор или программа для публикации текста в интернете
• Графический редактор или программа для создания скриншотов