Как написать инструкцию по применению

Как написать хорошую инструкцию: 5 шагов, полезные советы, пример

Содержание статьи:

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

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

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

Для чего нужна любая инструкция

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

1. С точки зрения читателя — это решение его проблемы, в том или ином вопросе, в зависимости от тематики сайта, на котором она опубликована;
2. С точки зрения заказчика (владельца сайта) — привлечения целевого трафика, а как следствие потенциальных клиентов;
3. С точки зрения копирайтера — написание качественного текста, который принесет доход или упорядочит информацию в голове.

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

Какие бывают инструкции

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

Но некоторой классификации, в общих чертах, инструкции всеже можно подвергнуть, и так какие виды инструкций бывают:

1. Инструкция по строительству или сборке чего-либо;
2. Инструкция по применению чего-либо;
3. Медицинская инструкция;
4. Инструкция из разряда «Как сделать…»;
5. Инструкция по приготовлению пиши (рецепт);

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

Существует отдельный вид инструкций, я его называю «специфический», к нему можно отнести:

1. Пошаговую инструкцию как написать книгу;
2. Инструкцию как в домашних условиях сделать что-то для этого не предназначенное;
3. Инструкция как вести себя в той или иной ситуации.

Как написать пошаговую инструкцию (самое интересное)

По сути, эта статья — инструкция как написать инструкцию, плюс неплохо заточенные под СЕО текст с ключами. То есть, структура, выделенные ключи и заголовке в этой статье — это уже первый пример инструкции.

Но, помимо всего, я все же расскажу начинающим копирайтерам, по какому плану следует идти, чтобы написать качественную инструкцию, гайд или свод правил:

1. Найдите проблему — это очень важный этап. Кроме того, проблема, которую решит ваша инструкция должна полностью соответствовать тематике вашего сайта или сайта заказчика;
2. Разобраться в вопросе — полностью, досконально и глубоко разобраться в вопросе, о котором будете писать инструкцию;
3. Разбить решение проблемы на шаги — составе план, в котором первым пунктом будет наличие проблемы, а последним описание результата ее решения. Промежуточными же пунктами должны стать, последовательные, четкие, полные и грамотные шаги по достижению цели;
4. Распишите более подробно каждый шаг — даже уже написав текст в него всегда есть что добавить. Пусть последовательность решения проблему будет максимально подробной;
5. Схемы, картинки, примеры — добавьте в статью максимально доступную визуальную информацию. Ее должно быть немного, но в тоже время и не мало. Но помните, что не для всех инструкций такой ход необходим, как, скажем, в этой;
6. Полезные советы — добавите вставки в текст с полезными советами (также не для всех видов инструкций);

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

Вы пришли сюда из поиска? Это доказывает вышесказанное.

Как написать инструкцию: пример

Как я уже говорил выше, пример написания инструкции — это вся эта статья. Более того, большинство статей на этом сайте, которые начинаются со слова «Как» — являются инструкциями, в той или иной степени.

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

Источник статьи: http://yourwriter.ru/articles/general-articles/how-to-write-a-good-instruction/

Как написать инструкцию так, чтобы тебя поняли

Есть такая поговорка: «Хочешь сделать хорошо — сделай сам».

Для себя, действительно, так будет быстрее и спокойнее. Однако любому руководителю известно, что плохой менеджер это тот, кто не умеет объяснять и делегировать полномочия. Соответственно, умение давать четкие инструкции и план действий — задача хорошего руководителя. А помогает ему в этом «юзабельность». Давайте и разберёмся с этим понятием.

Юзабилити (от англ. usability) означает удобство в использовании, эргономичность и легкость в понимании.

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

Итак, а теперь непосредственно к главному.

Выражение: «И так сойдет» — точно не для инструкций.

1. Постановка цели: для кого и для чего инструкция предназначена. Здесь следует упомянуть, что не следует памятку перегружать терминологией, иначе к ней будет прилагаться словарь терминов — целая энциклопедия и, увы, мало шансов, что её прочитают.

2. Не используем в инструкции много сленга. Есть шанс, что не все сотрудники его поймут.
Пример: «Уточнить у манагеров, получила ли апрув статья». С одной стороны, написано всё понятно, но для официального документа такой сленг не подходит.

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

Примеры скриншотов с вполне понятными шагами:

4. Не пропускаем шаги, которые кажутся нам слишком простыми. Пусть лучше сотрудник, читая инструкцию, сам пропустит этот степ.

5. В тексте нежелательно использовать большие предложения. Коротко: «Зайдите в меню», «Добавьте значение…», «Выберите параметр…» и т.д.

6. Для сокращения объема текста возможно применение графических элементов. Например,

Local area connection ——> properties—>TCP/IPv4—>properties.

7. Применение шрифтовых выделений допустимо. Это привлекает внимание на особо важных пунктах.

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

9. Будьте точны и логичны в написании. Помните, если сотрудник, работая по вашей инструкции сделает ошибку, то это будет ваша недоработка.

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

Источник статьи: http://habr.com/ru/company/icl_services/blog/421503/

Как написать руководство пользователя: подробная инструкция

Поделитесь статьей, пожалуйста:

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

Исследуйте тему

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

Чтобы инструкция получилась полезной копирайтеру нужно разбираться в отрасли на 100%, но описывать её с позиции новичка. То есть ставить себя на место читателя. Прочитайте аналогичные статьи на похожие товары. Это поможет вам лучше разобраться в структуре и стиле такого контента.

Разработайте план и напишите текст

После тщательного изучения материала можно приступать к планированию. Продумайте, с чего лучше начать и чем продолжить. На примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner» я расскажу о принципах написания такого текста.

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

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

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

Описание продукта на примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner»

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

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

Добавляйте в статью скриншоты. Наглядно понять работу программы или техники намного проще.

Добавляем скриншоты для наглядности (пример)

Пишите даже те моменты, которые кажутся очевидными и понятными без описания. Они понятны вам. Но не факт что и всем остальным тоже.

Уникальное предложение — -50% на ВСЕ курсы Skillbox. Получите современную онлайн-профессию, раскройте свой потенциал.

Пишите текст короткими предложениями с глаголами повелительного наклонения: «Включите компьютер», «Нажмите на кнопку…», «Включите в розетку…».

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

Придерживайтесь логики и будьте последовательны. Например, при описании программного обеспечения для ПК: «Включите компьютер. Вставьте диск в дисковод…». Будет нелогично писать: «Начните работу с диском, затем включите ПК». Завершайте инструкцию ответами на частые вопросы и/или описанием неисправностей и как их устранить.

Рекомендации и советы по написанию руководства пользователя к любому товару на примере

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

Источник статьи: http://checkroi.ru/blog/how-to-write-a-user-manual/

Гайды: 8 советов по написанию инструкций

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

Однако стандартная продающая статья и инструкция — тексты разные, хоть и выполняют одинаковую задачу: максимально помочь потенциальному клиенту.

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

Содержание статьи:

Чем полезны инструкции

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

«Для завершения установки обновлений перезагрузите смартфон».

• требуемое действие — нажать на кнопку перезагрузки;
• желаемый результат — установка обновлений прошла успешно.

Хороший гайд отличается двумя ключевыми характеристиками:

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

2. Ее результат конкретный. Пользователь придерживается рекомендаций и достигает желаемой цели (готовит торт, настраивает роутер или создает свой интернет-магазин на бесплатном движке).

Если результат в инструкции не описан, практическая польза от нее отсутствует.

Для чего еще нужна инструкция:

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

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

Разновидности инструкций

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

Выделяют следующую классификацию инструкций:

1. По сборке предметов или по строительству каких-либо объектов.
2. По применению чего-либо.
3. Медицинские инструкции к препаратам.
4. Инструкции формата «Как сделать …».
5. Гайды по приготовлению пищи (рецепты).

Руководство может быть полным — это описание процесса полностью от начала и до конца (например, создание сайта с нуля или канала на Ютубе). Короткое «Как руководство» дает конкретный ответ лишь на один вопрос: как сменить лампочку, как работать с презентацией или как вывести пятно с ткани.

Что учесть в процессе создания гайда

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

Уровень знаний читателя

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

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

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

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

Писать по делу и не лить воду

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

Пример плохого вступительного абзаца:

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

«Представляем 3 простых способа замены фона на фотографии, с которыми справятся даже новички. Применить их можно в версии Photoshop CC 2015 и выше».

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

Длинное вступление можно существенно сократить без потери смысла

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

Стиль текста

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

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

Без иллюстраций никуда

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

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

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

Если требуется описать пошагово работу с программой на телефоне или ПК, делайте скриншоты каждого шага в процессе. Проще удалить лишнее при написании инструкции, чем поздно понять, что важных картинок не хватает. Упростить работу со скриншотами помогут специализированные сервисы: LightShot, Joxi, «Яндекс.Скриншот». Функционал этих программ позволяет делать захват всего экрана или только определенной области. Здесь же можно добавлять на рисунок надписи, рамки или стрелки для наглядности.

Интерфейс программы «Яндекс.Скриншот»

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

Экспертность важна

1. Полезный, решает проблемы ЦА.
2. Подробный, раскрывает нюансы и описывает этапы.
3. Наглядный, в нем достаточно инфографики, чек-листов и изображений.
4. Структурированный и легкий для восприятия.
5. Экспертный — автор должен хорошо понимать, о чем идет речь или писать на основании своего опыта.

Источник статьи: http://www.etxt.ru/subscribes/gaydy-8-sovetov-po-napisaniyu-instruktsiy/