Перечень эксплуатационной документации
Каждый модуль Docsvision сопровождается комплектом технической документации.
-
Общая документация — содержит программные и аппаратные требования модуля, описание структуры и функций модуля, требования к лицензии Docsvision.
-
Администрирование модуля — инструкцию по установке и первоначальной настройке, инструкцию по обновлению модуля, функции администратора.
В зависимости от способа разграничения прав пользователей при работе с модулем, документация также может содержать инструкцию по настройке системы Docsvision с помощью функций модуля и другую информацию.
-
Руководство пользователя — содержит инструкцию по работе с функциями модуля. Также может содержать описание основных объектов модуля (карточек) и инструкцию по установке дополнительных компонентов пользовательского уровня.
-
Руководство разработчика — содержит описание программных объектов и функций API модуля, а также инструкцию по разработке компонентов модуля.
-
Описание конструкторов и справочников — содержит описание пользовательского интерфейса и инструкцию по работе с конструкторами и справочниками, которые добавляются модулем в Систему.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
-
Другие документы и инструкции по модулю.
Также документация Docsvision содержит общие документы, относящиеся к нескольким модулям и всей Системе в целом.
Актуальный список документов
Общая документация
-
Общее описание системы — настоящий документ, в котором приведено описание компонентов Системы и взаимосвязей между ними: особенности лицензирования, оказания технической поддержки, перечень эксплуатационной документации.
-
Инструкция по установке системы Docsvision — содержит общие программные и аппаратные требования модулей Docsvision, инструкцию по установке базовых модулей Docsvision и первоначальной настройке Системы.
В данный документ включены отдельные пункты из документации по администрированию базовых модулей Docsvision. За более подробной инструкцией следует обращаться к руководству администратора соответствующего модуля.
-
Руководство разработчика — содержит описание API, которое предоставляется базовыми модулями Docsvision, инструкции и примеры реализации различных компонентов системы Docsvision. В данном документе не рассматриваются аспекты разработки, связанные с Web-клиентом — обратитесь к документации модуля Web-клиент.
-
Руководство по настройке — содержит полное руководство по настройке поисковых запросов и представлений, информацию по настройке разметок, а также других не системных компонентов Docsvision. Отдельные разделы документа отсылают к другим руководствам Docsvision, в которых содержится описание требуемой настройки.
-
Описание полей стандартных карточек Docsvision — содержит описание карточек базовых модулей Docsvision. Описание включает перечень метаданных с типами и значениями.
-
Инструкция по обновлению Docsvision 5.5.X до 5.5.Y — содержит инструкцию по установке комплекта новых версий модулей Docsvision.
Документация модулей
Модуль Платформа
-
Общая документация — содержит программные, аппаратные и прочие требования модуля.
-
Администрирование модуля — содержит инструкцию по установке и настройке сервера Docsvision, инструкцию по обновлению модуля. Также в документе приведена инструкция по управлению базами данных Docsvision, настройке внешних файловых хранилищ, полнотекстового поиска и других параметров Системы, приведены рекомендации по обслуживанию.
-
Описание конструкторов и справочников — содержит описание пользовательского интерфейса и инструкцию по работе со справочниками модуля: Системные настройки, Справочник типов папок, Справочник компонентов.
-
Ограничения на модификацию стандартных настроек модуля — содержит перечень возможных и запрещённых изменений настроек и объектов модуля.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Модуль Служба фоновых операций
-
Общая документация — содержит требования к модулю.
-
Администрирование модуля — содержит инструкцию по установке и настройке Службы фоновых операций, инструкцию по обновлению модуля.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Модуль Базовые объекты
-
Общая документация — содержит программные и аппаратные требования модуля, описание функций.
-
Администрирование модуля — содержит инструкцию по установке модуля, инструкцию по обновлению модуля, настройке маршрутизации заданий в электронную почту. Также в разделе приведено описание настроек модуля в справочнике Системные настройки.
-
Руководство пользователя — содержит описание карточки Бизнес-календарь, инструкцию по выполнению заданий в почтовом клиенте.
-
Описание конструкторов и справочников — содержит описание пользовательского интерфейса и инструкцию по работе с конструкторами и справочниками модуля: Конструктор правил нумерации, Конструктор разметок, Конструктор ролей, Конструктор скриптов, Конструктор состояний, Конструктор справочников, Справочник видов карточек, Справочник категорий, Справочник контрагентов, Справочник меток подписей, Справочник серверов, Справочник сотрудников, Справочник ссылок.
-
Ограничения на модификацию стандартных настроек модуля — содержит перечень возможных и запрещённых изменений настроек и объектов модуля.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Модуль Управление процессами
-
Общая документация — содержит программные и аппаратные требования модуля, описание функций.
-
Администрирование модуля — содержит инструкцию по установке и настройке модуля, инструкцию по обновлению модуля. Также в документе содержится описание настроек модуля в Консоли настройки Docsvision и в справочнике Системные настройки, указаны особенности настройки кластера СУБП.
-
Руководство пользователя — содержит описание Конструктора бизнес-процессов (инструмента для разработки БП); инструкцию по разработке новых бизнес-процессов; описание элементов, используемых при конструировании БП.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Приложение Управление документами
-
Общая документация — содержит программные и аппаратные требования модуля, описание функций.
-
Администрирование модуля — содержит инструкцию по установке и настройке приложения, инструкцию по обновлению модуля, перечислены этапы подготовки приложения к работе с договорами.
-
Руководство пользователя — содержит описание карточек модуля (Документ УД, Задание УД и Группа заданий УД); рассмотренные основные примеры работы с документами, заданиями и договорами.
-
Ограничения на изменение стандартных настроек приложения — содержит перечень возможных и запрещённых изменений настроек и объектов приложения.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Модуль Конструктор согласований
-
Общая документация — содержит программные и аппаратные требования модуля, описание функций.
-
Администрирование модуля — содержит инструкцию по установке модуля, инструкцию по обновлению модуля. Также в документе приведена инструкция по разработке процессов согласования.
-
Руководство пользователя — содержит инструкцию по выполнению и контролю за выполнением задач согласования: согласование, консолидация и подписание.
-
Ограничения на модификацию стандартных настроек модуля — содержит перечень возможных и запрещённых изменений настроек и объектов модуля.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Модуль Windows-клиент
-
Общая документация — содержит программные и аппаратные требования модуля, описание функций.
-
Администрирование модуля — содержит инструкцию по установке модуля, инструкцию по обновлению модуля, описание административных настроек.
-
Руководство пользователя — содержит описание пользовательского интерфейса и инструкцию по работе с программами Windows-клиент и Рабочее место администратора.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.
Приложение Делопроизводство 4.5
-
Общая документация — содержит программные и аппаратные требования модуля, описание функций.
-
Администрирование модуля — содержит инструкцию по установке приложения Делопроизводство 4.5, инструкцию по обновлению, приведено описание настроек приложения в справочнике Системные настройки.
-
Руководство пользователя — содержит инструкцию по работе с программой Личный помощник. Описание карточек библиотеки карточек Делопроизводство 4.5 и инструкция по работе с карточками приведены в руководстве пользователя системы Docsvision 4.5.
-
Изменения в релизной версии — содержит список изменений, перечисление исправленных ошибок в текущей "релизной" версии, описание ошибок, исправленных в сборках технической поддержки после релиза.