Документация продуктов

Материал из Info

Перейти к: навигация, поиск

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

Содержание

Виды документации

Документация, исходя их своего предназначения, разделена на следующие виды:

В зависимости от носителя и формата, документация разделяется на:

  • Документация в бумажном виде – книжки;
  • Электронная документация.

Документация для пользователей

Документация для пользователей существует в бумажном и электронном виде. Бумажный вид документации представлен полно и подробно в «Руководстве пользователя», которое описывает в деталях работу программных продуктов, дает примеры практического использования функций и их взаимосвязи. «Руководство пользователя» продается отдельно от программного продукта и может быть заказано клиентами.
Существует и электронная документация. Она встроена в сам программный продукт, открывается при нажатии на F1 в любом окне и описывает его функции. Это самый прогрессивный метод для описания функций ПО, который позволяет клиентам моментально получать всю необходимую информацию о работе программного продукта.

Сервисная документация

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

Презентации и руководства

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

Некоторые полезные ресурсы


Рассмотрите другие статьи в категории Продукты Microinvest