Использование документации из интерфейса 1С Предприятия

Назначение документации

Документация делится на два назначения:

• Основная - описание системы;
• Дополнительная - описание созданных пользователями элементов справочников.

Основная

Вызов основной документации

Основная документация описывает систему в целом и хранится на данном сайте.

Для описания:

• Особенностей работы с системой;
• Назначения и свойств объектов конфигурации;
• Назначения и свойств подключаемых модулей.

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

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

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

В меню справка может быть один или два вложенных пункта:

Справка по виду данных - этот пункт есть всегда в меню Справка, он открывает описание текущего справочника.

Открыть справку по номенклатуре

Пример справки по виду данных:

1. Справочник Номенклатур, данный пункт откроет страницу с описанием справочника Номенклатура;

Справка по модулю - открывает справку по модулю, выбранному профиле с настройкой из выбранной строки.

Открыть справку по модулю из профиля

Пример справки по модулю:

1. Справочник Обработка данных. В данном случае два пункта:
   • Справка по виду данных, откроет общую справку по справочнику Обработка данных;
   • Справка по модулю, откроет справку по модулю, выбранному в профиле настройки задачи.
2. Справочник Профили API. В данном случае два пункта:
   • Справка по виду данных, откроет общую справку по справочнику Профили API;
   • Справка по модулю, откроет справку по шаблону, выбранному в профиле.

Индивидуальная справка - называется по разному, вызывает справку по конкретной форме. Не по справочнику на форме, а именно по самой форме.

Справка по анализу прайс-листов

Пример индивидуальной справки:

1. Обработка Анализ прайс-листов. В данном случае два пункта:
   • Справка по виду данных, откроет общую справку по справочнику Товары поставщиков;
   • Справка по анализу прайс-листов, откроет справку по самой сервисной обработке анализа прайс-листов.

Дополнительная

Открыть дополнительную справку с описанием профиля настройки задачи

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

Для описания:

• Профилей с настройками, обмена данными;
• Настроенных задач по обработке данных;
• Настроенных источников данных;

Данных из других справочников.

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

Пример дополнительной справки:

1. Справочник Обработка данных с выбранной строкой настройки задачи MediaWiki, описание метаданных. Откроет страницу с описанием профиля настроенной задачи.

Настройка

Форма общих настроек системы

Инструменты \ Общие настройки \ Настройка системы

Основной Wiki

Настройка основной документации, по видам данных системы. Ссылка на данный сайт, с основной документацией: http://un.web-kat.ru/index.php/.

Дополнительный Wiki

Шаблон ссылки дополнительной документации

Настройка дополнительной документации, по объектам данных. Текстовый шаблон формирования ссылок на страницы документации.

Важно!!! Требуется наличие собственной системы вики. Это может быть CMS MediaWiki установленное на хостинге организации или Яндекс.Вики. Главное требование, что бы система вики поддерживала создание новых страниц по переданной произвольной ссылке.