Как создать руководство пользователя

новости Публиковать теги Источники о нас конфиденциальность
GratisForGratis

WikiHow

https://www.wikihow.it/Creare-un-Manuale-d%27Uso

Руководства пользователя — это физически написанные руководства (на бумаге) или электронные документы (PDF или XPS), содержащие инструкции о том, как что-то делать или использовать.Хотя «руководства пользователя» чаще всего рассматриваются как относящиеся к компьютерному программному обеспечению, руководства пользователя также прикрепляются к компьютерам или другим электронным устройствам, таким как телевизоры, стереосистемы, телефоны и MP3-плееры, а также к бытовой технике и садовому оборудованию.Хорошее руководство пользователя информирует пользователей о функциях продукта, а также обучает соответствующим операциям эффективным и легко доступным способом.Ниже приведены элементы, которые следует учитывать при создании эффективного контента и макета руководства пользователя.
Часть 1
Часть 1 из 3:

Создание удобной для пользователя документации

Скачать PDF
  1. Step 1 Definisci l’utente di riferimento.
    Чтобы написать успешное руководство, вам необходимо составить профиль вашего пользователя: либо формальный, создав письменный профиль, либо неформальный, потратив время на то, чтобы сделать разумные предположения о характеристиках вашего пользователя.Подобный профиль полезен, когда вы являетесь частью команды, пишущей пользовательскую документацию, а также может быть полезен в процессе перехода продукта от идеи к окончательной форме.При написании профиля пользователя следует учитывать следующие элементы:
    • Где пользователи будут использовать руководство: дома, в офисе, на удаленном рабочем месте или в автомобиле.Это может повлиять не только на содержание, но и на стиль руководства.
    • Как пользователи будут использовать руководство.Если обращение к руководству будет необходимо лишь изредка или для поиска информации, оно должно в первую очередь иметь форму справочного документа.Если пользователи изначально будут часто обращаться к этому продукту, справочный раздел должен сопровождаться разделом «Начало работы» и инструкциями по наиболее распространенным вариантам использования продукта.
    • Насколько пользователи уже имеют опыт работы с продуктом или другими продуктами той же категории.Если ваш продукт новый или имеет существенные отличия от аналогичных продуктов, вам необходимо будет включить объяснение этих отличий, а также инструкции о том, как начать его использовать.Если продукт предназначен для чего-то, с чем у пользователей часто возникают проблемы, например, для многих компьютерных приложений, вам необходимо будет предоставить адекватную информацию и подробности в понятном стиле.
  2. Step 2 Rivolgiti ai bisogni del tuo utente in modo che questi possa capire.
    Если у пользователя нет технического опыта, вероятно, лучше избегать конкретной терминологии, отдавая предпочтение ясным и простым объяснениям.Текст также должен быть организован так, чтобы учитывать рассуждения пользователей;Перечисление характеристик продукта путем группировки их по функциям часто имеет больше смысла, чем более часто используемые порядки в списках.
    • Иногда невозможно обойти технические термины, например, в программном обеспечении для построения графиков, которое включает в себя диаграммы Фибоначчи, а также более распространенные круговые и гистограммы.В подобных случаях полезно дать определение этому термину и дать объяснение, например, углубившись в определение и полезность таблиц Фибоначчи в финансовом анализе.
  3. Step 3 Spiega il problema che l’utente sta cercando di risolvere, poi presentane la soluzione.
    Предоставление решения только общей проблемы работает на этапе продажи продукта, но как только пользователь купил его, он должен понять, как его использовать наилучшим образом.Определите конкретные проблемы, с которыми может столкнуться пользователь, изложите их в руководстве пользователя и затем переходите к инструкциям по их решению.
    • Если проблема сложная, разбейте ее на более мелкие части.Перечислите каждую часть с инструкциями о том, как ее решить или справиться с ней, а затем расположите их последовательно.Этот процесс известен как «фрагментация».
    Реклама
Часть 2
Часть 2 из 3:

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

Скачать PDF
  1. Step 1 Includi la copertina e i frontespizi appropriati.
    Вам понадобится обложка для каждого руководства пользователя, которая представляет собой нечто большее, чем просто справочная карточка, а также титульные страницы для руководств, длина которых превышает сложенный лист бумаги (длиной 4 или более страниц).
    • Если руководство защищено авторскими правами, это должно быть указано как на обложке, так и на титульном листе.
    • Если вам необходимо сообщить условия использования руководства и сопутствующего продукта, вы должны указать их на внутренней стороне обложки.
  2. Step 2 Inserisci riferimenti ai documenti collegati nell’introduzione.
    Если пользовательская документация охватывает более одного тома, предоставьте здесь ссылки на другие документы с правильными версиями.Введение также является частью, в которую при необходимости можно вставить раздел «Как пользоваться этим руководством».
  3. Step 3 Includi un indice, in caso il manuale superi le 10 pagine.
  4. Step 4 Metti le istruzioni/metodi e i materiali di riferimento nel corpo centrale del manuale.
    Во многих случаях методы и справочные материалы должны иметь свой собственный раздел, хотя вы всегда можете указать пользователю ссылаться на определенный контент из одного раздела в другой.Таким образом, пользователь может быстрее найти нужную информацию.
    • Методы должны быть описаны последовательно во всем разделе инструкций руководства.Начните с обзора задачи, затем опишите, что нужно сделать пользователю и каких результатов он должен достичь.Шаги должны быть пронумерованы и начинаться с глаголов действия, как и шаги в каждом разделе этой статьи.
    • Справочные материалы могут включать список опций, советы и часто задаваемые вопросы.Глоссарии и приложения могут быть добавлены в конце руководства, хотя список часто используемых терминов может появиться в начале.Указатель можно опустить, если в руководстве менее 20 страниц.
  5. Step 5 Usa delle grafiche qualora sia necessario sostenere il testo.
    Графика или снимки экрана могут лучше иллюстрировать определенные моменты руководства, чем текст, особенно в сложных процедурах, где пользователям необходимо визуальное подтверждение правильности выполнения.Графика может быть создана с использованием программ САПР или графического программного обеспечения, цифрового редактирования и цифровых камер или, в случае снимков экрана, с помощью встроенной функции компьютера («штамп»/cmd+shift+3) или графической программы, которая обеспечивает возможность записи экрана.
    • После создания графики сохраните ее в сжатом формате, чтобы ее можно было использовать в написании или публикации программ.Вам также потребуется уменьшить размер файла, чтобы его было легче включить на страницу, не уменьшая детализации для пользователя (при необходимости вам может потребоваться разбить исходное изображение и показать соответствующие части по мере прохождения текста). .
    • Если вы используете в своих методах многочисленные графические изображения, сохраняйте согласованность размеров, независимо от того, имеют ли они одинаковую длину и ширину или всегда уменьшены до одинаковой пропорции по сравнению с исходным размером.Это сделает изображения более привлекательными для пользователя.Аналогичным образом, сохраняя снимки экрана на компьютер, убедитесь, что на этом этапе в компьютере установлен стандартный цвет, на случай, если руководство требует сохранить эти цвета.
    • В то время как графические программы, такие как Photoshop и Paint Shop Pro, предлагают хорошие возможности сохранения экрана, специальные программы, такие как SnagIt, также позволяют легко редактировать, каталогизировать и закреплять экраны.
    Реклама
Часть 3
Часть 3 из 3:

Разработка читаемого руководства

Скачать PDF
  1. Step 1 Scegli un paio di font leggibili.
    Хотя компьютеры могут поддерживать множество различных шрифтов, цель руководства пользователя — легкость чтения.Выбор нескольких хорошо подобранных шрифтов — лучший способ достичь этой цели.Есть 2 категории шрифтов:«serif» и «sans serif» (с засечками или без них).
    • Шрифты с засечками имеют небольшие окончания на концах основных штрихов букв.Шрифты с засечками включают Times New Roman, Baskerville и Book Antiqua.Засечки лучше всего работают в больших текстовых блоках размером 10–12 размеров в основной части печатного руководства пользователя.
    • Шрифты без засечек содержат только штрихи, образующие буквы без окончаний.К шрифтам без засечек относятся Arial, Calibri и Century Gothic.Эти шрифты можно использовать для больших блоков текста размером 8–10 в онлайн-руководстве или PDF-файле, хотя отсутствие окончаний затрудняет чтение предложений размером 12+.Однако их можно эффективно использовать в больших размерах для отображения заголовков и заголовков, а также в меньших размерах для нижних колонтитулов и чисел в столбцах или таблицах.
    • Обычно вам следует выбирать нейтральные шрифты, такие как Arial или Times New Roman, для вашего руководства пользователя, хотя лучше выбрать декоративный шрифт в случае кавычек или заголовков, если вы пишете, например, для видеоигры с фэнтези или наукой. настройки художественной литературы (в случае выдержек из одного и того же текста часто можно использовать один и тот же шрифт, в формате «курсив»).
    • После того как вы выбрали шрифты, которые будете использовать, создайте тестовую страницу, чтобы проверить, хорошо ли шрифты смотрятся вместе на бумаге.Вы также можете показать это доказательство всем, кому необходимо утвердить внешний вид руководства, прежде чем продолжить.
  2. Step 2 Pensa all’impaginazione.
    После того, как вы выбрали шрифты для своего руководства пользователя, вам необходимо определиться с расположением различных элементов страниц.
    • Обычно вам нужно поместить название руководства или главы в заголовок или внизу страницы, в идеале — название руководства на левой странице и название главы — на правой.Номера страниц должны располагаться сверху или снизу, снаружи (верхний или нижний колонтитул) или по центру (только нижний колонтитул).Возможно, вы захотите отличить первую страницу каждого раздела или главы от остальных, поместив номер ее страницы в центре, а последующие — во внешнем углу заголовка.
    • Возможно, вы захотите нарисовать части текста в цветных или затененных прямоугольниках, чтобы отделить их от остального текста.Обязательно выберите цвет или степень затенения, которые не перекрывают текст.
    • Оставьте достаточно широкие поля со всех сторон, оставив достаточно места по краям, которые будут скреплены вместе.
  3. Step 3 Considera il tipo di rilegatura del manuale d’uso.
    Если в вашем руководстве более 4 страниц, их необходимо каким-либо образом переплести.Внутренние документы можно скрепить степлером в одном углу, а внешние руководства, поставляемые вместе с продуктом, обычно скрепляются одним из трех способов:
    • Боковые скрепки подходят для пособий, состоящих из сложенных листов бумаги размером 21x27,5 см, 21x35 см или 27,5x42,5 см.Таким образом переплетено большинство экономических пособий объемом менее 48 страниц.
    • Боковой шов чаще используется для внешних справочных руководств, а не в руководствах пользователя, входящих в комплект неавтомобильной продукции, хотя некоторые более длинные направляющие переплетаются таким образом (Paint Shop Pro изначально поставлялся с направляющим, прикрепленным к шву, когда он был выпущен JASC Software ).
    • Спиральный переплет подходит для руководств пользователя, которые должны быть более прочными, например, для использования на открытом воздухе, где скрепленные или скрепленные скрепками руководства не выдерживают.Некоторые руководства в спиральном переплете могут также содержать ламинированные страницы, чтобы предотвратить их повреждение при контакте с водой или грязью.
  4. Step 4 Costruisci un modello per il tuo manuale.
    Многие программы для написания и публикации предлагают возможность создания шаблонного документа для вашего руководства пользователя, чтобы при написании текст автоматически отображался нужным шрифтом в той части руководства, над которой вы работаете (эта статья, по сути, была изначально написано с использованием шаблона MS Word).Многие из этих программ также включают набор готовых шаблонов, которые вы можете изменить в соответствии со своими потребностями, а не создавать шаблон с нуля.
    • Программы написания и публикации также позволяют создавать «стили», предустановленные шрифты и размеры верхних и нижних колонтитулов, заголовков и основной части текста.Вы можете выбрать один из предустановленных стилей (например, «Заголовок1», «Обычный», «Цитата») или создать свой собственный стиль с собственным именем.Насколько это возможно, следуйте общепринятым соглашениям об именовании стилей, если у вас есть несколько стилей для одного и того же фрагмента текста (например, MS Word помечает стили заголовков как «Заголовок1», «Заголовок2» и т. д.).по заголовкам, от основного до различных уровней субтитров).Постарайтесь заранее создать все стили, которые вам понадобятся, чтобы вам не приходилось прекращать их создание в процессе написания.
    Реклама

Совет

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

Вещи, которые вам понадобятся

  • Написание или публикация программы
  • Программа графики или визуальной записи
Лицензировано под: CC-BY-SA
CAPTCHA

Откройте для себя сайт: siteUrl

реклама

 

^