Документация

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

Возможности системы

Проекты

Проект объединяет задачи, участников и настройки. В Системе доступно создание проектов и общий список проектов.

Для проектов доступны следующие конфигурации:

Схема типов задач – набор типов задач, доступных в проекте (например, эпик, история, задача, ошибка, подзадача), с указанием типа по умолчанию и порядка их отображения при создании задачи. Одна схема может использоваться в нескольких проектах.
Схема бизнес-процессов (Workflow) – определяет, какой бизнес-процесс применяется к каждому типу задач проекта. Бизнес-процесс – это набор статусов и переходов, которые задача проходит в течение жизненного цикла.
Схема прав доступа – набор разрешений на действия в проекте (просмотр проекта, создание, редактирование, назначение и закрытие задач, комментирование, работа с вложениями и др.), назначаемых проектным ролям, группам и отдельным пользователям.
Проектные роли – способ объединения пользователей и групп в рамках проекта (например, администраторы, разработчики, пользователи). Состав каждой роли задаётся отдельно для каждого проекта; роли используются в схемах прав доступа, уведомлениях и бизнес-процессах.
Настройка учёта времени – общий учёт времени по задаче или учёт времени по ролям.

Поиск

В Системе доступны четыре типа поиска:

Поиск по ключу – при вводе ключа задачи сразу открывается её карточка.
Полнотекстовый поиск – поиск по тексту задач.
Поиск на языке запросов JQL с подстановкой (автодополнением) полей, операторов и значений. Язык разработан на базе JQL Atlassian Jira и поддерживает миграцию запросов и фильтров.
AI-поиск – текстовое описание того, что нужно найти, преобразуется Системой в запрос JQL.

Поиск выполняется по системным и пользовательским полям, вложениям, журналам работ, ролям, связям и комментариям.

Поиск построен на GIN-индексах СУБД PostgreSQL и не требует формирования файла поискового индекса на узле Системы.

Синтаксис запросов совместим с синтаксисом Jira, дополнительное обучение пользователей не требуется.

Предусмотрен механизм сохранения запросов в виде фильтров и предоставления доступа к ним другим пользователям: глобально либо для выбранных ролей или групп.

Задача

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

В задаче есть системные и пользовательские поля:

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

Для полей предусмотрены контексты. Для одного проекта можно настроить несколько контекстов одного поля – по количеству типов задач в проекте.

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

В задаче отображаются следующие блоки информации:

Связанные задачи.
Подзадачи.
Комментарии.
История изменений.
История списания времени.
Контекстное меню с дополнительными полями и оценками задачи (по ролям или единой оценкой).

Доступные действия с задачей: клонирование, перемещение, изменение типа.

Другие возможности карточки задачи:

Описание задачи и комментарии добавляются с использованием визуального редактора (WYSIWYG); поддерживаются упоминание пользователей и ограничение видимости комментария для роли или группы.
Наблюдатели задачи.
Редактирование полей непосредственно в карточке, отправка ссылки на задачу по электронной почте.

Вложения

Возможности работы с вложениями:

К задаче добавляются файлы любых форматов: их можно выбрать на компьютере, перенести мышью в окно задачи или вставить из буфера обмена.
За один раз можно загрузить сразу несколько файлов.
Изображения показываются в виде превью и открываются в режиме галереи; остальные вложения выводятся перечнем.
Все файлы задачи можно выгрузить единым архивом.
Администратор задаёт предельный размер файла и определяет, кому разрешено добавлять и удалять вложения.

Agile-инструменты и доски

Для команд, работающих по гибким методологиям, в Системе предусмотрено следующее:

Доски двух видов – Scrum и Kanban. Доска строится на основе фильтра и может охватывать задачи сразу нескольких проектов.
Бэклог, в котором порядок задач меняется простым перетаскиванием.
Работа со спринтами: их можно создавать, наполнять задачами, запускать и завершать, задавать цель спринта и вести несколько спринтов одновременно.
Оценка объёма работ: в баллах (story points), в часах либо по числу задач.
Отдельные панели эпиков и версий, помогающие планировать выпуск релизов.
Гибкая настройка колонок: привязка колонок к статусам и лимиты на количество задач в работе (WIP).
Группировка задач по дорожкам (swimlanes), быстрые фильтры, выбор цветов карточек и набора полей, которые на них показываются.
Редактирование задач прямо на доске (inline-редактирование), без перехода в карточку.
Добавление дополнительных колонок в отображение бэклога.
Отображение оценки настраивается, доступны две опции: суммарная оценка задачи (как в Jira) либо отдельные оценки по ролям – например, для разработчика, тестировщика и системного администратора.

Бизнес-процессы (Workflow)

Бизнес-процесс (Workflow) описывает путь задачи от создания до завершения. Бизнес-процессы объединяются в схемы; в рамках схемы один бизнес-процесс назначается на один тип задачи.

Возможности настройки бизнес-процессов:

Графический редактор, в котором на схеме задаются статусы и переходы между ними, включая переходы, доступные из любого статуса.
Ограничения на выполнение перехода: его можно разрешить только определённой роли или группе, при заданном значении поля, при закрытых подзадачах и т. п.
Контроль корректности данных, которые пользователь вводит во время перехода.
Автоматические действия после перехода: обновление значений полей, смена исполнителя, генерация события и другие.
Отдельные экраны для переходов, на которых пользователь заполняет нужные поля и указывает резолюцию.
Автоматическое выполнение перехода в ответ на события в инструментах разработки.
Работа с черновиком бизнес-процесса, создание копий, выгрузка и загрузка бизнес-процессов.

Фильтры и дашборды

Сохранённые фильтры служат источником данных для дашбордов. Возможности:

Каждый пользователь может собрать собственные дашборды, а также работать с дашбордами, которыми с ним поделились; размещение виджетов на дашборде настраивается.
Набор виджетов: список задач по фильтру, круговая диаграмма, соотношение созданных и решённых задач, статистика в разрезе двух полей, средний возраст задач, время решения, лента активности, задачи текущего пользователя, состояние спринта и другие.
Доступ к фильтрам и дашбордам открывается отдельным пользователям, группам и проектным ролям.

Связи между задачами

Задачи можно связывать друг с другом. Возможности работы со связями:

Набор типов связей настраивается администратором: «блокирует», «дублирует», «клонирует», «относится к» и другие.
Задачи выстраиваются в иерархию: эпик, входящие в него задачи и их подзадачи.
Связать можно задачи из разных проектов; кроме того, к задаче добавляются ссылки на внешние ресурсы.
В карточке задачи видны все связанные с ней задачи и их текущие статусы.
Поиск по связям выполняется с помощью JQL. В поиске предусмотрены отдельный тип связи для подзадач и отдельный тип связи для эпиков.

Аутентификация и авторизация

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

Учётные записи могут храниться в собственном каталоге Системы.
К Системе подключаются внешние каталоги – LDAP и Active Directory; сведения о пользователях и группах синхронизируются с ними.
Поддерживается единый вход (SSO) через SAML 2.0 и OpenID Connect. Можно настроить сразу несколько поставщиков идентификации, а учётная запись создаётся автоматически, когда пользователь входит в первый раз.
Задаются требования к паролям.
Внешние системы подключаются с помощью персональных токенов доступа и OAuth 2.0.
Перед выполнением административных действий Система повторно запрашивает пароль.
Права разграничиваются на нескольких уровнях: глобальные права, права в проекте и уровни безопасности отдельных задач.

Управление пользователями

Администратор ведёт учётные записи и определяет, кому что доступно. В его распоряжении:

Заведение новых учётных записей, их отключение и удаление.
Объединение пользователей в группы и распределение их по проектным ролям.
Определение того, какие пользователи и группы имеют доступ к приложениям Системы.
Схемы прав доступа в проектах: права выдаются ролям, группам, конкретным пользователям, а также автору задачи и её исполнителю.
Обезличивание персональных данных пользователя.
Личный профиль, где пользователь выбирает язык, аватар и параметры уведомлений.
Журнал аудита, в котором фиксируются действия пользователей и администраторов.

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

Кластерная конфигурация из нескольких активных узлов с балансировкой нагрузки.
Обновление кластера без остановки обслуживания пользователей.
Мониторинг узлов кластера, встроенные проверки состояния системы.
Ограничение частоты запросов к API.
Расширенный журнал аудита с выгрузкой в файл.
Резервное копирование и восстановление данных.
REST API и веб-хуки для интеграции с внешними системами.

Лицензирование

Программное обеспечение распространяется по подписке сроком на 1 или 2 года.
Стоимость подписки определяется уровнем лицензии по количеству пользователей: 250, 500, 1000 и далее с шагом 1000 пользователей.
Ввод и обновление лицензионного ключа в интерфейсе администратора.
Контроль количества занятых лицензий и срока действия.

Установка системы

Установка рабочего места

Дистрибутив Системы предоставляется по запросу на адрес info@karma-tech.ru. Приложения Системы разворачиваются на сервере в контейнерах с помощью Docker Engine и Docker Compose.

Работа пользователя с Системой осуществляется через браузер. Дополнительного программного обеспечения устанавливать не нужно.

Требования к оборудованию

Трекер (приложение karma)

Минимальные требования: 2 ядра CPU, 4 ГБ ОЗУ, 10 ГБ дискового пространства.

Рекомендуемые требования:

Программное обеспечение: Docker Engine и Docker Compose;
Процессор (CPU): 8 ядер;
ОЗУ (RAM): 16 ГБ;
Дисковая подсистема: от 10 ГБ;
СУБД: PostgreSQL 18.3.

Док (приложение karma-doc)