Привет, Хабр! Посетите нас по адресу Алконост Клиенты часто приходят и говорят: «Мне нужна справочная система для моей программы.
Дайте мне PaDeeFku».
Мы создаем руководство пользователя, оформляем PDF-файл, а потом оказывается, что нам действительно нужна контекстная помощь с указателем и поиском.
Именно поэтому мне хотелось бы поделиться со всеми простыми схемами и описаниями видов и форматов помощи.
Сразу хочу сказать, что данный материал не является хрестоматийным – данная классификация основана на моем собственном опыте.
Думаю, что пост будет полезен всем, кто хочет создать новый хелп или улучшить существующий.
Виды сертификатов
В зависимости от назначения мы разделили сертификаты на следующие виды:- Путеводители И инструкции пользователя (оператор, программист, администратор) – классические справочные документы, содержащие набор инструкций и описание функционала программного обеспечения в зависимости от квалификации пользователя.
Предназначены в основном для печати (у них есть бумажный вариант).
- Быстрый старт (Быстрый старт), Начиная (С чего начать) – небольшие (до 10 листов) инструкции, цель которых – быстро научить пользоваться продуктом и получить конечный результат. Их можно создавать, пока еще нет полного руководства, или они могут быть частью более крупной справки (со ссылками на соответствующие подробные описания).
- Онлайн-справка, WebHelp (Онлайн-помощь) – помощь, которая доступна на сайте производителя.
Обычно выполнено в стиле сайта.
Это очень удобно, поскольку вам не нужно сохранять его на локальном диске; имеет встроенный поиск и ключевые слова.
Онлайн-помощь помогает улучшить SEO.
- Вики (вики) — веб-сайт, структуру и содержание которого пользователи могут самостоятельно изменять с помощью инструментов, предоставляемых самим сайтом.
Плюсы: пользователи сами пишут помощь.
Минусы: нужно изучать вики-разметку, возникают трудности при установке вики-движка.
- Статьи "Как.
" — статьи (или темы помощи), направленные на решение одной конкретной проблемы (пример «Как расшарить USB-устройство для компьютеров в локальной сетиЭ»).
Как правило, такие статьи содержат определенную последовательность действий с несколькими скриншотами, описанием возможных проблем и их решения.
Эти тексты можно использовать для размещения в Интернете (включая ключевые слова), что способствует продвижению продукта.
В конце статьи «Как сделать» можно разместить обучающее видео.
- Часто задаваемые вопросы (FAQ) - вопросы и ответы; часто находится в конце справки после раздела «Устранение неполадок».
Если вы предвидите большинство этих вопросов и ответите на них в справке, вы сможете значительно снизить нагрузку на свою службу поддержки.
Рекомендуется постоянно обновлять этот раздел на основе писем и отзывов пользователей.
- Лицензионное соглашение (Лицензионные соглашения), Условия использования (Условия эксплуатации), политика конфиденциальности (Политика конфиденциальности) – разделы справочной документации, регулирующие правоотношения между производителем и пользователем, устанавливающие ответственность сторон, а также указывающие авторские права.
Написание этих текстов лучше доверить юристу, чтобы он освободил вас от ответственности за то, что сеть Пентагона была взломана с помощью вашей программы.
Форматы справки
В зависимости от типа сертификата и его расположения выбирается один или несколько форматов:
- ДОК (РТФ) — Общий формат документации.
Если вы хотите открыть справку на любой платформе и импортировать ее в различные редакторы, конвертируйте ее в формат RTF.
- HTML — Формат онлайн-справки.
Вы также можете открыть его на своем локальном компьютере.
Обычно онлайн-справка представляет собой каталог с файлами HTML, CSS и JS.
- ЧМ — Этот формат предназначен в основном для контекстной справки по приложениям Windows (F1), документ CHM состоит из сжатых HTML-страниц и иллюстраций.
Для устранения проблем с открытием CHM-файлов, скачанных из сети, можно воспользоваться бесплатной утилитой.
HHReg .
- PDF — Формат справки, используемый для печати.
При экспорте в этот формат необходимо обратить внимание на шрифт CID (лучше использовать Unicode), сжатие текста (максимум) и формат изображения, иначе конечный PDF-файл будет слишком большим.
- EXE (электронная книга) представляет собой исполняемый файл Windows. Плюсы: для просмотра не требуется дополнительного программного обеспечения.
Минусы: может содержать вирусы, не так хорош для печати, как PDF; не отображается на Mac.
- HXS (МСХЦ) — форматы справки для Visual Studio (движки MS Help 2 и MS Help 3).
Файлы представляют собой zip-архивы с html-файлами и изображениями.
Используется в основном для документирования кода.
- ePUB — формат справки, предназначенный для мобильных платформ (iOS, Android, читалки различных производителей).
Для просмотра файлов справки в формате ePUB на ПК можно воспользоваться бесплатной утилитой Цифровые издания Adobe .
Как выбрать тип и формат помощи?
Прочтите приведенные выше описания и схемы и ответьте себе на 2 основных вопроса: «Кто будет читать мой сертификатЭ», «Где (и на чем) он будет читатьсяЭ» И все сразу встанет на свои места.Вот несколько примеров различных типов справочных материалов: https://alconost.com/services/help-authoring Надеюсь, мы помогли вам сделать этот непростой выбор.
Ждем ваших вопросов и предложений! об авторе Алконост помолвлен локализация приложений, игр и сайтов на 60 языках.
Нативные переводчики, лингвистическое тестирование, облачная платформа с API, непрерывная локализация, менеджеры проектов 24/7, любые форматы строковых ресурсов.
Мы также делаем рекламные и обучающие видеоролики — для сайтов продающих, имиджевых, рекламных, образовательных, тизеров, объяснителей, трейлеров для Google Play и App Store. Более подробная информация: https://alconost.com Теги: #руководство пользователя #помощь #копирайтинг #помощь #форматы справки #справочные системы #вики #начало работы #Как #alconost #разработка веб-сайтов
-
«Платит Звонящий»: Скорее «Да», Чем «Нет»
19 Oct, 24 -
Поиск + Кеширование В Codeigniter
19 Oct, 24
