Skip to content

Commit b301ebe

Browse files
committed
feat: составить глоссарий предметной области
1 parent 3295fbf commit b301ebe

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

‎GLOSSARY.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Десктоп-клиент
2+
3+
Клиентское JavaFX-приложение для управления ресурсами и пользователями через HTTP API бэкенда.
4+
5+
## Пользователи и доступ
6+
7+
**Пользователь**:
8+
Учётная запись человека в системе: email, имя, фамилия, роль и флаг активности.
9+
_Avoid_: Клиент, профиль, аккаунт
10+
11+
**Роль**:
12+
Уровень доступа учётной записи: `USER`, `MODER` или `ADMIN`. Старшая роль включает все права младших (`USER < MODER < ADMIN`).
13+
_Avoid_: Права, привилегия
14+
15+
**Гость**:
16+
Неаутентифицированный посетитель без сессии; доступна только страница входа.
17+
_Avoid_: Аноним, незалогиненный пользователь
18+
19+
**Создание пользователя**:
20+
Создание учётной записи администратором через форму пользователя. Саморегистрации в системе нет.
21+
_Avoid_: Регистрация (кроме имён существующих классов `RegisterData`, `RegisterRequest`)
22+
23+
**Блокировка**:
24+
Отключение входа для учётной записи (`enabled=false`): заблокированный пользователь не может аутентифицироваться, запись при этом сохраняется. Новые пользователи всегда создаются активными.
25+
_Avoid_: Деактивация, отключение, удаление
26+
27+
**Удаление пользователя**:
28+
Безвозвратное удаление учётной записи из системы. В отличие от блокировки, запись исчезает полностью.
29+
_Avoid_: Блокировка, деактивация
30+
31+
## Ресурсы и файлы
32+
33+
**Ресурс**:
34+
Смысловая единица хранения: метаданные (`title`, `description`, даты) плюс прикреплённые файлы.
35+
_Avoid_: Документ
36+
37+
**Файл**:
38+
Вложение ресурса: метаданные (`name`, `contentType`, `size`) плюс байты, хранящиеся на сервере.
39+
_Avoid_: Вложение, документ
40+
41+
**Скачивание**:
42+
Сохранение одного файла ресурса в локальный каталог.
43+
_Avoid_: Экспорт (в значении одного файла)
44+
45+
**Экспорт**:
46+
Выгрузка данных наружу: XLSX-таблицы пользователей или ресурсов, либо архив файлов ресурса.
47+
_Avoid_: Скачивание (в значении выгрузки)
48+
49+
## Сервисы и ошибки
50+
51+
**Сервисная ошибка**:
52+
Сообщение для пользователя со статусом ответа; статус `0` означает отсутствие связи с сервером. Контроллер показывает её текст напрямую.
53+
_Avoid_: Ошибка API (деталь транспортного уровня, не термин)
54+
55+
**Проверка ввода**:
56+
Клиентская проверка полей формы до вызова сервиса. Её сообщения — не сервисные ошибки.
57+
_Avoid_: Валидация сервера, сервисная ошибка (в значении проверки полей)

0 commit comments

Comments
 (0)