docs: make project documentation self-contained

This commit is contained in:
2026-09-12 13:09:37 +03:00
parent aa9afc15e4
commit 3a99af1a6e
36 changed files with 1006 additions and 703 deletions
+52 -13
View File
@@ -1,16 +1,55 @@
# Возможности
Здесь документируется фактическое поведение завершенных пользовательских фич: пользовательский поток, API-сценарий и ограничения. Не реализованные возможности сюда не добавляются.
Карта текущих возможностей по предметным областям. Каждый сценарий описывает
поведение, взаимодействие компонентов и ограничения. Границы системы —
в [обзоре](../architecture/system-overview.md), значения терминов —
в [глоссарии](../architecture/domain-glossary.md).
- [Аутентификация](authentication.md) — регистрация, сессии и refresh.
- [Подключение T-Bank](tbank-connection.md) — безопасное управление
подключением.
- [Брокерские счета](brokerage-accounts.md) — список поддерживаемых счетов.
- [Портфель](portfolio-view.md) — состав инвестиций и freshness states.
- [Account Ledger](brokerage-account-ledger.md) — исполненные операции счёта.
- [Future Cash Events](brokerage-account-upcoming-events.md) — прогнозируемые
события по текущим позициям.
- [Пассивный доход брокерского счёта](brokerage-account-income-analytics.md) —
исполненные купоны и дивиденды.
- [Frontend UI resilience](frontend-ui-resilience.md) — устойчивые состояния
интерфейса.
## Доступ и подключение
Аутентификация связывает локального пользователя с сессиями. Подключение
T-Bank обеспечивает доступ к брокеру; наличие сессии не заменяет проверку
подключения и доступа к конкретному счёту.
| Сценарий | Что объясняет | Ответственность компонентов |
| --- | --- | --- |
| [Аутентификация](authentication.md) | Вход, восстановление и завершение сессии | Backend проверяет credentials и управляет сессиями; frontend хранит текущее состояние входа и выбирает доступные экраны |
| [Подключение T-Bank](tbank-connection.md) | Защита token, замена подключения и сброс кэшей | Backend проверяет и шифрует token; frontend показывает подтверждённый статус и обновляет финансовые данные |
## Инвестиционные данные
Сценарии используют текущий состав доступных счетов. Денежные расчёты принадлежат
backend; frontend выбирает представление и формат. Исполненные операции,
полученные выплаты и будущие события имеют разные источники и смысл.
| Сценарий | Что объясняет | Ответственность компонентов |
| --- | --- | --- |
| [Брокерские счета](brokerage-accounts.md) | Доступный состав и отдельные сводки | Backend устанавливает доступ и собирает сводки; frontend показывает каждый счёт и состояние его данных |
| [Портфель](portfolio-view.md) | Позиции, остатки, точные суммы и свежесть | Подсистема портфеля нормализует снимки и рассчитывает итоги; frontend сохраняет различие актуальных и устаревших данных |
| [Все счета](all-accounts.md) | Агрегация, происхождение строк и общая пагинация | Backend объединяет доступные счета по правилам каждого раздела; frontend сохраняет выбранный раздел и фильтры при переключении |
| [Журнал операций](brokerage-account-ledger.md) | Исполненные операции, фильтры и пагинация | Backend получает и нормализует операции брокера; frontend управляет применёнными фильтрами и навигацией |
| [Пассивный доход](brokerage-account-income-analytics.md) | Полученные купоны/дивиденды, периоды и сравнения | Backend вычисляет доход по исполненным выплатам; frontend показывает суммы, периоды и состав расчёта |
| [Будущие выплаты](brokerage-account-upcoming-events.md) | Прогноз по текущим позициям и его ограничения | Backend сопоставляет календарь выплат и позиции; frontend отделяет прогноз от фактически полученного дохода |
## Инструменты
Рыночные данные выпуска отличаются от личной позиции и факта зачисления.
Страницы акций и облигаций используют общий подход к показу графика, позиции
и личных событий, сохраняя различия денежных и процентных шкал.
| Сценарий | Что объясняет | Ответственность компонентов |
| --- | --- | --- |
| [Акции](stock-detail.md) | Поиск, идентификация выпуска, котировки, дивиденды и личная история | Backend разрешает идентификатор и объединяет источники; frontend независимо показывает секции выбранной акции |
| [Облигации](bond-detail.md) | Цена в процентах, купоны, доходности и рейтинг выпуска | Backend сопоставляет данные T-Bank, MOEX и НКР; frontend сохраняет происхождение, время и единицы каждого показателя |
## Состояния интерфейса
[Frontend UI resilience](frontend-ui-resilience.md) объясняет первичную загрузку,
ошибки, пустые результаты и сохранённые клиентом данные. Frontend управляет
доступом к экранам, доступностью запросов и восстановлением отдельных разделов.
Ошибки фонового обновления не должны скрывать уже доступные данные текущего
пользователя; смена сессии или подключения очищает данные прежней границы.
Новая возможность описывается после реализации вместе с ответственными
подсистемами и ограничениями. Порядок обновления знаний —
[ведение документации](../development/documentation.md).