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

Корректор, редактор журналист. Занимаюсь любимейшим делом уже более шести лет.

Прежде, чем спрашивать…

Прежде, чем задавать технический вопрос по электронной почте или в дискуссионную группу, в чате или на форуме, сделайте следующее: 1. Попытайтесь найти ответ с помощью поиска в Web. 2. Попытайтесь найти ответ в руководстве. 3. Попытайтесь найти ответ в списке часто задаваемых вопросов (ЧаВО). 4. Попытайтесь найти ответ путем проверок или экспериментов. 5. Спросите опытного товарища. 6. Если вы — программист, попытайтесь найти ответ, анализируя исходный код. Когда задаете вопрос, укажите с самого начала, что вы все это уже сделали; это поможет понять, что вы не какой-нибудь лентяй, транжирящий чужое время. Еще лучше, покажите, что вы узнали в результате своих поисков. Нам нравится отвечать людям, продемонстрировавшим свою способность воспринимать ответы. Используйте приемы типа поиска в Google по тексту полученного сообщения об ошибке (поищите также в дискуссионных группах — Google groups, а не только на Web-страницах). Это может привести либо непосредственно к документации, посвященной тому, как эту ошибку устранить, либо к дискуссии в списке рассылки, в которой можно будет найти ответ. Даже если ответ и не найдется, фраза: «Я поискал в Google по следующему запросу, но ничего полезного не нашел» пригодится при обращении за помощью по электронной почте или в дискуссионную группу. Подготовьте вопрос. Продумайте его. На поверхностные вопросы вы получите поверхностные ответы, или вообще ответов не получите. Чем больше вы сделаете, чтобы продемонстрировать свои размышления и усилия по решению проблемы до того, как просить помощи, тем вероятнее, что вы эту помощь получите. Не задавайте неправильных вопросов. Если вопрос строится на ошибочных предположениях, любой хакер (в оригинале — J. Random Hacker, прим. переводчика), скорее всего, даст бесполезный буквальный ответ, подумав при этом «Глупый вопрос…», и надеясь, что получение того, о чем вы просили, вместо того, что действительно нужно, чему-то вас научит. Не думайте, что вам должны ответить. Вам никто ничего не должен; вы же, в конечном счете, не платили за эти услуги. Вы получите ответ, если заслужите его, задавая существенный, интересный и наводящий на размышления вопрос — вопрос, неявно дающий сообществу новый опыт, а не просто пассивно требующий от других поделиться знаниями. С другой стороны, неплохо сразу ясно дать понять, что вы можете и хотите помочь в процессе выработки решения. На вопросы типа «Может ли кто-то подсказать?», «Что не учтено в моем примере?» и «А нет ли сайта, который стоит на эту тему посмотреть?» более вероятно будет получен ответ, чем на требование прислать точную последовательность действий для решения проблемы, поскольку вы явно показали, что решите проблему сами, если кто-то укажет вам правильное направление действий.

Сообщение для клиентов, связанное с COVID-19

В целях профилактики распространения короновируса cлужба поддержки компании Samsung Electronics работает в сокращенном режиме. Samsung принимает меры для защиты здоровья сотрудников и клиентов.

Чтобы обратиться в службу поддержки Samsung, воспользуйтесь способами связи, которые указаны ниже. Специалисты ответят максимально оперативно.

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

Наиболее частые вопросы, задаваемые юристам

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

Поэтому, прежде чем задать вопрос или попросить оказания услуги, попробуйте все правильно сформулировать:

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

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

Система 1

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

Ее можно представить как автопилот нашего мозга. Если кто-нибудь спросит вас, сколько будет два плюс два, вы автоматически, не прилагая никаких умственных усилий, ответите «четыре». В Системе 1, в состоянии, которое Канеман называет «когнитивной легкостью», мы чувствуем себя расслабленными, спокойными и все контролирующими. Человек, задающий вопросы, может подключить собеседника к Системе 1, спросив о погоде или предмете одежды или даже просто предложив чашечку кофе. Этот радушный и привычный жест успокаивает.

Система 2 — своего рода «турборежим», который заставляет мозг функционировать быстрее и усерднее и потреблять больше кислорода. Он включается в ответ на нечто незнакомое, трудное или пугающее. Сложная математическая задача или спорная ситуация погружает вас в это состояние. Вы останавливаетесь, реагируете и пытаетесь найти ответ. Мозг в Системе 2 напряжен и всегда настороже. В незнакомой или недружелюбной обстановке он работает именно так. Мы начинаем обдумывать каждое слово, которое собираемся сказать. Сколько будет 435 разделить на 9? Это ты взял мою бутылку джина?

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

Спросите о чем-нибудь обычном или об известных вам событиях из жизни человека, которые не вызовут у него никаких подозрений. Допустим, агент приходит к некоему Джозефу, имя которого всплыло при расследовании. Пока Джозеф считается источником, а не подозреваемым. Войдя в гостиную, агент замечает на стене картину. Мне нравится эта картина. Кто ее написал? Если только предмет расследования агента не кража произведений искусства, такой вопрос — звучащий как признание, даже как комплимент — может помочь растопить лед. Тема искусства позволяет Джозефу поговорить о чем-то знакомом, оставаясь на привычной почве. Как объясняет Бэрри, агент должен слушать внимательно и, если Джозеф ответит спокойно и открыто, задать еще какие-то вопросы о картине, чтобы за несколько минут легкой беседы перевести его в состояние «когнитивной легкости».

Читайте также:  Как сделать самую эффективную печь длительного горения своими руками

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

ЗАПИСЬ ТЕЛЕФОННОГО РАЗГОВОРА

Опцию записи телефонных разговоров предлагают большинство операторов и виртуальных АТС.

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

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

Почему так важно уметь задавать нужные вопросы? 

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

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

А вот неуместные и назойливые вопросы могут отпугнуть человека, заставить его «закрыться» и даже отказаться от сотрудничества.

Иммануил Кант был уверен, что ставить грамотные вопросы способны только умные и проницательные люди: «Бессмысленный вопрос требует бессмысленного ответа… Кроме стыда для вопрошающего, он имеет иногда еще тот недостаток, что побуждает неосмотрительного слушателя к нелепым ответам и создает смешное зрелище: один (по выражению древних) доит козла, а другой держит под ним решето»

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

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

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

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

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

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

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

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

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

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

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

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

Активировать скидку →

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

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

Читайте также:  Как выбрать газовый котел для отопления дома

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

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

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

Ой-ой, твой браузер не поддерживает видео.

Что еще может приложение

Нижняя кнопка в меню — «Прямой эфир». Когда вы нажимаете на нее, вы переходите на канал Россия-1. Трансляция уже ведется.

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

Вывод автора и постов из нужных категорий на странице вопроса

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

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

Вывод автора и постов из нужных категорий на странице вопроса

* 78,79,80 меняем на ID своих рубрик. Стили можно вынести в файл , но в данном примере я не заморачивался.

Получаем такой результат:

Каким должен быть раздел «Вопрос-ответ»

Посмотрите на сервисы

  • (бесплатный)
  • (бесплатен ограниченный функционал)
  • (платный)

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

Так вот, что отличает хороший раздел «Вопрос-ответ».

  • Легко найти нужный вопрос ли понять, что его ещё не задавали. Лучший вариант это поиск по базе вопросов — по мере набора в выпадающем окне демонстрируются похожие на набираемый.
  • Легко оставить свой вопрос. Чем меньше нужно пользователю действий для того, чтобы задать вопрос, тем охотнее он это сделает. Вот регистрация, например: сейчас популярны регистрация/авторизация с помощью социальных сетей. Два нажатия на кнопку и пиши — красота! Без регистрации (только почту нужно оставить для извещения об ответе) — лучше! А если есть поиск — пусть человек, если не нашёлся вопрос, нажимает одну кнопку и открывается форма, в которой заголовок вопроса уже вписан (текст, который был набран в поиске).
  • Человек может получить ответ не только на сайте, не факт, что он будет заходить на него — пусть уведомление приходит на электронную почту или в социальную сеть. Можно позволить регистрироваться через , но просить при этом указать социальную сеть.
  • Продуманный дизайн — без него вообще никуда.

Если у вас есть какие-то вопросы или своё мнение — добро пожаловать в комментарии.

Напоследок видео от том, как точно не надо отвечать на вопросы: