Зачем словарь
Один термин — одно понятие. Если слово в документации расходится со словом на экране, правится документация: пользователь ищет то, что видит.
Объекты и комната
| Термин | Значение |
|---|---|
| Комната | документ с объектами и единица доступа. В коде и API историческое имя — board |
| Объект | элемент комнаты: стикер, фигура, текст, фрейм, канбан, карточка, связь |
| Стикер | объект с текстом, перемещается свободно |
| Фигура | прямоугольник, эллипс или ромб; содержит текст |
| Фрейм | контейнер: объекты внутри двигаются вместе с ним |
| Канбан | сетка колонок и дорожек |
| Карточка | объект внутри ячейки канбана; живёт в ячейке, а не на холсте |
| Колонка, дорожка | вертикальная и горизонтальная координата ячейки |
| Связь | линия между двумя объектами |
| Якорь | точка в середине стороны объекта, откуда начинается связь; у объекта их четыре |
| Маршрут связи | форма линии: прямая, угловая, кривая |
| Палитра | одна палитра комнаты: семь тонов по три уровня плюс именованные цвета; одно место, где меняется цвет |
| Тон, уровень | столбец и строка палитры: 100 и 300 для заливок, 600 для линий, границ и текста |
| Именованный цвет | Белый, Чёрный, Прозрачный или Нет: значение по имени, а не уровень тона |
| Свой цвет | значение вне палитры; сохраняется, пока не выбран другой |
| Рельс | вертикальная панель инструментов слева: создать объект, отменить, повторить |
| Шапка | верхняя полоса комнаты: название, меню, свойства, презентация, обсуждение, доступ |
| Выделение | временный набор объектов; не хранится в комнате |
| Камера | положение и масштаб взгляда на комнату |
| Статус карточки | состояние работы: к выполнению, в работе, готово; не заменяет колонку |
| Исполнитель | один человек, назначенный на карточку |
| Срок | диапазон «начало — конец»; просрочка считается по локальной дате |
| Тег | элемент словаря комнаты; на объекте хранится ссылка на тег |
| Ссылка объекта | одно поле: внешний URL или другой объект этой комнаты |
Люди и доступ
| Термин | Значение |
|---|---|
| Организация | верхний уровень: люди, команды, политика |
| Личная организация | организация, которая есть у каждого аккаунта; помечена бейджем «Личная» |
| Ник | уникальный @handle рядом с именем; в меню аккаунта, присутствии и комментариях |
| Имя объекта | необязательная подпись до 120 символов для поиска и презентации; не рисуется на холсте |
| ID объекта | постоянный идентификатор; только для чтения, копируется в ⋯ → Инфо |
| Плитка комнаты | карточка на домашней странице: эмодзи, название, команда, автор и даты |
| Корзина | архив комнаты; комната в корзине не открывается, владелец может восстановить её |
| Команда | группа внутри организации; роли можно выдать команде |
| Роль | что человек может в комнате: просмотр, комментарии, редактор, со-владелец, владелец |
| Capability | атомарное право роли: board.edit, board.export и другие |
| Грант | выдача роли человеку, команде или организации |
| Публичная ссылка | свойство комнаты: доступ только на чтение, без аккаунта |
| Гость | внешний участник с доступом к конкретной комнате |
| Комментарий | сообщение в серверном треде, привязанном к объекту или точке |
| Тред | корень и плоские ответы; «Решить» закрывает, ответ открывает снова |
| Пин | метка на холсте, показывающая место треда |
| Замок | защита объекта от правок; хранит автора |
| Автор замка | человек, поставивший замок; он или менеджер комнаты снимает его |
| Реакция | живая эмодзи-волна у курсора; не сохраняется и не считается |
| Презентация | режим показа объектов комнаты по порядку; слайдом может быть любой объект |
| Ведущий, ведомый | тот, кто листает слайды, и тот, кто смотрит текущий |
Сохранение и результат
| Термин | Значение |
|---|---|
| Подтверждение | сервер записал изменение; состояние saved |
| Очередь офлайна | локальные изменения, ждущие связи |
| Бэкап | JSON со всей комнатой и контрольной суммой |
| Импорт | замена комнаты содержимым бэкапа |
Расширения
| Термин | Значение |
|---|---|
| Событие | факт домена: что, где, кем, с каким объектом |
| Конверт | тело события, которое уходит в вебхук |
| Подписка (вебхук) | один эндпоинт организации, куда приходят события |
| DLQ | события, которые не удалось доставить после всех повторов |
| Токен интеграции | remo_it_…: доступ владельца, сужённый scope |
| Scope | board.read или board.edit — что токену разрешено |
| Серверная команда | действие над комнатой с проверкой прав и идемпотентностью |
| Change set | пакет изменений агента с прогрессом и возобновлением |
| План | предложенная агентом структура или раскладка: превью, «Применить», один ⌘Z; до применения комната не меняется |
| Упорядочить | команда, которая раскладывает выделение в колонки по плану агента |
| Приложение | декларативная панель в комнате |
| Манифест | описание приложения: панель, действия, capabilities |
Куда дальше
Модель продукта — откуда берутся эти термины.