Содержание статьи:
- Что такое руководство пользователя и почему оно необходимо
- Общие рекомендации по разработке руководств пользователя
- Виды руководств пользователя
- Структура руководства пользователя программы
- Преимущества создания РП на онлайн-платформе управления документацией
В жизни часто возникают ситуации, когда необходимо руководство пользователя. Инструкции могут понадобиться, например, при монтаже окон, если вы решите делать это сами. А также после приобретения нового оборудования для офиса или дома, например, принтера или кофемашины. Даже в этих, казалось бы, простых бытовых случаях, необходимо иметь под рукой руководство по установке, использованию и обслуживанию нового оборудования.
Если речь идет о цифровом продукте, руководство помогает пользователям понять основные функции и использовать новую программу или сайт максимально эффективно.
В этой статье вы узнаете, что такое руководство пользователя, какие виды руководств существуют и как создать руководство пользователя программы с использованием современных онлайн-инструментов.
Что такое руководство пользователя и почему оно необходимо?
Руководство пользователя (РП) – это документ, который предоставляет подробную информацию о том, как использовать определенное оборудование, программу или сайт. В руководстве предоставляются инструкции по установке, порядок выполнения последовательности действий по настройке и использованию оборудования или ИТ-продукта, а также описание функций, возможностей и рекомендации по их использованию.
РП помогает новичкам быстрее освоиться с программой или сайтом, избежать ошибок и максимально эффективно использовать их возможности. В случае опытных пользователей РП необходимо для обеспечения подробной информации о всех возможностях и функциях программы. Оно помогает пользователям освоить более сложные, «продвинутые» функции, узнать о возможных проблемах и их решениях, а также повысить производительность и эффективность работы. РП также может включать в себя советы по эксплуатационной безопасности и рекомендации по оптимальным настройкам для получения наилучших результатов.
Общие рекомендации по разработке руководств пользователя
При разработке РП следует учитывать несколько факторов:
- Целевая аудитория. Определите, кому предназначено ваше РП. Учитывайте уровень их знаний и опыта в использовании программы или сайта. Например, если руководство предназначено для начинающих (рядовых пользователей), необходимо предоставить более детальные пошаговые инструкции. Если аудитория – это люди, которым нужны особые, нечасто используемые функции программы/сервиса, то РП должно иметь другую глубину изложения материала.
- Язык. Язык должен быть ясным и доступным. Необходимо избегать технических терминов и особенно профессионального сленга – жаргона, на котором говорят специалисты. Как правило, он непонятен рядовым пользователям, поэтому не заставляйте их читать РП со словарем. Объясняйте термины, которые могут быть незнакомы новым пользователям.
- Стиль. Определенные типы документов позволяют использовать яркий, почти «рекламный» стиль изложения. Однако, стилистически окрашенная лексика может отвлекать пользователя от содержания. Поэтому оптимальным вариантом будет написать РП в нейтрально-официальном формате.
- Структура. Разделите руководство на логические разделы и подразделы, чтобы облегчить поиск информации. Обязательно пронумеруйте страницы. Это позволит облегчить навигацию по документу. Этой же цели служат и гиперссылки.
- Практические примеры. Иллюстрируйте РП практическими примерами использования программы или сайта. Это поможет пользователям лучше понять, как применять их на практике.
- Иллюстрации. Добавьте скриншоты, диаграммы и другие визуальные материалы и инфографику. Это сделает документ более сбалансированным (уравновесит соотношение «текст – визуальные материалы») и даст пользователям отдохнуть от обилия текста.
- Обратная связь. Предоставьте контактную информацию, чтобы пользователи могли задавать вопросы или давать обратную связь о руководстве.
- Обновление. Руководство пользователя должно регулярно обновляться в соответствии с изменениями в программе или на сайте.
Следуя этим рекомендациям, вы сможете создать полезное и понятное руководство пользователя программы, которое поможет пользователям освоить функции и возможности вашего продукта.
Виды руководств пользователя
Каждое РП – это способ общения между пользователем продукта и его владельцем/разработчиком. Как и любой продукт РП ориентируется на пользователя и меняет свою структуру и содержание в соответствии с запросами пользователя.
В основе классификации РП могут быть заложены различные принципы. Наиболее простой подход – это классификация РП по целевой аудитории. Это могут быть администраторы, программисты, операторы, пользователи программы или сайта.
Руководство администратора предназначено для администраторов организации или компании и описывает правила и процедуры, которым должны следовать администраторы. Типичными разделами этого документа являются политика безопасности, правила обслуживания клиентов и т. д.
Руководство программиста предназначено для программиста и помогает ему выполнить конкретную задачу или работу в рамках проекта. Данный документ содержит информацию об используемых языках программирования, инструментах и библиотеках и т.д. Это важный инструмент, облегчающий написание кода и обеспечивающий согласованность и высокое качество.
Руководство оператора ПО – это документ, используемый операторами конкретного программного обеспечения. Он содержит информацию о том, как использовать программу, описание ее функционала, а также инструкции по установке, настройке и обслуживанию. Руководство оператора программного обеспечения помогает пользователям «понять» программное обеспечение и решать с его помощью конкретные задачи.
Руководство пользователя сайта – это документ, который предоставляет инструкции для пользователей сайта. Оно содержит информацию о том, как пользоваться различными функциями и возможностями сайта, как регистрироваться, входить в свою учетную запись, оставлять комментарии, отправлять сообщения и т.д.
Руководство пользователя сайта имеет место, когда речь идет о программном обеспечении как услуге (англ. software as a service или SaaS). По сути, данное РП представляет собой способ коммуникации между провайдером услуги и пользователем. В документе описывается принцип отношений двух сторон: подписчики получают доступ к готовому ПО в облаке через мобильное приложение или веб-браузер, которое обслуживается провайдером (он занимается установкой, обновлением и обслуживанием).
Руководство пользователя сайта и руководство пользователя программы фактически имеют минимальные отличия. Основной упор делается на то, как пользоваться новым инструментом, однако в случае руководства пользователя сайта данный инструмент (программа) размещается на сайте владельца.
Структура руководства пользователя программы
Каждое РП имеет свои особенности, которые определяют его структуру. Поэтому сложно выработать общие рекомендации и требования, которые будут применимы ко всем случаям. Если вы все-таки ищете универсальные рекомендации, то вам следует обратиться к РД 50-34.698 (Комплекс стандартов и руководящих документов на автоматизированные системы), где перечислены самые частотные разделы, встречающиеся в руководствах пользователя (соответствует ГОСТ):
- Введение. Содержит краткое описание области применения ПО и его функционал;
- Назначение. В данном разделе дается ответ на вопрос «зачем?» (зачем пользователю данное приложение, для чего оно служит, какие задачи призвано решить, как облегчает жизнь пользователя и т.д.);
- Подготовка к работе. В данном разделе приведена информация о том, что необходимо для начала работы. Описывается комплектность дистрибутива, процедуры установки и загрузки, а также способы функциональных испытаний;
- Описание операций. Это основной и самый объемный раздел, в котором с помощью подробных инструкций и скриншотов описываются функции программы. Таким образом пользователь понимает, как работать с данными и выполнять конкретные задачи.
- Аварийные ситуации. Содержит описание аварийных ситуаций (неисправностей и сбоев в работе программы) и инструкции по их ликвидации;
- Рекомендации. В этом разделе предлагаются примеры использования ПО или сервиса, которые позволяют пользователям совершенствовать свои навыки владения данным инструментом.
Шаблон, описанный выше, не является универсальным или обязательным и его состав может быть изменен и дополнен другими пунктами. В большинстве случаев основной раздел делится на несколько подразделов в соответствии с их функциями или задачами. Также могут быть добавлены такие разделы как «Начало работы», «Лучшие практики», «Лицензия», «Контакты» и др.
Преимущества создания РП на онлайн-платформе управления документацией
Современные средства для создания и управления документацией преимущественно существуют в форме ПО, предоставляемом в качестве услуги (software as a service). Они представляют собой максимально удобные инструменты для оформления РП.
Документерра – один из таких инструментов. Это облачная платформа для создания, публикации и управления документацией. Она включает в себя функции по работе с различными типами файлов (текстовыми документами, таблицами, презентациями, изображениями и т.д.), возможность совместной работы над документами, доступ к файлам из любой точки мира через интернет, систему управления версиями, автоматизации процесса работы с документацией и другими инструментами для удобной работы с документами.
При интеграции в корпоративную информационную систему Документерра дает пользователям следующие преимущества:
- Доступность. Пользователи могут получить доступ к руководству в любое время и в любом месте при условии подключения к интернету.
- Обновляемость. Управление документацией онлайн обеспечивает легкое и мгновенное обновление информации, что позволяет пользователям всегда быть в курсе последних изменений.
- Поиск и навигация. Пользователи могут легко выполнять поиск и навигацию по РП с помощью поисковых функций и гиперссылок.
- Аналитика. Предоставление аналитической информации об использовании РП позволяет создателям документации улучшать и оптимизировать контент.
- Совместная работа. Авторы могут совместно писать контент и работать над улучшением РП, внося свои комментарии и предложения.
- Масштабируемость позволяет легко расширять содержание руководства с ростом продукта или услуги.
***
Создание руководства пользователя программы может показаться довольно сложной задачей. Однако, в итоге вы получите целый ряд преимуществ, из которых наиболее важным является улучшение пользовательских параметров ИТ-продукта. РП помогает пользователям более эффективно использовать продукт или услугу, извлекая максимальную пользу. Хорошо спроектированное руководство пользователя программы может уменьшить количество обращений в техническую поддержку, поскольку пользователи могут решать часть проблем самостоятельно.
Таким образом, руководство пользователя программы является важной составляющей для обеспечения удобства и успешного использования продуктов или услуг.
Что такое руководство пользователя и для чего его создавать
Ежедневно создаются новые продукты, программы, сервисы и часто пользователям приходится несладко при освоении какой-нибудь сложной программы, поэтому каждому новому продукту желательно собственное руководство. Для чего?
Большинство людей не хочет разбираться с чем-то незнакомым без персонального, всегда доступного и понятного помощника. А именно им и является хорошее руководство пользователя.
Общие советы по созданию пользовательской документации
Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать — рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.
После этого важно подумать о том:
- Где пользователь будет к нему обращаться: дома, на работе, в машине?
- Как часто он будет его просматривать?
- Насколько объективно сложен для понимания продукт?
Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым «справочником» или объемным «путеводителем» Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.
Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?
Структура руководства пользователя
После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего «путеводителя» хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.
В первом разделе желательно рассказать общую информацию о программе:
- Для чего создан продукт.
- Какие задачи он решает.
- Какие основные выгоды от использования для клиента.
В следующем разделе можно указать основные элементы пользовательского интерфейса. Пользователю будет трудно разобраться в софте, если он не поймёт для чего служат различные элементы интерфейса, или он не разберётся в основных режимах работы ПО. Опишите понятным языком предназначение экранов и окон.
Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.
Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.
Иногда технические писатели забывают о важном моменте в руководстве пользователя — контактная информация. Этот раздел поможет пользователям связаться с вами, даже если у них нет никаких вопросов и руководство полностью закрывает все их потребности. Клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.
Инструменты для быстрого создания руководства пользователя
Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.
Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.
Видео-обзор основных возможностей программы Dr.Explain
Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: 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 позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.
Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.
Почему компании выбирают Dr.Explain для создания руководств пользователя
Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»
«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.
Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».
Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке
Наталья Обухова, бизнес-аналитик компании CRM Expert
«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.
Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.
Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.
Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».
Возможность установки статуса раздела тоже оказалась очень удобной, особенно, после импорта старой версии справки легко отслеживать, какие разделы требуют обновления, в каких еще ведутся изменения, а какие уже обновлены и актуальны».
Прочитать полный кейс компании CRM Expert
Николай Вальковец, разработчик компании 2V
«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».
Прочитать кейс компании V2
Подытожим
Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.
Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/
Успешных вам разработок!
Всем доброго времени суток, кто решил прочитать статью, посвященную документации. Здесь вы найдёте как общие, так и довольно специфические советы по созданию руководства пользователя. Надеюсь, они будут вам полезны.
Приятного чтения.
Если перед вами стоит вопрос – нужно ли вашему продукту пользовательское руководство, то отвечу сразу – да, нужно. Почему? На это есть две причины:
1. Качественная документация повышает лояльность клиента и ценность продукта в целом.
Как это не странно, но люди до сих пор читают пользовательскую документацию. Конечно, не просто так, а когда сталкиваются с проблемой. И если с руководством все хорошо, то пользователь быстро найдет ответ на свой вопрос – это будет ещё один балл в копилку вашего проекта!
2. Руководство пользователя экономит время и силы техподдержки.
Данный факт напрямую зависит от первого. Если документация качественная, то пользователи будут редко обращаться в техподдержку, и ваша команда будет работать с действительно нестандартными ситуациями. Ну а если руководство «так себе», то поддержка будет завалена однотипными вопросами. Из-за этого пользователям придется дольше ждать ответа, поддержке больше работать, а это в свою очередь будет злить как пользователя, так и команду.
А теперь к советам!
Прежде чем начинать писать руководство пользователя нужно ответить на несколько вопросов. — Для кого вы пишите? Кто будет пользоваться файлом справки? (ваша целевая аудитория)
— Где скорее всего пользователи будут прибегать к документации? (дома, на работе, в машине)
— Насколько объективно сложен для понимания продукт и как часто пользователь будет обращаться к документации?
И так, вы ответили на эти вопросы и теперь можете сделать вывод какого размера документация вам нужна, какой стиль изложения в ней использовать, и как часто пользователь будет читать документ.
(Для изложения лучше всего выбрать нейтрально-формальный стиль)
У любого качественной документации продуманная и логичная структура. Представьте, что вы сами работаете в программе и сталкиваетесь с проблемой. Открываете файл справки – а там просто сплошной текст. Такая документация вам не поможет.
Создайте оглавление, которое будет началом вашего руководства. Оно поможет вам в дальнейшем написании документации, а также поможет пользователю ориентироваться в тексте.
В первом разделе расскажите общую информацию о продукте. Для чего создан проект и какие задачи он решает.
Во второй «главе» укажите основные элементы интерфейса. Клиент вряд ли сможет достичь своей цели в программе, если не будет знать для чего служат различные детали интерфейса. Объясните предназначение всех окон, кнопок и так далее.
Дальше расскажите, как эффективно пользоваться программой. Какие задачи стоят перед пользователем и как продукт быстро их решает.
В любом руководстве желательны разделы «Частые вопросы» и «Устранение типовых проблем». Расскажите о проблемах, с которыми часто сталкиваются клиенты и о путях их решения.
Информацию для этого раздела лучше брать у техподдержки. Проанализируйте, какие вопросы задаются чаще всего и ответьте на них один раз максимально информативно.
И последний «обязательный» раздел, которой точно должен быть в любой документации – «контактная информация». Данный раздел даст пользователю возможность связаться с разработчиком. Если руководство вдруг не закры��ает потребность читателя, то он может обратиться в поддержку. Кроме того, клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.
Профессиональный совет: если вы хотите максимально облегчить ношу клиента при чтении документации создайте контекстно-зависимую справку. Что это такое?
Представьте, что вы работаете в программе для создания пользовательской документации. Открываете меню основных настроек и видите раздел «аннотирование экрана» Заходите в него, там показаны разные стили аннотации, тени, фон и так далее. Но что такое аннотация? Допустим вы не знаете — нажимаете кнопку F1 и перед вами открывается руководство именно на той странице, где рассказано об «аннотировании экрана»
Как ее сделать? Смотрите ниже.
И так, мы создали «каркас» нашей документации, но чтобы руководство стало полезным нужно наполнить её компетентной информацией.
Конкретного совета дать невозможно, так как все продукты разные. Поэтому расскажу про общие положения, которые делают документацию лучше.
1. Понятность.
Помните, что руководство будут читать люди, которые не сильно знакомы с вашим продуктом. Пишите простым языком, избегайте профессиональных терминов. Руководство пользователя должно быть написано на языке этого самого пользователя, а не на языке писателя.
2. Наглядность.
Добавляйте в руководство побольше графики и скриншотов с аннотациями. Читателю будет проще и приятнее решать проблему, если будет наглядно показано как это делать.
3. Видео.
Лучше один раз увидеть, чем сто раз услышать. Продемонстрируйте пользователю последовательность действий для достижения конкретной цели. Документация, содержащая видео вставки будет пользоваться большей популярностью, чем обычный текстовый документ.
Но как добавить в документацию видео? Смотрите ниже.
Больше советов!
Когда документация будет готова, чтобы она стала «полноценной» её нужно опубликовать. Иначе какой от неё толк, если клиент не может её прочитать. У «юзера» всегда должен быть доступ к документации, и не важно где он. Такую потребность легко закрывают три формата: HTML, PDF и CHM.
Создайте файл справки и загрузите его прямо в вашу программу в формате CHM. Таким образом, у пользователя будет возможность открыть документ, не выходя из программы. Не забудьте добавить элемент вызывающий руководство в меню программы.
Выложите руководство на сайт в формате HTML, чтобы клиент мог обратиться к документации, даже не работая с программой. Кроме того, документация, выложенная на сайт, повышает SEO факторы сайта.
И напоследок, переведите ��ользовательскую документацию в формат PDF, чтобы клиенты могли скачать и распечатать руководство.
Но помните, что после публикации документации, придется иногда её обновлять.
Для того, чтобы написать, а затем опубликовать документацию одного Wordа не хватит, но и пользоваться большим количеством программ тоже не хочется.
Ну и пользуясь случаем, я хочу рассказать про проект, в котором я работаю уже много лет и который закрывает все потребности писателей пользовательской документации.
Dr.Explain – программа для создания руководств пользователя для ПО, web-сервисов и баз знаний.
Благодаря «доктору» вы сможете опубликовать и обновлять документацию в востребованных форматах (CHM; HTML; PDF; DOC), не выходя из программы.
В программе есть шаблоны документации, ведь по образцу работать проще.
Импортируйте в программу заранее написанные фрагменты документации.
Вы сможете создать контекстно-зависимую документацию, настроить визуальный стиль руководства, добавить в него видео и многое другое!
Если вы хотите создать по-настоящему хорошую документацию – придется потрудиться, потому что это займет много времени и усилий всей команды. Но игра стоит свеч, так как после этого вы получите лояльных и довольных клиентов.
Руководство пользователя должно стать персональным гидом по продукту для клиента. Если пользователь останется недовольным после работы с документацией, то это может повлиять на решение отказаться от продукта.
Работая с Dr.Explain, можно быстро написать пользовательскую документацию, которая будет помогать клиентам разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.
Спасибо за внимание!
Скачать Dr.Explain бесплатно можно по адресу: https://www.drexplain.ru/download/
Со всеми возможностями Dr.Explain можно ознакомиться здесь:
Руководство пользователя
Руководство пользователя – это основной документ в составе эксплуатационной документации на автоматизированную систему (ГОСТ 34). Очевидно ли это?
Назначение руководства пользователя
Цель создания документа заключается в том, чтобы предоставить пользователю возможность самостоятельно решать свои прикладные задачи с помощью системы. Этой цели может служить и введение в предметную область, и ознакомление со всеми возможностями программы, и описание конкретных процедур решения задач, и приведение различных инструкций. Иногда Руководство пользователя больше похоже на справочник, к которому можно обращаться в процессе работы, а иногда – на учебник, который позволяет изучить принципы работы с программой и ее возможности, а затем применять их на практике.
Состав типового руководства пользователя
Конкретный подход к написанию определяется многими факторами:
- назначением программы и областью ее применения;
- сложностью программы;
- количеством разнообразных вариантов использования.
Принимая во внимание все различия и особенности, сложно привести структуру любого Руководства пользователя к одному виду. Тем не менее, РД 50-34.698 предлагает нам такой список разделов:
- Введение, где указывают область применения ПО, краткое описывают его возможности, требуемый уровень знаний пользователя и список документов, которые необходимо изучить помимо настоящего руководства;
- Назначение и условия применения, где описывают виды деятельности и функции, которые автоматизированы и условия, при соблюдении которых автоматизация используется;
- Подготовка к работе, где описывают комплектность дистрибутива, порядок установки и загрузки программы, а также способ проверки ее работоспособности;
- Описание операций, представляет собой основной раздел, где описывают функции программы, процессы работы с данными, выполнение конкретных задач пользователя;
- Аварийные ситуации, где описывают действия в нештатных ситуациях – сбоях в программе, ошибок в данных и т.д.;
- Рекомендации по освоению, где приводят методические рекомендации по изучению программы и примеры использования.
Данная структура может меняться и дополняться – например, основной раздел часто разбивают на несколько значимых разделов по группам функций или задач, также в современных системах нередко добавляют раздел Интерфейс пользователя, где описывают взаимодействие пользователя с программой с примерами и снимками экрана.
Стандарты для руководства пользователя
Наличие Руководства пользователя регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства пользователя могут отличаться друг от друга по способу, методике и стилю изложения.
Заключение
Грамотно написанное Руководство пользователя может сэкономить значительное количество времени на обучение и адаптацию пользователя к программе, а также снизить количество ошибок в работе что, в свою очередь, повышает экономическую эффективность системы. Если вы не хотите вникать во все тонкости создания Руководства пользователя, но хотите иметь полный, качественный и полезный документ – обратитесь в компанию ТехРайтКонсалт, и мы применим весь наш опыт и знания для решения вашей задачи по доступной цене!
Вас также может заинтересовать:
- разработка руководства администратора;
- создание руководства программиста;
- разработка руководства оператора.