OMMAT-HSE / algoscalc-docs

Документация проекта по разработке Онлайн-калькулятора
MIT License
0 stars 0 forks source link

Сформулировать требования с точки зрения использования онлайн калькулятора #5

Closed MikhailovAlexander closed 1 year ago

MikhailovAlexander commented 1 year ago

Функциональные требования:

  1. Онлайн-калькулятор позволяет пользователям возможность просматривать список алгоритмов.
  2. Онлайн-калькулятор позволяет пользователям просматривать описание алгоритма, которое может содержать теоретические или исторические сведения об алгоритме.
  3. Онлайн-калькулятор позволяет пользователям вводить данные параметров для выполния алгоритма.
  4. Для каждого параметра выбранного алгоритма пользователь может ознакомится с информацией о типе данных и ограничениях для вводимых значений.
  5. Онлайн-калькулятор позволяет пользователям запускать выполнение алгоритма с заданными параметрами.
  6. Онлайн-калькулятор позволяет пользователям просматривать результаты выполнения алгортма с заданными параметрами.

Требования к программной документации. Программная документация должна включать в себя:

  1. Техническое задание.
  2. Исходный код.
  3. Руководство пользователя.
  4. Руководство администратора.

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

Требования к хостингу Хостинг для размещения онлайн-калькулятора должен иметь следующее программное обеспечение: — операционная система Ubuntu 20.04 LTS, — docker v20.

Требования к информационной и программной совместимости Исходный код разрабатывается, руководствуясь стандартами W3C. Для реализации статических страниц должны использоваться языки HTML 5 и CSS 3. Для реализации интерактивных элементов клиентской части должны использоваться языки HTML и JavaScript, с использованием одного из актуальных Фреймворков, таких как React, Angular, Vue. Для реализации серверной части должен использоваться язык один из web фреймворков для языка программирования Python (FastApi, Flask, Django).

Требования к клиентскому программному обеспечению Онлайн-калькулятор должен быть доступен для полнофункционального просмотра с помощью следующих браузеров:

  1. Mozilla Firefox, начиная с версии 78,
  2. Google Chrome, начиная с версии 98,
  3. Apple Safari, начиная с версии 15,
  4. Yandex Browser, начиная с версии 21.11.

Требования к маркировке и упаковке Разработанная система передается заказчику в виде ссылок на публичный репозиторий GitHub на сайте https://github.com с исходными кодами всех программных модулей. Учитывая изложенное, требования по маркировке и упаковке не предъявляются.

Прочие требования Система должна быть развернута в двух контурах Продуктовом и Тестовом. В репозиториях с исходным кодом должна быть настроена система автоматического тестирования, сборки и развертывания продукта на протуктовый итестовый контуры.