Гайд, или по-простому инструкция, последовательно описывает действия для достижения результата. Этот формат используется, чтобы подробно рассказать о преимуществах продукта, дать план действий для решения проблемы или поделиться своим мнением в качестве эксперта.
Полезность для читателя — это, пожалуй, основное при составлении инструкции. В этой статье мы рассмотрим, каких требований стоит придерживаться, чтобы донести пользователю доступным языком всё об использовании приложений.
Определи аудиторию
Формат текста зависит от того, для кого пишется инструкция. Если ты чётко понимаешь, что инструкцию будут читать «чайники», значит, составляй её максимально просто и подробно. Если гайд пишется для профи, можно использовать профессиональные термины, менее подробно и детально описывать все шаги.
Определить уровень знаний целевой аудитории можно разными способами. Например, опросить пользователей напрямую или почитать комментарии на форумах по использованию приложений. Ещё неплохой вариант — попросить сотрудников техподдержки поделиться самыми частыми вопросами о функционале приложения.
Инструкция по использованию программы Телеавтоматика Magic.Весы
Придерживайся последовательности действий
Для кого бы ты ни писал руководство, оно должно предлагать пользователю чёткий алгоритм, рассказывающий, как использовать приложение. Важно, чтобы все действия объяснялись пошагово друг за другом и имели подходящее описание для той аудитории, которую ты определил. Резкие повороты и отвлечение от темы заставят читателя закрыть вкладку с ним.
Структура гайда по описанию работы в любом приложении стандартно состоит из трёх основных шагов. Для начала важно дать описание приложения, в котором бы говорилось о конкретной пользе для читателя и отвечало его потребностям. Далее следует описать этапы и способы регистрации, если их несколько. Самый большой акцент, конечно, стоит сделать на функционале. Этот шаг должен включать в себя подробный «рецепт», как использовать приложение.
Сделай материал полезным для читателя
Расскажи, какого результата следует ожидать читателю при использовании приложения. Для этого необходимо уметь поставить себя на его место и представить, чего бы ему хотелось добиться после прочтения твоего руководства. На основе этого и будет задаваться сюжет инструкции.
Избавься от лишнего, добавив конкретики. Будет замечательно, если твой гайд не только окажется полезным, но и сэкономит время читателю. Старайся использовать те факты, которые необходимы читателю для решения его запроса. Придерживаться этого требования стоит на протяжении всей инструкции, чтобы удержать внимание читателя и не отправить его к конкурентам.
Добавлять воду для художественности текста — не самое лучшее решение. Если необходимо углубиться в нюансы, хорошим способом будет ссылка на другие источники.
Определи подходящий объём информации. Чётких правил, связанных с размером гайда, нет. Однако, чем конкретнее и чётче написана инструкция, тем больше шансов, что ей захотят воспользоваться. Вне зависимости от раздела, руководство по применению любого приложения должно быть полезно и понятно. Если человек нашёл ответы на свои вопросы, значит, главная цель достигнута.
Инструкция по использованию программы VkConnect
Подбери иллюстрации
Наглядность в любой инструкции упрощает её понимание. Гайд по использованию приложений, снабжённый картинками, поможет пользователю быстрее вникнуть во все нюансы. Скриншоты подскажут, как работать в личном кабинете или пользоваться функциями приложения. Диаграммы помогут увидеть процессы, которые происходят при в приложении.
В этот же пункт отнесём и видеоинструкции. Короткий и понятный видеоролик по работе приложения иногда может удачно использоваться в ситуации, когда требуется слишком много изображений. Если нужно самостоятельно записать качественный видеоролик, можно воспользоваться специальными программами, например, REC — Screen Recorder. Это бесплатный софт для записи экрана в высоком качестве в форматах UHD, FHD, HD, HQ, SD.
Огромный плюс программы — это неограниченность записи по времени и отсутствие водяного знака. Можно добавить свой логотип или знак к видео. Возможность записывать звук через микрофон и отображать касания экрана при записи упрощает процесс создания обучающих материалов к гайдам.
Один нюанс, которого лучше придерживаться, — это умеренность и актуальность картинок с видео для составленного текста. Слишком подробное описание инструкции также тяжело даётся читателю, как и полное отсутствие наглядности.
Расскажи о личном опыте
Инструкции в любом направлении составляет человек, который что-то в них понимает. Когда пишешь гайд о приложении, важно изучить его функционал, особенности и характеристики. При рассказе о собственном опыте работы в приложении ты будешь опираться на свои впечатления о нём. Это поможет понять, чего хочет читатель, в чём он может запутаться, а что пояснять не имеет смысла.
Проведи тест-драйв
Руководство по использованию приложения написано, и самое время провести его испытание. Попробуй самостоятельно следовать написанной инструкции. Если твои личные представления сошлись с результатом в реальности, значит, цель достигнута. Сомневаешься в том, что сможешь объективно оценить свою работу, — обратись к людям, которые не знакомы с приложением, но подходят под критерии целевой аудитории.
На основе результатов следования инструкции самостоятельно или с помощью других можно определить, какие остались недочёты, что может быть не понятно пользователям и необходимо ли внести изменения.
Конкретных правил составления гайдов любой направленности нет, но мы надеемся, что статья поможет приступить к написанию инструкции для твоего приложения и добиться желаемого результата. Воспользовавшись программами для записи видеопроигрывателей, трансляций и руководств, ты существенно упростишь себе жизнь. В озможно, в этом тебе пригодится REC — Screen Recorder , которым пользуются более 73 тысяч пользователей .
Программа REC — Screen Recorder предназначена для записи экрана в высоком качестве с отличным звуком от микрофона. Видеозаписи сохраняются во внутренней памяти устройства или на внешнем носителе. Их можно отправлять по электронной почте, через соцсети, а также загружать на Dropbox, Google Drive, OneDrive, YouTube.
Источник: brodude.ru
Инструкция по использованию программного обеспечения
Инструкция по использованию программного обеспечения (или просто «Инструкция пользователю», или «Руководство для пользователя») — это выдержка из полной документации, предназначенная для эксплуатации программного обеспечения. Она представляет собой независимый документ, в котором описывается: что делает программное обеспечение и как им пользоваться. «Инструкция пользователю» должна содержать всю необходимую для пользователя информацию и должна быть ему понятна без дополнительных материалов (без обращения к другим спецификациям). Следовательно, необходимая для этой инструкции информация переписывается полностью из соответствующих спецификаций. Первая часть инструкции является описательной и должна содержать:
- • наименование программного обеспечения;
- • краткое описание программного обеспечения;
- • перечень выполняемых им функций;
- • краткую характеристику метода (или методов), его достоинство и недостатки;
- • полную библиографическую ссылку на полное описание метода;
- • описание входных и выходных данных.
Следует помнить, что пользователь по своей квалификации не является программистом и поэтому его работа с программным обеспечением описывается на понятном ему языке и достаточно подробно, а именно:
- • как запустить программное обеспечение;
- • как продолжить работу с программным обеспечением (описывается подробный интерактивный режим его работы с ПО);
- • подготовка и ввод исходных данных в программное обеспечение;
- • как реагировать на запросы программного обеспечения;
- • как вести работу в исключительных ситуациях;
- • как реагировать на ошибки;
- • как восстановить работу программного обеспечения в случае аварийного его завершения;
- • как получить требуемый результат;
- • как правильно закончить работу с программным обеспечением (запланированный программой выход).
Источник: bstudy.net
РД 50-34.698-90 Руководство пользователя (пример оформления)
Ниже представлен пример (образец) документа «Руководство пользователя», разработанного на основании методических указаний РД 50-34.698-90.