Как сделать инструкцию к товару

Обновлено: 05.07.2024

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

Инструкции издаются также в целях разъяснения и определения порядка применения законодательных актов и распорядительных документов (например, приказов). Постоянно издаются инструкции по заполнению и ведению бухгалтерских документов.

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

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

Каковы основные принципы создания инструктивной документации?

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

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

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

С чего следует начать подготовку инструкции?

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

Для чего предназначена эта документация?
Я составляю документацию для отдельного пользователя или для группы пользователей?
Будет ли пользователь обращаться к этой документации более одного раза?
Как долго будет использоваться данная версия документации? (Каков срок ее жизни?)
Нужен ли глоссарий?
Проверена ли мною документация на восприятие неподготовленным пользователем?
Подходит ли стиль написания для самого низкого уровня потенциальных пользователей?
Следует ли включать предметный указатель?
Какое визуальное подкрепление, наглядные пособия могли бы быть полезными?

5.2 Как следует оформлять официальные внутрифирменные инструкции?

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

УТВЕРЖДЕНО
Приказ министра здравоохранения России
15.11.2011 № 287

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

Пошаговая инструкция — лучший формат контента, если речь идет о практических рекомендациях.

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

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

Используйте пошаговые инструкции, чтобы:

Объяснять сложные бизнес-процессы.
Проинструктировать клиентов, как пользоваться продуктом.
Продемонстрировать отраслевые тенденции.
Установить свой авторитет в предмете.

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

Элементы пошаговой инструкции

Введение.
Основная часть (чаще всего в виде нумерованного списка).
Заключение.

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

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

Как сделать (этапы)

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

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

Советы и напоминания

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

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

Вывод

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

Призыв к действию

Что такое руководство пользователя и для чего его создавать

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

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

Общие советы по созданию пользовательской документации

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

После этого важно подумать о том:

Где пользователь будет к нему обращаться: дома, на работе, в машине?
Как часто он будет его просматривать?
Насколько объективно сложен для понимания продукт?

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

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

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

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

В первом разделе желательно рассказать общую информацию о программе:

Для чего создан продукт.
Какие задачи он решает.
Какие основные выгоды от использования для клиента.

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

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

Ни одно руководство не обойдется без таких разделов как: "Частые вопросы" и "Устранение типовых проблем" В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.

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

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

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

Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс практически сам подскажет как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.

При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это - управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям - "Ctrl+c", Ctrl+v". Dr.Explain предлагает решение по повторному использованию контента - текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться - например, версия документируемой системы.

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты - аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы "Вега Матрица"

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

Прочитать полный кейс компании "Вега Матрица вы можете перейдя по ссылке

Наталья Обухова, бизнес-аналитик компании CRM Expert

Николай Вальковец, разработчик компании 2V

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

Прочитать кейс компании V2

Подытожим

Успешных вам разработок!

Смотрите также

СКАЧАТЬ
БЕСПЛАТНО
195 Mb, Windows 11/10/8/7 - 64 Bit

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

Зачем нужны инструкции и где их можно использовать

Где использовать пошаговые руководства:

Правила составления и написания Написание слов — изучается наукой орфографией статей-инструкций

Контент должен быть:

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

Как сделать инструкцию экспертной, если вы не эксперт?

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

Как написать пошаговую инструкцию: наглядный пример

Рассмотрим поочерёдно все этапы.

1. Выбор темы

Выберите актуальную, полезную для вашей ЦА тему. Она обязана соответствовать тематике блога веб-сайт, основное содержимое которого — регулярно добавляемые человеком записи, содержащие текст, изображения или мультимедиа или сайта. Тема должна быть интересной пользователям и сейчас, и в перспективе — иначе нерационально вкладывать столько сил и времени на написание подробного гайда.

Чтобы найти подходящую тему Тема (греч , можно проанализировать статьи Статья в журналистике — один из основных жанров конкурентов или собрать популярные поисковые запросы в Вордстате. Ещё один вариант одна из нескольких редакций какого-либо произведения (литературного, музыкального и тому подобного) или официального документа; видоизменение какой-либо части произведения (разночтения отдельных – изучить распространённые темы вопросов в техническую поддержку.

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

2. Выбор формата может означать инструкции

Выберите наиболее подходящий вид руководства:

3. Выбор принятие кем-либо одного решения из имеющегося множества вариантов названия словесное обозначение, наименование кого-либо или чего-либо

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

Шаблоны Шаблон — в технике, пластина (лекало, трафарет и т. п.) с вырезами, по контуру которых изготовляются чертежи или изделия, либо инструмент для измерения размеров.Шаблон — в языках программирования, заголовков:

4. Глубокое изучение вопроса

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

5. Составление плана первоначально означало равнину; позже стало использоваться в геометрии, в значении плоскость, а также и проекции определённого предмета на эту плоскость

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

6. Подробное рассмотрение всех шагов

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

Обычно структура этапов строится по следующей схеме графический документ; изложение, изображение, представление чего-либо в самых общих чертах, упрощённо (например, схема доклада); электронное устройство, содержащее множество компонентов :

в начале расскажите об актуальности и теперь (здесь и сейчас; лат. hic et nunc) — характеристика отношения субъекта и пространства и времени проблемы, почему важно её быстро решить, укажите, какие материалы вещество или смесь веществ, из которых изготавливается продукция и инструменты предмет, устройства, такие как прибор, механизм, аппаратура, машина, а также алгоритм, используемые для целевого воздействия на объект: его изменения или измерения в целях достижения полезного для этого нужны;
в основной части Часть — собственное подмножество; доля чего-либо опишите сам процесс решения многозначный термин проблемы, что и как надо делать для достижения Достижение — попадание в определённое место, переход к определённому статусу, возрасту или качеству, воплощение определённого плана цели идеальный или реальный предмет сознательного или бессознательного стремления субъекта; конечный результат, на который преднамеренно направлен процесс; «доведение возможности до её полного ;
в конце напишите советы и уточнения, опишите полученный результат и добавьте призыв к действию акт деятельности, неоднозначное слово, которое может означать: Действие группы (в математике) Действие (физика) Действия (акты) — части, на которые делится драма .

7. Добавление визуального контента

8. Вычитка текста

Проверьте, чтобы в статье-инструкции не было опечаток, ошибок непреднамеренное, случайное отклонение от правильных действий, поступков, мыслей, разница между ожидаемой или измеренной и реальной величиной , тавтологий. Кроме того Республика (фр. République togolaise) — государство в Западной Африке, граничащее с Ганой на западе, Бенином на востоке и Буркина-Фасо на севере , посмотрите на руководство глазами обычного читателя:

Всё ли вам понятно в инструкции, нет ли сложных предложений и трудных терминов?
Перечислено ли то, что следует взять и проверить перед началом Начало — условная точка отсчёта работы?
Соблюден ли порядок этапов понятие, имеющее следующие значения: пункт для ночлега, отдыха и питания проходящих (передвигающихся) по военным дорогам войсковых частей (воинских частей), команд, оборудованный участок пути , ничего не пропущено?
Учтены ли все подводные камни и тонкости, с которыми может столкнуться читатель?
Есть ли чересчур большие этапы, которые лучше разбить на отдельные блоки многозначный термин, фамилия и топоним
Имеются ли ненужные подробности (их следует убрать, чтобы не размывать тему)?

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

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

Проверить уникальность текстов можно с помощью специальных сервисов служилый, раб, подневольный; находящийся в полном подчинении, зависимый, подвластный; рабский, невольничий; 2) обременённый повинностями); 3)-а, м. То же, что обслуживание: Современное значение .

Заключение

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

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

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

Читайте также: