Как работать со справкой?

Документы справки и порядок их чтения

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

  1. Общие термины и Сокращения – для ознакомления с терминологией, используемой в нашей документации.
  2. Описание демо-версии Business Studio (только для пользователей демо-версии программы).
  3. Руководство пользователя – для получения базовой информации об установке программы, работе программы в целом.
  4. Руководство технического специалиста (только для технических специалистов, имеющих отношение к развертыванию Business Studio и поддержке ее работы) – для получения продвинутой технической информации о развертывании программы, внесения изменений в структуру базы данных, интеграции с другими системами через OLE.
  5. Методики из одноименного раздела страницы Справка (те из них, что требуются вам для работы) – для получения детальной информации о том, как можно решать различные методологические задачи с помощью Business Studio.

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

Виды справки

Справка по Business Studio бывает следующих видов:

  • Справка с сайта https://www.businessstudio.ru/

    Плюсы:
    + Регулярно обновляется (чаще, чем выходят релизы Business Studio).
    + Не требует установки на компьютеры пользователей.
    Минусы:
    - Требует для работы доступ в интернет.

  • Локальная справка

    Плюсы:
    + Не требует для работы доступ в интернет.
    Минусы:
    - Обновляется только в рамках крупных релизов программы.
    - Требует установки на компьютеры пользователей.

Выбор используемого типа справки доступен в программе Business Studio по кнопке Настройка справки (Главное меню → Помощь → Наcтройка справки).

Способы вызова справки

Справка по Business Studio может быть открыта следующими способами:

  1. Из окна программы Business Studio.

    В этом случае справка будет открыта в интерактивном режиме (см. Интерактивные возможности справки).
    Открыть справку в таком режиме можно любым из следующих способов:
    • По кнопке Вызов справки (Главное меню → Помощь → Вызов справки).
      Справка будет открыта на своей главной навигационной странице.
    • Нажатием клавиши F1.
      Если возможно для данной ситуации, будет предложен выбор, какую справку открыть: по интерфейсу (т.е. по тому типа окна, из которого вызвали справку) или по текущему справочнику (т.е. по тому справочнику, данные из которого были представлены в этом окне). В зависимости от выбора пользователя, справка будет открыта на соответствующей странице.
      Если выбора для данного окна нет – будет открыта справка по интерфейсу.
    • Нажатием кнопки «?» в правом верхнем углу окна.
      Реакция системы будет той же, что и при клике по клавише F1 (см. описание выше).

  2. Во внешнем веб-браузере по ссылке на конкретную статью справки, например, при переходе по ссылке на справку с сайта https://www.businessstudio.ru/

    В этом случае справка будет открыта в неинтерактивном режиме.

Интерактивные возможности справки

Если справка вызвана из окна программы Business Studio (см. Способы вызова справки), то она будет открыта в интерактивном режиме. Интерактивный режим предоставляет следующие возможности:

  1. Открытие окна справки непосредственно в окне программы Business Studio.

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

  2. Поддержка интерактивных ссылок.

    Это такие ссылки, при клике по которым происходит какое-либо действие в окне программы Business Studio: с помощью выделения жирным и/или вывода всплывающей подсказки делается визуальное указание на определенный интерфейсный элемент (команда Главного меню, вкладка Навигатора), открываются окна и т.п. Такие ссылки позволяют сразу увидеть описываемый в справке функционал непосредственно в окне программы.
    Чтобы отличать визуально интерактивные ссылки от обыкновенных навигационных ссылок, они не только синего цвета, но и выделены жирным (см. разницу между первыми двумя и последними двумя ссылками на Рис. 1).
    Рисунок 1. Навигационные и интерактивные ссылки

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

Поиск в справке

В правом верхнем углу окна справки имеется область поиска: кнопка "Поиск" и поле для ввода искомого слова или фразы (см. Рис. 2).

Рисунок 2. Область поиска

Поддерживается не только поиск по точному совпадению фразы, но и более детальные настройки, подробнее о них см. по ссылке https://www.dokuwiki.org/ru:search

Сценарии работы со справкой

Ниже приведено несколько типовых сценариев работы со справкой:

  • От чтения справки к работе в программе

    1. Запуск Business Studio.
    2. Вызов справки (см. Способы вызова справки).
    3. Чтение справки с параллельным изучением описываемого в самой Business Studio в том числе с помощью интерактивных ссылок (см. Интерактивные возможности справки).

  • От работы в программе к чтению справки

    1. Запуск Business Studio.
    2. Работа в программе.
    3. При возникновении необходимости почитать справку по используемому функционалу – вызов справки по нему (см. Способы вызова справки) и ее изучение.

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

Обратная связь от пользователей

В нижней части страниц справки находятся кнопки для оценки статей (см. Рис. 3).

Рисунок 3. Кнопки для оценки статьи

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

« ПредыдущаяНа уровень вышеСледующая »
 
Driven by DokuWiki