Горячая линия бесплатной юридической помощи:
Москва и область:
Москва И МО:
+7 (495) 980-97-90 (бесплатно)
Санкт-Петербург и область:
СПб и Лен.область:
+7 (812) 449-45-96 (бесплатно)
Регионы (вся Россия):
8 (800) 700-99-56 (бесплатно)

Новости раздела Справки

Новое в российском законодательстве (ежедневно)

Обзор документов федерального законодательства: законов, указов, ведомственных актов и др.

Ежедневное обновление:текущий обзор »архив »

https://www.youtube.com/watch?v=ytcreatorsru

Еженедельное обновление:текущий обзор »архив »

Как выбрать вид и формат хелпа?

Мы разделили справки на следующие виды по назначению:

  • Руководства и инструкции пользователя (оператора, программиста, администратора) — классические справочные документы, которые содержат набор инструкций и описание функционала ПО в зависимости от квалификации пользователя. Предназначены в основном для печати (имеют бумажный вариант).
  • Quick start (Быстрый старт), Getting started (С чего начать) — небольшие (до 10 листов) руководства, цель которых — быстро научить пользоваться продуктом и получить конечный результат. Могут создаваться, пока ещё нет полного руководства, или могут быть частью большого хелпа (со ссылками на соответствующие подробные описания).
  • Online help, WebHelp (Онлайн справка) — хелп, который доступен на сайте производителя. Обычно выполнен в стиле сайта. Очень удобен, так как не нужно сохранять его на локальном диске, в него встроен поиск и кейворды. Онлайн справка помогает улучшить SEO.
  • Wiki (вики) — веб-сайт, структуру и содержимое которого пользователи могут самостоятельно изменять с помощью инструментов, предоставляемых самим сайтом. Плюсы: пользователи сами пишут хелп. Минусы: необходимо изучить вики-разметку, возникают сложности при установке wiki-движка.
  • Статьи «How to…» — статьи (или разделы справки), направленные на решение одной конкретной задачи (пример “Как расшарить USB устройство для компьютеров в локальной сети?”). Как правило, такие статьи содержат конкретную последовательность действий с несколькими скриншотами, описанием возможных проблем и их решением. Данные тексты можно использовать для размещения в сети (включая в них кейворды), что способствует продвижению продукта. В конце статьи How to можно разместить обучающее видео.
  • FAQ (ЧАВО) — вопросы и ответы на них; часто располагаются в конце справки после раздела Troubleshooting. Если предвосхитить большинство таких вопросов и раскрыть их в справке, то можно существенно снизить нагрузку на службу поддержки. Данный раздел рекомендуется постоянно обновлять, основываясь на письмах и отзывах пользователей.
  • EULA (Лицензионные соглашения), Terms of Service (Условия использования), Privacy Policy (Политика конфиденциальности) — разделы справочной документации, которые регулируют юридические отношения между производителем и пользователем, устанавливают ответственность сторон, а также указывают авторские права. Лучше доверить написание этих текстов юристу, чтобы он избавил вас от ответственности за то, что с помощью вашей программы взломали сеть Пентагона.
Еще по теме  Эвакуация автомобиля на штрафстоянку: когда она законна, а когда

Новости раздела Справки

В зависимости от вида справки и места её размещения выбирается один или несколько форматов:

  • DOC (RTF) — Распространённый формат для документации. Если хотите открывать справку на любой платформе и импортировать в различные редакторы, то переведите её в формат RTF.
  • HTML — Формат для онлайн-хелпа. Его можно также открывать на локальном компьютере. Обычно онлайн-хелп представляет собой директорию с HTML, CSS и JS файлами.
  • CHM — Данный формат предназначен в основном для контекстной справки Windows-приложений (F1), CHM документ состоит из сжатых HTML страниц и иллюстраций. Для устранения проблем с открытием CHM файлов, загруженных из сети, можно использовать бесплатную утилиту HHReg.
  • PDF — Формат справки, использующийся для печати. При экспорте в данный формат необходимо обращать внимание на шрифт CID (лучше ставить Unicode), сжатие текста (максимальное) и формат рисунков, иначе конечный PDF файл будет иметь слишком большой размер.
  • EXE (e-Book) — исполняемый Windows файл. Плюсы: не требуется дополнительное ПО для просмотра. Минусы: может содержать вирусы, не так хорош для печати, как PDF; не просматривается на Mac.
  • HXS (MSHC) — форматы справки для Visual Studio (движки MS Help 2 и MS Help 3). Файлы представляют собой zip-архивы с html файлами и изображениями. Используются в основном для документирования кода.
  • ePUB — формат справки, предназначенный для мобильных платформ (iOS, Android, букридеры различных производителей). Для просмотра хелпов в формате ePUB на ПК можно пользоваться бесплатной утилитой Adobe Digital Editions.

Ознакомьтесь с вышеперечисленными описаниями и схемами и ответьте себе на 2 главных вопроса: “Кто будет читать мою справку?”, “Где (и на чём) ее будут читать?”. И все сразу станет на свои места.

Еще по теме  Исковая давность изменения в Гражданском кодексе РФ закон № 100-ФЗ

Перечень измененных документов, введенных в систему КонсультантПлюс

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

Все документы, упоминаемые в списке, включены в информационный банк по федеральному законодательству «Российское законодательство (Версия Проф)» с учетом внесенных в них изменений и дополнений

https://www.youtube.com/watch?v=ytcopyrightru

Еженедельное обновление:текущий обзор »

Оцените статью
Юридическая помощь
Добавить комментарий

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

Adblock detector