Общие сведения¶

Состав документации Платформы, поставляемой партнерам/заказчикам, определяется релизной политикой Платформы.

В состав эксплуатационной документации Платформы и ее модулей входят следующие виды документов:

• Описание функциональных возможностей – содержит перечень и описание основных функциональных возможностей Платформы и ее модулей;
• Руководство администратора – определяет порядок работы администратора Платформы и ее модулей;
• Руководство пользователя – определяет порядок работы пользователя Платформы и ее модулей;
• Руководство по установке и конфигурированию – описывает процесс установки и конфигурирования (настройки) Платформы и ее модулей;
• Руководство разработчика и описание REST API – содержит информацию об используемых методах REST API в микросервисах Платформы и ее модулей и применяется для разработки, отладки и сопровождения программного кода в рамках Платформы;
• Состав микросервисов и их описание – содержит перечень и краткое описание микросервисов Платформы и ее модулей.

Также к каждому новому релизу (выпуску новой версии Платформы) разрабатывается документ Release Notes (Список изменений). Документ Release Notes описывает изменения в новой версии Платформы: новые функции, исправленные ошибки и другие улучшения, внесенные в Платформу и в ее модули.

Каждый эксплуатационный документ Платформы содержит раздел с терминами, их определениями и сокращениями, а также с соглашениями по оформлению.

Подробное описание содержания каждого эксплуатационного документа Платформы и ее модулей приведено в документе Быстрый старт. Эксплуатационная документация.