Описание функциональных и технических характеристик ПО TeamStorm

Назначение документа

Документ описывает функциональные характеристики системы управления проектами и совместной работой TeamStorm.

Описание системы

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

Структура TeamStorm состоит из следующих элементов:

пространства;
папки;
расширения;
задачи;
страницы.

TeamStorm обеспечивает выполнение следующих функций:

Организация рабочих пространств для управления проектами, задачами и страницами;
Настройка процессов рабочих пространств, управление ролями пользователей, типами задач, атрибутами и рабочими процессами пространств;
Управление задачами в рабочем пространстве в соответствии с конфигурацией, назначение исполнителей и отслеживание выполнения задач;
Ведение коммуникации по задачам и страницам;
Приоритезация бэклога задач, управление спринтами, емкостью спринта, формирование отчетов по спринтам;
Работа с задачами в представлениях таблиц, досок и диаграмм Ганта;
Группировка задачи в портфели проектов, отслеживание прогресса по проектам в портфелях;
Фиксирование трудозатрат по задачам и формирование отчетов по трудозатратам;
Заведение заявок на обслуживание, отслеживание статуса заявок;
Управление базой знаний в рабочих пространствах, создание страниц, отслеживание версий, рецензирование страниц;
Построение отчетов и рабочих столов по задачам с возможностью кастомизации;
Автоматизация действий с задачами;
Администрирование доступа пользователей к системе и рабочим пространствам;
Интеграция с внешними провайдерами аутентификации, почтовыми сервисами, системами хранения кода, системами тестирования;
Интеграций с внешними системами с использованием веб-хуков и программного интерфейса.

Функциональные характеристики

Панель навигации

С помощью функциональности панели навигации пользователь может:

Переключаться между разделами системы;
Производить поиск задач и страниц;
Просмотреть список уведомлений по задачам и страницам, перейти в карточку задачи или страницы по которой произошло событие;
Перейти на внешний ресурс для получения справки о системе;
Перейти по ссылке во внешнюю систему;
Изменить данные профиля пользователя;
Завершить сеанс работы с системой.

Главная страница

С помощью функциональности главной страницы пользователь может:

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

Раздел "Мои задачи"

С помощью функциональности раздела "Мои задачи" пользователь может:

Просмотреть список назначенных задач и просмотреть их содержимое;
Просмотреть список задач, к которым у пользователя есть доступ, и просмотреть их содержимое;
Просмотреть список страниц, к которым у пользователя есть доступ, и просмотреть их содержимое;
Просмотреть список заявок, созданных пользователем, и просмотреть их содержимое;
Просмотреть зафиксированное пользоватем затраченное на задачи время и зафиксировать время.

Дашборды

С помощью функциональности раздела "Дашборды" пользователь может:

Создавать дашборды и управлять доступом к ним, редактировать и удалять;
Добавлять на дашборд графики и отчеты, настраивать их и удалять.

Заявки

С помощью функциональности раздела "Заявки" пользователь может:

Просмотр списка доступных типов заявок;
Создание заявки с заполнением атрибутов заявки.

Настройки

С помощью функциональности раздела "Настройки" пользователь может:

Управлять скриптовой автоматизацией:
1. Создавать и редактировать автоматизации:
  1. Изменять пространства, для которых включена автоматизация;
  2. Изменять событие-триггер автоматизации;
  3. Изменять код автоматизации во встроенном редакторе разработки;
  4. Выполнять статическую проверку кода автоматизации.
2. Просматривать результаты выполнения автоматизации и детали запусков;
3. Включать и отключать автоматизации;
4. Удалять автоматизации;
5. Настраивать учетную запись для выполнения действий автоматизации.
Создавать, редактировать и удалять типы связей задач;
Создавать, редактировать и удалять шаблоны страниц.

Администрирование

С помощью функциональности раздела "Администрирование" пользователь может:

Управлять пользователями:
1. Просматривать список учетных записей системы и производить поиск;
2. Создавать, редактировать и удалять локальные учетные записи пользователей;
3. Просматривать информацию об учетных записях;
4. Изменять системные роли пользователям;
5. Добавлять и удалять пользователя в группы пользователей.
Управлять группами пользователей:
1. Просматривать список групп пользователей и производить поиск;
2. Создавать, редактировать и удалять локальные группы пользователей;
3. Просматривать информацию о группах пользователей;
4. Изменять системные роли группам пользователей;
5. Добавлять и удалять пользователей в группы пользователей.
Управлять интеграциями с внешними провайдерами аутентификации LDAP, Kerberos, OIDC;
Управлять лицензиями:
1. Просматривать информацию о добавленных ключах лицензий;
2. Просматривать информацию об использовании лицензий;
3. Добавлять ключи лицензии.
Управлять параметрами безопасности:
1. Изменять парольные политики;
2. Включать/отключать второй фактор аутентификации;
3. Изменять политики ограничения загрузки вложений;
4. Управлять интеграцией с антивирусным ПО.
Импортировать задачи из внешних систем;
Управлять ссылками на внешние системы.

Пространства

В системе доступно создание/удаление пространств и просмотра их структуры. Пространство объединяет проекты и работы, которые влияют на общие целевые показатели организации. Пространство на системном уровне определяет модель доступа и базовые конфигурации содержимого. Принципы выделения пространства принимаются на уровне организации.

С помощью функциональности пространств пользователь может:

Выполнять настройки пространства:
1. Изменять название и описание пространства;
2. Управлять ролями пространства:
  1. Создавать и удалять роли;
  2. Изменять разрешения ролей.
3. Управлять доступом к пространству:
  1. Добавлять пользователей и группы в пространство;
  2. Изменять роли пользователей и групп в пространстве.
4. Создавать, редактировать и удалять типы задач;
5. Создавать, редактировать и удалять атрибуты задач;
6. Управлять рабочими процессами:
  1. Создавать и удалять рабочие процессы;
  2. Редактировать рабочие процессы:
    1. Изменять название и описание процесса;
    2. Добавлять и удалять статусы процесса;
    3. Управлять ограничениями переходов между статусами процесса;
    4. Управлять правилами переходов между статусами процесса;
    5. Управлять автоматическими действиями при переходе между статусами процесса;
    6. Управлять отображением атрибутов на форме создания задачи.
7. Управлять заявками:
  1. Создавать, редактировать параметры создания заявок;
  2. Включать/отключать и удалять типы заявок;
8. Добавлять, настраивать и отключать интеграцию пространства с системами на основе Git;
9. Добавлять, настраивать и отключать веб-хуки;
10. Включать/отключать статусы страниц в пространстве;
11. Удалять пространство.
Управлять задачами пространства:
1. Создавать, редактировать и удалять папки задач;
2. Создавать, редактировать и удалять задачи в папке;
3. Управлять вложенностью папок и задач;
4. Создавать, редактировать и удалять представления задач;
5. Выгружать задачи в табличном формате;
6. Управлять расширениями для управления беклогом и спринтами:
  1. Добавлять и удалять расширение для управления беклогом и спринтами;
  2. Создавать, редактировать и удалять спринты;
  3. Просматривать список и статистику спринтов;
  4. Добавлять и исключать задачи в спринте и беклоге;
  5. Управлять командой спринта и их загрузкой;
  6. Запускать и завершать спринты;
  7. Просматривать отчет по спринту;
  8. Просматривать информацию о завершенных спринтах.
7. Управлять расширениями для управления портфелями:
  1. Добавлять и удалять расширение для управления портфелем;
  2. Создавать, редактировать и удалять элементы портфеля;
  3. Просматривать список и статистику элементов портфелей;
  4. Добавлять и исключать задачи в элементы портфеля;
  5. Изменять статусы элементов портфеля;
  6. Просматривать отчет по элементу портфеля.
8. Управлять запросами:
  1. Создавать, редактировать и удалять запросы;
  2. Управлять доступом к запросу;
  3. Изменять условие запроса;
  4. Выполнять запрос с получением выборки по задачам пространства.
9. Выполнять пакетное изменение задач.
Управлять страницами пространства:
1. Создавать, редактировать и удалять страницы;
2. Управлять вложенностью и порядком страниц;
3. Выгружать страницы.

Задачи

В системе доступно создание задач разных типов — структурированных элементов для управления проектом.

С помощью функциональности задач пользователь может:

Просматривать информацию о задаче;
Изменять параметры задачи: название, описание, даты начала и выполнения, статус, отвественного, оценку, тип, процесс, прогресс, значения атрибутов.
Редактировать содержимое задач:
1. Изменять форматирование и стили текста;
2. Добавлять гиперссылки;
3. Добавлять изображения и файлы;
4. Добавлять и редактировать таблицы;
5. Добавлять чек-листы;
6. Добавлять оглавление страницы;
7. Добавлять блоки кода;
8. Добавлять и редактировать диаграммы;
9. Изменять отображаемый размер изображений и диаграмм;
10. Добавлять сворачивающиеся блоки;
11. Добавлять ссылки на задачи и страницы;
12. Добавлять разделитель;
13. Добавлять информационные панели.
Фиксировать, редактировать и удалять затраченное время;
Добавлять и удалять подзадачи;
Добавлять и удалять вложения и обновлять их версии;
Добавлять и удалять связи с другими задачами;
Добавлять и удалять связи со страницами;
Добавлять, редактировать, удалять комментарии к задаче, управлять видимостью комментариев;
Просматривать историю изменения задачи;
Включать/выключать уведомления по изменениям задач;
Предоставлять доступ к задаче внешним пользователям;
Добавлять в беклог, спринты и элементы потфелей, а также исклюать их;
Перемещать задачу в другую задачу;
Дублировать задачи.

Представления

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

С помощью функциональности представления "Таблица" пользователь может:

Просматривать иерархический список задач;
Просматривать информацию о задаче в режиме предварительного просмотра;
Выполнять поиск и фильтрацию задач по атрибутам;
Сортировать спискок задач по атрибуту;
Управлять отображением атрибутов и их порядком;
Копировать представление;
Изменять значения атрибутов;
Изменять порядок задач в списке;
Сохранять и сбрасывать настройки представления;
Удалять представление.

С помощью функциональности представления "Доска" пользователь может:

Просматривать процесс выполнения задач;
Просматривать информацию о задаче в режиме предварительного просмотра;
Выполнять поиск и фильтрацию задач по атрибутам;
Управлять отображением статусов на доске и их порядком;
Управлять отображением атрибутов на карточках доски;
Управлять группировкой задач на доске по атрибутам;
Изменять значения атрибутов;
Изменять порядок задач в колонках;
Переносить задачи межжу статусами на доске;
Копировать представление;
Сохранять и сбрасывать настройки представления;
Удалять представление.

С помощью функциональности представления "Диаграмма Ганта" пользователь может:

Просматривать план выполнения списка задач на временной шкале и связи задач;
Добавлять и изменять сроки выполнения задач;
Устанавливать связи между задачами на диаграмме;
Изменять масшаб временной шкалы;
Просматривать информацию о задаче в режиме предварительного просмотра;
Выполнять поиск и фильтрацию задач по атрибутам;
Включать/отключать синхронизацию сроков связанных задач;
Копировать представление;
Сохранять и сбрасывать настройки представления;
Удалять представление.

Страницы

С помощью функциональности страниц пользователь может:

Просматривать и редактировать содержимое и информацию страниц;
Создавать страницы на основе шаблонов;
Редактировать содержимое страниц:
1. Изменять форматирование и стили текста;
2. Добавлять гиперссылки;
3. Добавлять изображения и файлы;
4. Добавлять и редактировать таблицы;
5. Добавлять чек-листы;
6. Добавлять оглавление страницы;
7. Добавлять блоки кода;
8. Добавлять и редактировать диаграммы;
9. Изменять отображаемый размер изображений и диаграмм;
10. Добавлять списки задач по условию;
11. Добавлять списки страниц по условию;
12. Добавлять сворачивающиеся блоки;
13. Добавлять ссылки на задачи и страницы;
14. Вставлять содержимое других страниц и их фрагментов;
15. Добавлять разделитель;
16. Добавлять информационные панели.
Изменять статус страницы;
Добавлять и удалять метки страницы;
Добавлять страницу в избранное;
Включать/выключать уведомления по изменениям страницы;
Связывать страницу с задачами;
Добавлять и удалять вложения и обновлять их версии;
Добавлять комментарии к странице или её фрагменту, отвечать на комментарии и помечать решение комментариев;
Предоставлять доступ к странице внешним пользователям;
Просматривать и сравнивать версии страницы;
Дублировать страницу;
Создавать шаблон из страницы;
Выгружать страницы;
Блокировать изменения страницы и снимать блокировку;
Удалять страницу.

Технические характеристики

Решения по комплексу технических средств, его размещению на объекте

Техническое обеспечение системы TeamStorm включает следующие технические средства:

серверы;
рабочие станции (для пользователей).

Требования к серверному оборудованию системы представлены в Таблице 1.

Допускается установка на программную и/или аппаратную систему, эмулирующую аппаратное обеспечение некоторой платформы (виртуальная машина).

Таблица 1 - Требования к серверным ресурсам

Ресурс	Рекомендации
Операционная система	CentOS или любая другая с возможностью установки Docker, Docker compose
Процессор	x86-64 / 8 ядер серверного класса с поддержкой виртуализации и тактовой частотой 2.2 ГГц и выше
Оперативная память	12 Гб
Объем жесткого диска	100 Гб
Сетевой интерфейс	TCP/IP

Требования к оборудованию рабочих станций пользователей приведены в Таблице 2

Таблица 2 - Требования к оборудованию рабочих станций пользователей

Компонент	Рекомендуемая конфигурация
Процессор	Intel Core 2 Duo 2.3 Ггц или аналог
Оперативная память	2 Гб SDRAM
Жесткий диск	50 Гб
Сетевая плата	Ethernet 10 Мбит
Дополнительное оборудование	Монитор, клавиатура, мышь
Операционная система	Windows, MacOS или
Общесистемное ПО	Веб-браузер Google Chrome, Яндекс.Браузер, Opera, Mozilla Firefox, Microsoft Edge или Safari

Cостав программных средств

Система TeamStorm представляет собой клиент-серверное приложение. Для развертывания и запуска системы используются средства docker-контейнеризации.

Система TeamStorm разработана с помощью следующих программных средств и языков программирования:

C# – для реализации серверной части;
TypeScript – для реализации клиентской части и пользовательского интерфейса;
PostgreSQL – в качестве базы данных;
Minio – в качестве файлового хранилища;
RabbitMQ – для организации обмена данными между сервисами системы;
Elasticsearch – в качестве подсистемы логирования;
Nginx – для маршрутизации запросов.

Перечень программного обеспечения

ОС Linux Рекомендуемая ОС Linux, или любая c возможностью установки Docker, Docker compose
Docker Engine 17.09.0 и выше;
Docker Compose 1.29.2 и выше.

Перечень необходимых лицензий представлен в Таблице 3.

Таблица 3 - Перечень необходимых лицензий

Тип лицензии TeamStorm	Описание
Временная	Лицензия по количеству пользователей системы на время пилотирования
Коммерческая	Лицензия по количеству пользователей на время использования

Термины и определения

Agile-расширение

Расширение с настройками списков задач типа "бэклог" и "спринт"

Бэклог

Очередь, которая содержит нерешенные задачи, над которыми работает команда

Спринт

Отрезок времени, в течение которого команда решает определенную задачу или группу задач

Расширение

Модуль, расширяющий функциональность пространства

Пространство

Пространство, которое объединяет типы работ по схожим критериям. Определяет модель доступа и базовые конфигурации содержимого. Принципы выделения пространств принимаются на уровне организации

Задача

Объект, который можно отслеживать, планировать, описывать, обсуждать или согласовывать

Папка

Раздел в пространстве, который объединяет задачи

Атрибут задачи

Атрибут определенного типа, значение которого может хранить задача. Описывает или категорирует задачу.

Пользовательский атрибут

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

Категория статуса

Определяет возможные категории статусов для группировки статусов. На уровне системы определены категории К вполнению, В работе, Завершено, Отменено

Рабочий процесс, процесс

Определяет набор статусов для задачи и правила перехода между ними

Тип задачи

Определяет шаблон создания задачи, с каким процессом или атрибутом она создается

Комментарий

Комментарий к задаче

Вложение

Вложение в виде файла, добавляемое к задаче или комментарию

Портфель

Расширение для управления группами задач

Элемент портфеля

Группа задач, объединенных общими целями и сроками выполнения

Страница

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