Как написать руководство (с картинками)

Оглавление:

Как написать руководство (с картинками)
Как написать руководство (с картинками)

Видео: Как написать руководство (с картинками)

Видео: Как написать руководство (с картинками)
Видео: Как правильно писать. Подробная инструкция с картинками. 2024, Марш
Anonim

Написание инструкции по эксплуатации может показаться сложной задачей, но это проще, чем вы думаете! Эти шаги применимы к любой письменной инструкции, от очень простой («Как хлопать в ладоши») до чрезвычайно сложной («Как построить полупроводник»).

Шаги

Часть 1 из 4: познакомьтесь с предметом

Напишите руководство, шаг 1
Напишите руководство, шаг 1

Шаг 1. Это ключ

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

Напишите руководство, шаг 2
Напишите руководство, шаг 2

Шаг 2. Поговорите со специалистами

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

Напишите руководство, шаг 3
Напишите руководство, шаг 3

Шаг 3. Попробуйте практический подход

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

Напишите руководство, шаг 4
Напишите руководство, шаг 4

Шаг 4. Прочтите по теме

Научитесь говорить на словах и познакомьтесь с продуктом, о котором вы пишете.

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

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

Часть 2 из 4. Планируйте макет руководства

Напишите руководство, шаг 5
Напишите руководство, шаг 5

Шаг 1. Разбейте его

Будь то простая пошаговая инструкция или руководство для 35-мм цифровой камеры, разбиение ее на удобоваримые куски дает несколько преимуществ:

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

Напишите руководство, шаг 6
Напишите руководство, шаг 6

Шаг 2. Следуйте логической последовательности

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

Написать руководство Шаг 7
Написать руководство Шаг 7

Шаг 3. Используйте это как шаблон для вашего оглавления

Написать руководство Шаг 8
Написать руководство Шаг 8

Шаг 4. Просмотрите свои шаги

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

Написать руководство Шаг 9
Написать руководство Шаг 9

Шаг 5. Соберите все необходимое

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

Часть 3 из 4: Начните писать

Напишите руководство, шаг 10
Напишите руководство, шаг 10

Шаг 1. Напишите введение

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

Написать руководство Шаг 11
Написать руководство Шаг 11

Шаг 2. Выполняйте каждый шаг по мере написания

Это не только придаст вашему письму атмосферу честности и аутентичности, но и гарантирует, что ничто не будет упущено.

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

Напишите руководство, шаг 12
Напишите руководство, шаг 12

Шаг 3. Пронумеруйте шаги

Это помогает людям следить за своими действиями и возвращаться к ним, если они потеряют свое место.

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

Напишите руководство, шаг 13
Напишите руководство, шаг 13

Шаг 4. Включите подсказки и предупреждения

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

И наоборот, если есть какие-то знания, которые сделают задачу пользователя проще или интереснее, добавьте ее

Написать руководство Шаг 14
Написать руководство Шаг 14

Шаг 5. Проверьте это

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

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

Написать руководство Шаг 15
Написать руководство Шаг 15

Шаг 6. Вычитайте свое руководство

Вы же не хотите посылать своему окончательному корректору (будь то ваше агентство или ваша супруга) руководство, полное вопиющих ошибок.

Часть 4 из 4: Форматирование

Напишите руководство, шаг 16
Напишите руководство, шаг 16

Шаг 1. Начните с верхнего уровня

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

Назовите их и отметьте их местонахождение

Написать руководство Шаг 17
Написать руководство Шаг 17

Шаг 2. Напишите содержание, если применимо

Посмотрите, как размещен wikiHow в качестве примера. На главной странице есть много заголовков разделов. Когда вы получаете доступ к разделу, в нем перечисляется множество подкатегорий, а в подкатегориях перечисляются статьи. Чем более подробным будет ваше руководство, тем больше категорий и подкатегорий вам понадобится. («Как свистеть» не нужно, «Как вырезать свисток» - несколько штук, а «Как играть на флейте» - много!)

Написать руководство Шаг 18
Написать руководство Шаг 18

Шаг 3. Вычитайте еще раз

Да, вы уже однажды сделали это основательно. Повторное выполнение этого, несомненно, выявит еще несколько мелких ошибок или мест, где ваше руководство просто неясно.

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

Написать руководство Шаг 19
Написать руководство Шаг 19

Шаг 4. Выберите заголовок

подсказки

  • Даже если что-то кажется вам очевидным, запишите шаги! Это поможет вам избежать замалчивания того, чего не знает ваш пользователь. Лучше добавить дополнительную информацию, чем пропустить важные шаги.
  • Если вы пишете очень подробное руководство, в котором требуются главы, например, Как играть на флейте, первым шагом может быть перечисление всех глав, таких как Выбор флейты, Сборка и уход, Производство тона, Методы аппликатуры, Ваши Первая часть и т. Д. Затем вы применили бы основные правила написания руководства к каждой главе, потому что каждая глава подобна отдельному руководству сама по себе!
  • По возможности проиллюстрируйте свои инструкции! Если вы не можете вставить картинки, порекомендуйте ученику привести пример. Например, в Форматирование, шаг 2 В этих инструкциях внешний вид макета wikiHow используется для иллюстрации того, как можно создать оглавление.
  • Написание каждого раздела на отдельной странице (или на компьютере) упростит редактирование. Вы можете легко переставить, если у вас есть место для работы и вы можете найти свои пометки для редактирования. На компьютере оставьте 3 или 4 строки (нажав входить несколько раз) между каждым шагом, чтобы вы могли легко найти перерывы.
  • Если можете, попросите новичка выполнить пробный запуск вашего руководства и записать каждый вопрос, который они задают! Это поможет вам заполнить пробелы и сделать ваше руководство более полезным.

Рекомендуемые: