Порядок эксплуатации программного обеспечения для ЭВМ “Программа для тестирования продуктовых гипотез EXPF sigma” (далее - ПО)
0. Термины и определения
Токен проекта
Уникальный идентификатор проекта, используемый для аутентификации запросов SDK или API и связывания пользовательского приложения с конфигурациями в ПО.
Эксперимент
Настроенный в ПО механизм распределения пользователей по группам (вариантам) с целью тестирования продуктовых гипотез.
Фича-флаг (Feature Flag)
Конфигурационный параметр, позволяющий включать или отключать функциональность приложения без его обновления или повторного развёртывания.
Экспериментальная группа (вариант)
Подмножество пользователей, которым назначается определённая версия функциональности или параметров в рамках эксперимента.
Контрольная группа
Экспериментальная группа, получающая базовую (исходную) конфигурацию функциональности для сравнения с другими вариантами.
Сегментация
Механизм отбора пользователей на основе передаваемых параметров (атрибутов), таких как платформа, регион, версия приложения или пользовательские свойства.
Пользовательские параметры
Набор атрибутов, передаваемых из пользовательского приложения в ПО через SDK или API и используемых для сегментации и правил распределения.
Правило
Логическое условие, определяющее применение эксперимента или фича-флага к определённым пользователям или сегментам.
Приоритет правил
Порядок применения правил и конфигураций при одновременном совпадении нескольких условий.
SDK (Software Development Kit)
Набор библиотек и инструментов для интеграции пользовательского приложения с ПО, обеспечивающий получение конфигураций и значений экспериментов.
HTTP API
Программный интерфейс взаимодействия с ПО по протоколу HTTP, используемый для получения конфигураций и результатов вычислений без применения SDK.
Конфигурация
Совокупность настроек экспериментов, фича-флагов, правил и сегментов, действующих в рамках проекта.
Кэширование
Механизм временного хранения последней актуальной конфигурации на стороне SDK для повышения устойчивости и снижения зависимости от сетевых запросов.
Режим постоянной доступности
Режим эксплуатации ПО, при котором сервис функционирует непрерывно и обеспечивает обработку запросов в автоматическом режиме.
Инцидент
Событие, приводящее к частичной или полной недоступности функций ПО или нарушению корректности обработки запросов.
Правообладатель
Организация, осуществляющая сопровождение, обновление и поддержку ПО.
1. Общие положения
Настоящий документ описывает порядок эксплуатации программного обеспечения для ЭВМ “Программа для тестирования продуктовых гипотез EXPF sigma” (далее - ПО). ПО используется для управления экспериментами и фича-флагами в веб- и мобильных приложениях и эксплуатируется в режиме постоянной доступности. Эксплуатация осуществляется без установки серверной части на стороне пользователя и не требует специализированного аппаратного обеспечения.
2. Условия эксплуатации
Для эксплуатации ПО требуется:
• доступ к сети Интернет;
• корректно настроенное клиентское или серверное приложение пользователя;
• действующий токен проекта Sigma;
• подключение SDK или использование HTTP API. ПО эксплуатируется в среде веб-браузеров, мобильных операционных систем и серверных платформ в зависимости от выбранного способа интеграции.
3. Подготовка к эксплуатации
Перед началом эксплуатации пользователь выполняет:
• создание проекта в интерфейсе ПО;
• получение токена проекта;
• настройку экспериментов и фича-флагов;
• интеграцию SDK или API в собственное приложение;
• передачу пользовательских параметров для сегментации.
После выполнения указанных действий ПО готово к использованию.
4. Эксплуатация программного обеспечения
4.1 Основной режим работы
В процессе эксплуатации ПО обеспечивает:
• вычисление значений фича-флагов и параметров экспериментов;
• распределение пользователей по экспериментальным группам;
• применение сегментации и правил;
• возврат результатов через SDK или API;
• стабильную работу при высоком количестве запросов.
Эксплуатация осуществляется в автоматическом режиме без участия пользователя.
4.2 Управление конфигурациями
В ходе эксплуатации пользователь может:
• изменять параметры экспериментов и фича-флагов (иллюстрация 1);
• включать и отключать функциональность для отдельных сегментов (иллюстрация 2);
0. Термины и определения
Токен проекта
Уникальный идентификатор проекта, используемый для аутентификации запросов SDK или API и связывания пользовательского приложения с конфигурациями в ПО.
Эксперимент
Настроенный в ПО механизм распределения пользователей по группам (вариантам) с целью тестирования продуктовых гипотез.
Фича-флаг (Feature Flag)
Конфигурационный параметр, позволяющий включать или отключать функциональность приложения без его обновления или повторного развёртывания.
Экспериментальная группа (вариант)
Подмножество пользователей, которым назначается определённая версия функциональности или параметров в рамках эксперимента.
Контрольная группа
Экспериментальная группа, получающая базовую (исходную) конфигурацию функциональности для сравнения с другими вариантами.
Сегментация
Механизм отбора пользователей на основе передаваемых параметров (атрибутов), таких как платформа, регион, версия приложения или пользовательские свойства.
Пользовательские параметры
Набор атрибутов, передаваемых из пользовательского приложения в ПО через SDK или API и используемых для сегментации и правил распределения.
Правило
Логическое условие, определяющее применение эксперимента или фича-флага к определённым пользователям или сегментам.
Приоритет правил
Порядок применения правил и конфигураций при одновременном совпадении нескольких условий.
SDK (Software Development Kit)
Набор библиотек и инструментов для интеграции пользовательского приложения с ПО, обеспечивающий получение конфигураций и значений экспериментов.
HTTP API
Программный интерфейс взаимодействия с ПО по протоколу HTTP, используемый для получения конфигураций и результатов вычислений без применения SDK.
Конфигурация
Совокупность настроек экспериментов, фича-флагов, правил и сегментов, действующих в рамках проекта.
Кэширование
Механизм временного хранения последней актуальной конфигурации на стороне SDK для повышения устойчивости и снижения зависимости от сетевых запросов.
Режим постоянной доступности
Режим эксплуатации ПО, при котором сервис функционирует непрерывно и обеспечивает обработку запросов в автоматическом режиме.
Инцидент
Событие, приводящее к частичной или полной недоступности функций ПО или нарушению корректности обработки запросов.
Правообладатель
Организация, осуществляющая сопровождение, обновление и поддержку ПО.
1. Общие положения
Настоящий документ описывает порядок эксплуатации программного обеспечения для ЭВМ “Программа для тестирования продуктовых гипотез EXPF sigma” (далее - ПО). ПО используется для управления экспериментами и фича-флагами в веб- и мобильных приложениях и эксплуатируется в режиме постоянной доступности. Эксплуатация осуществляется без установки серверной части на стороне пользователя и не требует специализированного аппаратного обеспечения.
2. Условия эксплуатации
Для эксплуатации ПО требуется:
• доступ к сети Интернет;
• корректно настроенное клиентское или серверное приложение пользователя;
• действующий токен проекта Sigma;
• подключение SDK или использование HTTP API. ПО эксплуатируется в среде веб-браузеров, мобильных операционных систем и серверных платформ в зависимости от выбранного способа интеграции.
3. Подготовка к эксплуатации
Перед началом эксплуатации пользователь выполняет:
• создание проекта в интерфейсе ПО;
• получение токена проекта;
• настройку экспериментов и фича-флагов;
• интеграцию SDK или API в собственное приложение;
• передачу пользовательских параметров для сегментации.
После выполнения указанных действий ПО готово к использованию.
4. Эксплуатация программного обеспечения
4.1 Основной режим работы
В процессе эксплуатации ПО обеспечивает:
• вычисление значений фича-флагов и параметров экспериментов;
• распределение пользователей по экспериментальным группам;
• применение сегментации и правил;
• возврат результатов через SDK или API;
• стабильную работу при высоком количестве запросов.
Эксплуатация осуществляется в автоматическом режиме без участия пользователя.
4.2 Управление конфигурациями
В ходе эксплуатации пользователь может:
• изменять параметры экспериментов и фича-флагов (иллюстрация 1);
• включать и отключать функциональность для отдельных сегментов (иллюстрация 2);
Иллюстрация 1
Иллюстрация 2
В данном примере для сегментации эксперимента по авторизованным пользователям необходимо передать параметры sessions и isBannerClicked в объект userData. Сбор и подсчет этих параметров полностью в зоне ответственности разработчика, так как EXPF sigma не собирает пользовательские данные.
5. Мониторинг и контроль
В процессе эксплуатации обеспечивается:
• контроль корректности работы SDK и API;
• использование встроенных механизмов кэширования;• устойчивость к временной недоступности сети;
• сохранение последней актуальной конфигурации.
Ошибки при обращении к сервису не приводят к остановке работы пользовательского приложения.
6. Обслуживание и сопровождение
Сопровождение ПО осуществляется правообладателем и включает:
• мониторинг работоспособности сервисов;
• устранение выявленных ошибок;
• обновление функциональности и SDK;
• поддержку совместимости с актуальными версиями платформ;
• актуализацию технической документации.
Обслуживание выполняется без прерывания эксплуатации для пользователя.
7. Обновление программного обеспечения
Обновление ПО выполняется централизованно.
В рамках обновлений:
• улучшается производительность и надёжность;
• добавляются новые функциональные возможности;
• расширяется поддержка платформ; • оптимизируются алгоритмы расчёта.
Обновления не требуют переустановки SDK и не влияют на работоспособность интеграций.
8. Требования к персоналу
Для эксплуатации ПО требуется:
• разработчик или технический специалист, владеющий навыками интеграции SDK или API;
• знания базовых принципов веб- или мобильной разработки.
Специальная подготовка или сертификация не требуется.
9. Обработка инцидентов
При возникновении сбоев пользователь может:
• проверить корректность передачи токена и пользовательских параметров;
• использовать кэшированные данные SDK;
• обратиться к технической документации или службе поддержки.
Система спроектирована с учётом минимизации влияния инцидентов на работу приложений пользователя.
10. Завершение эксплуатации
Завершение эксплуатации осуществляется путём:
• отключения SDK или API в пользовательском приложении;
• прекращения использования токена проекта;
• удаления или деактивации проекта в интерфейсе ПО.
В процессе эксплуатации обеспечивается:
• контроль корректности работы SDK и API;
• использование встроенных механизмов кэширования;• устойчивость к временной недоступности сети;
• сохранение последней актуальной конфигурации.
Ошибки при обращении к сервису не приводят к остановке работы пользовательского приложения.
6. Обслуживание и сопровождение
Сопровождение ПО осуществляется правообладателем и включает:
• мониторинг работоспособности сервисов;
• устранение выявленных ошибок;
• обновление функциональности и SDK;
• поддержку совместимости с актуальными версиями платформ;
• актуализацию технической документации.
Обслуживание выполняется без прерывания эксплуатации для пользователя.
7. Обновление программного обеспечения
Обновление ПО выполняется централизованно.
В рамках обновлений:
• улучшается производительность и надёжность;
• добавляются новые функциональные возможности;
• расширяется поддержка платформ; • оптимизируются алгоритмы расчёта.
Обновления не требуют переустановки SDK и не влияют на работоспособность интеграций.
8. Требования к персоналу
Для эксплуатации ПО требуется:
• разработчик или технический специалист, владеющий навыками интеграции SDK или API;
• знания базовых принципов веб- или мобильной разработки.
Специальная подготовка или сертификация не требуется.
9. Обработка инцидентов
При возникновении сбоев пользователь может:
• проверить корректность передачи токена и пользовательских параметров;
• использовать кэшированные данные SDK;
• обратиться к технической документации или службе поддержки.
Система спроектирована с учётом минимизации влияния инцидентов на работу приложений пользователя.
10. Завершение эксплуатации
Завершение эксплуатации осуществляется путём:
• отключения SDK или API в пользовательском приложении;
• прекращения использования токена проекта;
• удаления или деактивации проекта в интерфейсе ПО.