Основные понятия и связи
Страница объясняет, из каких «кирпичиков» состоит Assist и как они связаны. После неё описания экранов и процессов будут понятны без дополнительных пояснений.
Схема связей
Клиент и продукт
└── Проект ключ проекта: RGM, номер проекта: 20
├── Команда проекта люди, у каждого подпись роли
├── Релиз 2.4 номер релиза: 4
│ ├── Задача RGM-27 ключ задачи: префикс проекта и номер
│ │ ├── Подзадача RGM-28
│ │ └── Подзадача RGM-29
│ └── Задача RGM-31
├── Задачи без релиза «бэклог проекта»
├── Теги и группы задач справочники проекта
└── Доски проекта
Задача ── Трек (запись о времени) ── Тип работ
Задача ── Комментарии ── Уведомления
Человек ── Роль ── Права на страницы, вкладки, записи и поля
Основные сущности
Проект
Проект — основная единица работы. У проекта есть:
- клиент и продукт — текстовые названия, для которых ведётся работа;
- название — так проект называется в списках;
- префикс — короткий код из заглавных латинских букв, цифр и дефиса (до 10 символов), например
RGM. Из него складываются ключи задач; - тип проекта — значение справочника, которое задаёт администратор;
- типы релизов — какие процессы релизов допустимы (например, KANBAN или SCRUM);
- команда — люди, которые участвуют в проекте. Владелец проекта всегда входит в команду;
- стадия — этап жизни проекта (например, «Идея», «Разработка», «Проект завершен»);
- номер — порядковый номер проекта в кабинете, например
#20. Он используется в адресах страниц.
Релиз
Релиз — отрезок работы внутри проекта со своими датами, ответственным и стадиями. Релиз отвечает на вопрос «что мы сдаём к такой-то дате». У релиза есть название, тип, даты начала и окончания, ответственный, оценка, целевая дата, даты готовности, сдачи и приёмки клиентом, закрывающая сумма и ссылка на акт или счёт.
Релиз принадлежит ровно одному проекту. Задача может входить в релиз, а может не входить ни в какой: такие задачи образуют бэклог проекта (список задач без релиза).
Задача
Задача — единица работы, которую выполняет один исполнитель. У задачи есть:
- ключ — префикс проекта и номер, например
RGM-30. Ключ уникален в проекте; - название и описание;
- тип — вид карточки (например, Default, Story, Bug). От типа зависит процесс (воркфлоу), по которому идёт задача;
- стадия — текущий этап (например, New, In Progress, Done);
- исполнитель — человек из команды проекта;
- сроки — дата начала и дата окончания;
- оценка — планируемое время работы. Хранится в минутах, показывается в часах;
- затрачено — сумма часов, записанных на задачу;
- теги и группа — подписи для отбора;
- релиз — к какому релизу относится;
- родитель — родительская задача, если это подзадача;
- связи с другими задачами.
Подзадача
Подзадача — задача, вложенная в другую (родительскую). Подзадача всегда относится к тому же релизу, что и родитель. Оценка родительской задачи по умолчанию равна сумме оценок подзадач, а затраченное время суммируется вверх по дереву.
Дерево из задач и подзадач называется скоуп. Скоуп есть у проекта (все задачи проекта) и у релиза (задачи релиза).
Трек
Трек — запись о потраченном времени: кто, на какую задачу, какой вид работы выполнял, когда и сколько. Из треков складываются значения «Затрачено» в задачах, релизах и проектах, отчёты по людям и фактические часы в сравнении плана с фактом.
Не путайте трек времени и трек поля: трек поля — запись об изменении значения поля (например, оценки), он хранится в истории значений.
Тип работ
Тип работ — вид деятельности в треке: «Общее», «Разработка», «Дизайн», «Ревью», «Встречи», «Поддержка». Набор типов задаёт администратор.
Стадия и воркфлоу
Стадия (она же статус) — этап, на котором находится задача, релиз, проект или пользователь. Воркфлоу — процесс: набор стадий, переходов между ними и условий переходов. Подробно: «Стадии и переходы».
Гейт — условие на переходе. Пока условие не выполнено (например, у задачи нет исполнителя, оценки или дат), перейти на следующую стадию нельзя. Кабинет сообщает, чего не хватает.
Финальная стадия — стадия, на которой работа считается законченной (например, Done у задачи, «Закрыт» у релиза). Списки по умолчанию скрывают записи на финальных стадиях.
Роль и права
Роль — набор прав. Права определяют, какие страницы и вкладки видит человек, какие записи ему доступны и какие действия он может выполнять. Каждому человеку назначена одна роль. Подробно: «Роли и доступ».
Уведомления
Уведомление — сообщение о событии: назначение задачи, упоминание, комментарий, изменение срока, просрочка. Уведомления приходят в кабинет и, если настроено, в другие каналы: почту, Telegram, Element, браузерные push, webhook.
Как называются элементы: ключи, номера и адреса
| Сущность | Пример | Где используется |
|---|---|---|
| Префикс проекта | RGM | Форма создания проекта, обзор проекта |
| Номер проекта | 20 (показывается как #20) | Адрес /projects/20/... |
| Ключ задачи | RGM-30 | Таблицы, карточки, поиск, комментарии коллег |
| Номер релиза | 4 (показывается как #4) | Адрес /projects/20/releases/4/... |
| Служебный ключ стадии | in_progress | Журнал аудита, настройка воркфлоу |
Ключ задачи можно использовать как поисковый запрос в таблицах задач.
Как сущности влияют друг на друга
- Изменение оценки подзадачи меняет оценку родителя, пока родитель не получил ручное значение.
- Запись трека увеличивает «Затрачено» у задачи, её родителей, релиза и проекта.
- Смена типа задачи может поменять воркфлоу, а значит набор стадий.
- Назначение роли меняет меню человека при следующей загрузке страницы.
- Удаление релиза или проекта удаляет вложенные задачи, подзадачи и часы. Удаление нужно подтвердить.
- Отключение пользователя убирает его из списков выбора исполнителя, но прежние записи остаются.
Что дальше
- Быстрый старт: первые 15 минут в кабинете.
- Устройство экранов: интерфейс кабинета.
- Словарь: термины.