Руководство оператора#
Доступ к приложению#
Для получения учетных данных и адреса для входа необходимо обратиться к куратору вашей организации или администратору. При переходе по полученной ссылке измените свой пароль, после чего отобразится страница авторизации:
Возможны два варианта входа в приложение:
С помощью логина и пароля в TaskTracker. Для этого введите свои данные в соответствующие поля в основной форме входа.
С помощью логина и пароля Openid Connect (Keyсloak). Для этого нажмите на кнопку Openid Connect под формой ввода УЗ и в открывшемся окне введите данные из Keycloak.
Для работы с сервисом можно использовать следующие браузеры:
Яндекс (19.10+) – рекомендовано
Google Chrome (79.0+) – опционально
Safari (10.12+) – опционально
Рекомендации для пользователей по выбору паролей:
Не используйте такие же пароли, как на других сайтах, или аналогичные им.
Не используйте в качестве пароля одно слово, например, password, или частые фразы, например, qwerty.
Используйте пароли, которые будет сложно угадать даже тем, кто хорошо вас знает. Не включайте в них имена и дни рождения своих родных и друзей, названия любимых групп или фразы, которые вы часто произносите.
Рекомендуется выполнять процедуру периодической смены своего пароля.
Приведенные рекомендации не должны противоречить требованиям внутренних документов Заказчика, отраслевых и национальных стандартов, требований уполномоченных регуляторов и законодательства РФ.
Использование приложения оператором#
Все сценарии ниже доступны пользователям с ролями Reporter, Developer, Maintainer, Owner, если не указано иное.
Подробная ролевая модель описана в разделе Авторизация Руководства по безопасности.
Инструмент управления планированием TaskTracker#
На этапе формирования идеи вы можете создавать и описывать её с помощью эпика. Вы также можете привязывать к эпикам задачи и назначать даты начала и окончания работ. Используйте эпики в следующих случаях:
Когда ваша команда работает над большой функцией, которая включает в себя несколько задач.
Чтобы отслеживать, когда намечено начало и конец работы.
Создание эпика#
Создавать эпики могут только пользователи с ролями Developer, Maintainer и Owner. Эпики можно создавать на уровнях группы и проекта.
Авторизуйтесь под своей учетной записью и зайдите в нужную рабочую область.
Перейдите на страницу Epics > List.
В правом верхнем углу нажмите кнопку New epic.
Открывается форма создания эпика, в которой доступны для заполнения следующие поля:
Поле
Описание
Обязательность
Title
Название эпика
Обязательное
Description
Описание эпика
Необязательное
Start date
Дата начала работ по эпику
Обязательно
Due date
Дата окончания работ по эпику
Обязательно
Нажмите на кнопку Create epic. Эпик сохранится и отобразится в списке эпиков на странице List:
После того как вы создали эпик, можно отредактировать следующие атрибуты:
Название эпика (title).
Описание эпика (Description).
Дату начала работ (Start date).
Дату завершения работ (Due date).
Редактирование эпика#
На странице списка эпиков List выберите и нажмите на нужный эпик.
На странице просмотра эпика нажмите кнопку с иконкой "Карандаш" в правом верхнем углу.
Открывается страница редактирования, на которой можно внести изменения.
Сохраните изменения, нажав кнопку Save changes.
Когда эпик создан, можно определить фронт работ и поделить эпик на отдельные задачи. Вы можете включать созданные задачи в состав вашего эпика.
Включение задач в состав эпика#
В разделе Issues > List выберите нужную задачу.
На странице просмотра задачи в правой панели управления в блоке Epics нажмите кнопку Edit.
В выпадающем списке отображаются созданные эпики:
Выберите нужный эпик.
Сортировка и фильтрация эпиков на странице Roadmap#
На странице просмотра Roadmap можно настроить отображение, сортировку и фильтрацию эпиков.
Откройте страницу Roadmap в левом меню, нажав на Epics > Roadmap.
Для изменения масштаба отображения шкалы на открывшемся экране просмотра нажмите кнопку Settings и откройте панель настройки Roadmap:
В настройках можно указать следующие параметры:
Поле
Описание
Filter from
Начало периода
Filter to
Конец периода
By week
Задать недельный масштаб сетки
By month
Задать месячный масштаб сетки
By quarter
Задать квартальный масштаб сетки
Для сортировки эпиков на диаграмме, нажмите на Start date и выберите необходимый параметр для сортировки.
Для фильтрации эпиков на диаграмме воспользуйтесь элементом создания фильтра в верхней части экрана, где доступны следующие параметры:
Автор
Ответственный
Метка
Статус (State)
Пользовательские поля (Custom field)
Моя реакция
При просмотре диаграммы эпики, имеющие связь типа Зависит от, визуально соединены синей пунктирной линией:
Эпики, имеющие связи типа Блокирует/Заблокирован, визуально соединены красной линией. Стрелка указывает направление связи: от блокирующего к заблокированному:
Навигация#
По нажатию на привязанный эпик в правой боковой панели можно перейти на страницу просмотра этого эпика. На странице просмотра эпика в блоке Issues отображаются включенные в него задачи. По нажатию на любую задачу осуществляется переход на страницу просмотра.
Комментарии и реакции на странице просмотра эпика#
Для обсуждения и оценки эпика реализован функционал комментариев и реакций на странице просмотра эпиков. Он позволяет:
Оставлять реакции.
Писать комментарии с поддержкой формата markdown.
Создавать обсуждения.
Просматривать историю изменений названия и описания эпика.
Создание задачи с типом История (Story)#
Авторизуйтесь под своей учетной записью и зайдите в нужную рабочую область.
Перейдите на страницу Issues > List.
В правом верхнем углу нажмите кнопку New issue:.
Откроется форма создания задачи, в которой доступны для заполнения следующие поля:
Название задачи (обязательное поле).
Тип задачи - story (обязательное поле).
Описание задачи.
Исполнитель.
Срок исполнения.
Milestone, к которому относится история.
Метки.
Нажмите кнопку Create issue, откроется окно с созданной историей.
Если вернуться на страницу Issues > List, то созданная история отобразится в списке:
После создания истории можно внести в нее изменения, как в любую другую задачу:
Название задачи
Тип задачи
Описание
Связь с эпиком
Метки
Ответственного
Связанные задачи
Редактирование истории#
На странице списка задач выберите и нажмите на нужную историю.
На странице просмотра внесите изменения в правом меню:
Правое боковое меню позволяет изменить:
ответственного
связь с эпиком
связь с milestone
срок исполнения
метки
Изменения дополнительно подтверждать не нужно, они применяются после выбора.
Если нужно изменить название, тип или описание истории, выполните следующее:
На странице просмотра истории нажмите кнопку с иконкой "Карандаш" в правом верхнем углу.
В открывшемся окне редактирования внесите необходимые правки.
Подтвердите изменения, нажав кнопку Save changes.
После сохранения изменений экран вернется в состояние просмотра истории.
Linked Issues (Связанные задачи)#
Связанные задачи — это двусторонняя связь между любыми типами задач, которые отображаются в блоке под описанием задачи.
Чтобы связать задачи, выполните следующие шаги:
Авторизуйтесь и перейдите в раздел Issues > List.
Выберите нужную задачу и перейдите на страницу просмотра этой задачи.
В блоке Linked Issues под описанием задачи нажмите +. Откроется окно для выбора типа связи и поиска задач:
Выберите тип связи: Relates to (Относится к), Blocks (Блокирует) или Is blocked by (Заблокирована).
В поле поиска найдите нужные задачи по id.
Сохраните значения, нажав Add.
Связанные задачи отображаются на странице просмотра задачи. Связь является двусторонней и отображается в обеих связанных задачах.
Severity (Критичность)#
Чтобы приоритизировать задачи в бэклоге, вы можете присваивать им уровень критичности. Для этого вы можете использовать 5 уровней:
Неизвестный (Unknown)
Низкий (Low)
Средний (Medium)
Высокий (High)
Крайне критичный (Critical)
Чтобы задать задаче уровень критичности, выполните следующее:
Авторизуйтесь и перейдите на страницу Issues > List.
Нажмите кнопку New Issue в правом верхнем углу на странице просмотра списка задач.
В форме создания задачи заполните все необходимые поля, выберите тип задачи, в поле Severity задайте уровень критичности из выпадающего списка:
Создайте задачу, нажав кнопку Create Issue.
Присвоенный уровень критичности отображается на странице просмотра задачи в правой боковой панели в поле Severity. Если уровень критичности не был задан, то по умолчанию присваивается уровень Unknown.
Изменить критичности можно по нажатию кнопки Edit в правой боковой панели на странице просмотра задачи:
Доработка групповых досок на странице Boards#
На уровне группы доступна возможность работы с досками по категориям статусов: To do, In progress, Done. Для этого выполните следующие действия:
Перейдите на уровень группы.
В левом sidebar перейдите в пункт меню Задачи > Доски:
На открывшемся экране просмотра будет отображена доска Development со стаканами по категориям:
States (Статусы)#
У каждой задачи есть статус, который позволяет определить, что происходит с задачей на данный момент. Когда стандартной статусной модели недостаточно, вы можете создавать свои статусы, учитывая особенности вашего проекта.
Созданные в группе статусы автоматически наследуются в проектах, где также можно создавать отдельные от группы статусы.
Создавать, редактировать и удалять статусы могут только пользователи с ролями Maintainer и Owner.
Создание статусов#
Чтобы создать новый статус, выполните следующие действия:
Авторизуйтесь и перейдите на страницу States в разделе Issues.
Нажмите кнопку New State в правом верхнем углу.
В форме создания статуса заполните следующие поля:
Поле
Описание
Обязательность
Title
Название статуса
Обязательное поле
Description
Описание статуса
Необязательное поле
Background color
Цвет для отображения в интерфейсе приложения
Обязательное поле
Category
Выбор категории Opened или Closed
Обязательное поле
Нажмите кнопку Create state.
Созданный статус сохраняется и отображается в списке статусов:
Редактирование статусов#
Нажмите кнопку с иконкой "Карандаш" напротив нужного статуса.
Отредактируйте необходимые поля: title, description, background color или category.
Нажмите кнопку Save changes.
Изменения сохранятся, информация о статусе обновится.
Удаление статуса#
Нажмите кнопку с иконкой "Корзина".
Отображается уведомление о подтверждении удаления статуса.
Подтвердите удаление. Статус удалится, и список статусов на странице States обновится.
Перевод задач в созданные статусы#
На странице просмотра задачи или эпика можно изменять статусы, доступные в проекте. Для этого нажмите кнопку Choose state в правом верхнем углу страницы задачи или эпика и выберите нужный статус из выпадающего списка:
Фильтрация задач по статусам#
Для удобного планирования и отслеживания задач на досках проекта можно фильтровать задачи по статусам.
Для того, чтобы отфильтровать по статусам задачи на доске, выполните следующие действия:
Перейдите на страницу Boards.
Нажмите кнопку Create list.
Выберите категорию фильтрации States.
Из списка выберите один или несколько нужных статусов:
Нажмите кнопку Add to board.
На странице Boards появится новый список, отфильтрованный с выбранными статусами.
Создание Workflow (Рабочего процесса)#
Создавать новые процессы работы могут пользователи с ролью Owner.
Для управления правилами перехода задач из одного статуса в другой используется функционал Workflow (процесс работы).
Чтобы создать свой Workflow, выполните следующее:
Авторизуйтесь под своей учетной записью и зайдите в нужную рабочую область.
Перейдите на страницу Workflow с помощью бокового меню:
В рабочей области в правом верхнем углу нажмите кнопку Create workflow:
В открывшемся окне заполните название и описание процесса работы и нажмите Create:
После создания workflow появится активная запись в соответствующем меню:
Создайте переходы между статусами:
Нажмите Add step и выберите статус, из которого будут осуществляться переходы:
После добавления стартовых статусов кнопка Add transition становится активной. При ее нажатии открывается окно настройки перехода:
Необходимо заполнить поля:
Поле
Описание
From step
Статус, из которого осуществляется переход
To step
Статус, в который осуществляется переход
Name
Название перехода
Global transition
Флаг, включающий возможность переходить в отмеченный статус из любого другого
Пример настроенного workflow:
Для случаев, когда стандартного набора полей эпиков, историй, задач, багов или тест-кейсов недостаточно, реализована возможность добавлять пользовательские поля для всех типов перечисленных объектов.
Создание, редактирование и удаление пользовательских полей доступно только пользователям с ролями Maintainer, Owner.
Создание правил при настройке workflow#
Механизм создания правил является частью функциональности настройки workflow.
Для создания правила выполните следующие действия:
Перейдите в пункт меню Task management > Workflows.
Перейдите в режим просмотра workflow, нажав кнопку Show workflow.
Каждый переход из одного статуса в другой является активным. Для вызова окна настройки правил нажмите на переход.
На изображении выше отображены следующие функциональные элементы:
Тип сущности, для которой применяется правило.
Информация о переходе и статусах, участвующих в нем.
Batch (связка) правил, применяющихся единовременно — все правила, указанные в batch, должны выполняться одновременно.
Флаг активности batch. Имеет два состояния: учитывается и не учитывается при проверках.
Элементы управления правилом: кнопки редактирования и удаления.
Кнопка создания нового правила в batch.
Кнопка создания нового batch. Batches связаны через логический оператор "ИЛИ" — должна выполняться одна из указанных связок правил, чтобы сущность изменила состояние (статус).
Кнопка выхода из редактора правил.
Для создания нового batch правил нажмите кнопку New batch. В окне настроек правил отобразится созданный контейнер для правил:
Для создания нового batch необходимо, чтобы во всех остальных связках присутствовало минимум одно правило, иначе элемент New batch не будет отображен на форме.
Для создания нового правила в любом из контейнеров необходимо нажать кнопку New rule.
После настройки значений параметров нового правила подтвердите изменения, нажав кнопку Add rule. Новое правило отобразится на форме:
Создание пользовательского поля#
Для создания пользовательских полей на уровне проекта выполните действия:
Авторизуйтесь под своей учетной записью и выберите необходимый проект.
В боковом меню выберите Settings > Custom fields:
В открывшейся рабочей области будут отображены созданные пользовательские поля для проекта. В случае, если их не существует, отобразится пустая рабочая область. Для создания нового поля необходимо нажать кнопку Create custom field:
В открывшемся окне заполните следующие поля:
Поле
Описание
Field title
Название пользовательского поля (здесь и далее ограничение на количество вводимых знаков - 256 символов)
Target types
Тип issue, к которому применимо данное поле
Field type
Тип поля
Поле Field type может принимать следующие значения:
Integer - целое число,
String - текст,
Select - выбор значения из списка,
Multiselect - выбор нескольких значений из списка.При выборе типа Select/Multiselect так же необходимо указать список допустимых значений:
После заполнения всех полей нажмите кнопку Create:
Пользовательские поля отобразятся в задаче:
Создание пользовательских полей на уровне группы повторяет процесс их создания на уровне проекта.
Редактирование значений пользовательских полей#
Откройте необходимую задачу.
В правом боковом меню найдите блок Custom fields.
Нажмите кнопку Edit:
Все пользовательские поля становятся активными для изменений:
После внесения всех необходимых изменений нажмите кнопку Save:
В блоке Custom fields отобразятся изменения:
Справочники данных и связывание справочников#
Связывание справочников позволяет определять зависимости между словарями и управлять вводом пользователей.
Чтобы связать справочники, выполните следующие действия:
В левом меню перейдите в пункт Настройки > Справочники.
В отобразившемся списке справочников выберите необходимый для связывания справочник:
В выбранном словаре перейдите в режим редактирования, нажав кнопку с иконкой «Карандаш» в правом верхнем углу экрана.
На экране редактирования нажмите кнопку добавления колонки Add column.
В добавленной колонке введите название.
Укажите тип данных в колонке Столбец словаря.
При выборе типа данных Столбец словаря появится диалоговое окно, в котором необходимо заполнить все поля:
Dictionary — словарь, с которым происходит связывание;
Column — столбец словаря, с которым происходит связывание.
После заполнения полей кнопка Добавить станет активной. Подтвердите заполненные данные.
В окне работы со словарем заполните все поля. Данные в ячейках созданного и настроенного столбца будут содержать данные из другого словаря.
После заполнения всех ячеек нажмите кнопку Обновить.
Создание групп пользователей#
Чтобы создать или отредактировать группу согласующих, выполните следующие действия:
Перейдите в пункт меню Настройки > Основные.
Нажмите на Группы согласующих в списке, чтобы открыть экран настройки.
Нажмите кнопку Создать группу согласующих. Откроется экран создания группы:
Поле
Описание
Заголовок
Название группы
Псевдоним группы согласующих
Псевдоним, по которому осуществляется поиск
Users
Список пользователей, входящих в группу
После заполнения всех полей нажмите кнопку Создать. Новая группа будет отображена в списке.
Созданную группу можно указать в качестве согласующих wiki-документ:
Инструмент управления релизами TaskTracker#
Работа с релизами доступна только пользователям с ролями Developer, Maintainer, Owner.
Создание релиза#
Авторизуйтесь под своей учетной записью и выберите необходимый проект.
В левом боковом меню выберите Deployments > Releases:
В открывшейся рабочей области будут отображены созданные пользовательские поля для проекта. Если их не существует, отобразится пустая рабочая область.
Для создания нового релиза нажмите кнопку New release:
В открывшейся рабочей области заполните следующие поля:
Поле
Описание
Tag name
Наименование тега. Поле обязательно для заполнения.
Release title
Название релиза. Если будет не заполнено, в имя релиза будет вставлено наименование тега.
Milestones
Спринт.
Release notes
Описание релиза, комментарии.
Wiki links
Ссылка на wiki-страницу.
Test cycles
Выбор из существующих тест-циклов.
URL
Любая ссылка, которую необходимо добавить.
Title
Отображаемый текст ссылки из поля URL.
После заполнения необходимых полей нажмите кнопку Create Release.
Созданный релиз появится в списке релизов:
Редактирование релиза#
Откройте необходимый релиз.
Нажмите кнопку с иконкой "Карандаш":
Откроется режим редактирования релизов:
После внесения изменений нажмите кнопку Save changes:
В случае, если изменения были внесены ошибочно, нажмите Cancel:
Статусная модель релиза#
При создании релиза он находится в статусе In Planning:
Для изменения статуса необходимо на него нажать:
Статусы изменяются в ручном режиме. Релиз удалить нельзя, его можно только отменить, нажав Cancel:
Часто встречающиеся проблемы и пути их устранения#
В текущем релизе проблемы при работе оператора не были выявлены. В случае выявления проблем обратитесь к вашему системному администратору.
Параметры настройки#
У оператора нет доступа к настройкам сервиса в среде окружения. Перечень возможных настроек доступен при установке и первичной конфигурации и описан в Руководстве по установке.
Правила эксплуатации#
Эксплуатация механизмов безопасности должна осуществляться в соответствии с их документацией. Специальных требований к эксплуатации не предъявляется.