Как самому сделать руководство

Простое пошаговое руководство

Итак, вы наконец-то решили написать новое руководство пользователя о своем замечательном продукте.

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

Так как же начать, зачем начинать, зачем вообще нужно руководство пользователя (да…)? Я постараюсь ответить на некоторые распространенные вопросы о создании руководства пользователя, а также помочь вам в создании вашего первого руководства пользователя в Docsie, но вы можете использовать любой другой инструмент…

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

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

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

Создание надлежащих руководств пользователя ограничивает юридическую ответственность продукции:

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

Создание хороших руководств пользователя экономит время:

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

Обучение клиентов использованию ваших продуктов:

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

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

![] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_jripxf4mYymO4f3xy/boo_occBcYZBFuyefSBLr/fe45270c-c55d-dab5-f45c-363cc455ecb821.png)

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

Каждое руководство пользователя фокусируется на решении конкретной проблемы.

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

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

Так что же входит в отличное руководство пользователя?

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

Организация руководств пользователя

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

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

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

Это полезно, когда у вас есть различные типы клиентов, которые используют различные слезы ваших продуктов. Это легко сделать на Docsie, нажав на три точки рядом с «Все» и нажав кнопку добавить.

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

Теперь давайте приступим к написанию первого руководства пользователя с помощью Docsie, это делается с помощью Docsies «Book».

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

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

Редактор прост в использовании, он позволяет добавлять видео, изображения и код с помощью простого в использовании процесса перетаскивания. Также он позволяет стилизовать ваш контент по своему усмотрению.

Статьи очень легко создавать; просто введите заголовок. В данном случае это «Что такое Docsie», но вы можете ввести любое название для вашего руководства пользователя.

![] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_w2Fo0BuxXtGjFQuzx/boo_occBcYZBFuyefSBLr/42e5df8b-db8e-ec6a-6a70-dc0420c427376.png)

Чтобы создать подразделы в руководстве пользователя, которые будут отображаться как 1.1, 1.2…ext, все, что вам нужно сделать, это выбрать местоположение текста и установить текст как «Заголовок», что делается нажатием на H во вкладке редактора.

![] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_OCwuils7ezubiAv8a/boo_occBcYZBFuyefSBLr/1dd88460-f856-79c7-96a9-e43c31fd5f217.png)

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

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

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

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

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

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

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

Писать руководство пользователя по шаблону. Удобно? Удобно

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

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

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

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

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

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

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

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

В связи с этим, мы сами создали готовые образцы и костяки шаблонных проектов в программе. Что входит в нашу базу:

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

• Руководство пользователя web-сервиса.

• Корпоративная база знаний компании.

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

Вы бережете своё время.

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

Вы сосредотачиваете внимание на вашей программе, а не на создании файл-справки

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

Наглядность.

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

 Адаптация шаблонов и образцов под ваш проект.

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

О шаблонах

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

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

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

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

Особые случаи. Здесь нужно рассказать пользователю про то, какие трудности могут возникнуть и как их решить, выделить часто задаваемые вопросы и дать на них самый доступный ответ. Подразделы: «FAQ» и «Устранение типовых проблем»

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

Названия проекта публиковать не будем, Хабр ругается.

P.S. Мы будем рады, если наши образцы помогут вам закрыть вопрос и успешно реализовать документацию в своем проекте.

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

Итак, начнем с того, что условно гайды делятся на два типа:

Определитесь с ЦА

Первый вопрос — кто будет читать гайд? Руководство для новичков — это одно. Гайд для тех, кто уже умеет что-то делать и хочет прокачать скилл, — совсем другое.

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

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

Отжимайте лишнюю воду

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

Вот пример неудачного вступления:

У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.

Надо вот так:

В гайде я собрал 11 способов, как нарисовать круг в «Фотошопе». Руководство подходит для версии СС 2015 и выше.

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

Очень много вступлений, речевых оборотов и т.д.

Кратко или подробно: ищите баланс

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

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

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

Для сравнения:

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

И вот так:

Нарушите инструкцию — песец всему.

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

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

Помните о структуре

«Нет» длинным абзацам. Абзацы больше 6 строк лучше разбивать на две части — так текст читается легче.

Используйте списки. Надо что-то перечислить — делайте список, даже короткий, даже всего из трех пунктов.

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

Чтобы что-то сравнить, создавайте таблицы.

Без картинок никуда

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

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

Нет фотографий — есть YouTube. Найдите видео по теме, сделайте скриншот нужного кадра. Другой вариант — нарисуйте схему в графическом редакторе. Так, если вы пишете гайд по работе с компьютером, делайте много скриншотов. Удалить лишние скрины проще, чем обнаружить, что не хватает какого-то шага, и начинать все сначала.

Конечно, есть вещи, которые ни фотографиями, ни скриншотами не передать. Если надо объяснить, как правильно приседать или сделать потайной шов, поможет GIF-анимация.

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

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

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

Ссылки

Еще раз: гайд должен быть лаконичным. Это не перечисление всех терминов и определений. Однако информативность не должна страдать, поэтому используйте ссылки.

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

Этот рецепт работает и с полными руководствами. Не размещайте огромное текстовое полотно на одной странице, а разбивайте его на разделы с грамотной перелинковкой. Google и Яндекс именно так и устроили гайды для своих сервисов.

Заключение

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

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