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

Добавил пользователь Валентин П.
Обновлено: 05.10.2024

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

Очевидны две базовые проблемы. Авторы руководств:

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

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

И с учетом этих представлений создавать текст руководства.

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

Структура руководства

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

Заглянув в такое руководство и потратив впустую некоторое время, пользователь вряд ли воспользуется им вновь. Поэтому очевидно, что:

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

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

С учетом обозначенных замечаний получаем более простую и логичную структуру руководства:

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

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

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

Краткость и стиль

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

Как применить эти принципы на практике рассмотрим на примерах с типичными ошибками.

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

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

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

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

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

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

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

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

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

Для возможности составления акта поступления литературы необходимо составить список источников поступления.

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

Выводы

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

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

Как сделать полноценный гайд в Dota 2?

3. Выбираем героя, на которого хотим создать гайд, и нажимаем ОК.

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

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

Данное руководство включает в себя: как сделать в руководстве баг-картинку и как создать руководство по неизвестной игре/Steam.
Пример: мое руководство.

Открываем любой редактор изображений и создаем изображение с размером 1x120 (1x40 - для маленьких, 1x60 - для средних, 1x120 - для больших).
Заливаем изображение любым цветом, который Вам нравится.
ВАЖНО!: Сохраняем изображение с расширением .jpg.
Готово.

На этом у меня все. Надеюсь Вам понравилось. :]
Немного секретов о Steam Вы можете найти тут.

ЛУЧШИЕ ИНСТРУМЕНТЫ ДЛЯ СОЗДАНИЯ ПОШАГОВЫХ ИНСТРУКЦИЙ И РУКОВОДСТВ - ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ - 2022

Видео: Ангел Бэби Новые серии - Игра окончена (29 серия) Поучительные мультики для детей 2022.

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

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

Создавайте пошаговые инструкции с помощью этих программных инструментов

StepShot

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

Проверьте лучшие функции, которые включены в эту программу ниже:

Используя этот инструмент, вы сможете легко запечатлеть последовательность ваших шагов.
Программное обеспечение будет следовать за вашим курсором, и каждый ваш щелчок приведет к скриншоту.
Вы сможете комментировать изображения с заголовком и описанием.
Вы получите возможность добавить фокус на ваши изображения с помощью простых и мощных инструментов редактирования.
Программное обеспечение позволяет экспортировать документы в PDF, Microsoft Word, HTML-страницы, форматы на основе XML и DITA.
Используя StepShot, вы сможете сэкономить до 90% времени, затрачиваемого на создание справочной документации по программному обеспечению.

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

ScreenSteps

ScreenSteps - это программа, которая позволяет вам делать снимки каждого из этапов процесса демонстрации, который вы пытаетесь продемонстрировать.

Посмотрите на наиболее важные функции и возможности, которые включены в это программное обеспечение:

ScreenSteps автоматически создает документ с каждым снимком экрана в том порядке, в котором вы его сняли.
Вы можете использовать встроенные в ScreenSteps аннотации и текстовые инструменты для добавления бликов, стрелок и текста, а также для успешного и точного завершения учебника.
Вы сможете экспортировать конечный результат в различные форматы, включая PDF, HTML, WordPress, Microsoft Word, Type Pad, Joomla, Blogger, MindTouch, Movable Type и другие.
Используя этот инструмент, вы сможете создать базу знаний для своих сотрудников, а также создать отдельную базу знаний для своих клиентов.

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

Доктор Объяснить

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

Ознакомьтесь с лучшими функциями, которыми вы сможете насладиться, если решите использовать этот инструмент:

Программное обеспечение помогает автоматически создавать файлы, документацию и онлайн-руководства в форматах HTML, CHM, PDF и RTF.
Этот инструмент основан на уникальной системе анализа интерфейса и захвата экрана.
Благодаря этой системе Dr.Explain автоматически анализирует пользовательский интерфейс приложения и делает скриншоты всех элементов управления и элементов.
Затем вы можете добавить пояснительные выноски ко всем изображениям в черновой справочной системе.
В конце концов вам придется добавить описания к этим выноскам и сохранить результат в нужном формате.

Скачайте Dr.Explain бесплатно с официального сайта и попробуйте этот инструмент для себя.

Имаго Рекордер

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

Взгляните на основные функции этого инструмента ниже:

Вы можете скачать программное обеспечение Imago Recorder для Windows и узнать, что еще можно сделать с помощью этого программного обеспечения.

Dokit

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

Проверьте самые интересные функции, которые включены в это программное обеспечение:

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

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

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

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

Каковы лучшие инструменты для создания инфографики в 2019 году?

Если вы не знаете, какое программное обеспечение использовать для создания инфографики на компьютере с Windows 10, вот 12 инструментов, которые вы можете использовать в 2019 году.

Программное обеспечение генератора паролей: лучшие инструменты для создания безопасных паролей

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

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

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

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

p, blockquote 1,0,1,0,0 -->

Как изменить сборку на персонажа вне матча

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

p, blockquote 2,1,0,0,0 -->

p, blockquote 3,0,0,1,0 -->

p, blockquote 4,0,0,0,0 --> p, blockquote 5,0,0,0,1 -->

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

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