docs: reorganize system knowledge by domain

2026-09-12 14:45:42 +03:00
parent 3a99af1a6e
commit f20c3f47bc
83 changed files with 2229 additions and 7335 deletions
@@ -0,0 +1,68 @@
+# WealthLedger: назначение и возможности
+
+WealthLedger — локальное приложение для частного инвестора, который хочет
+понимать свои инвестиции T-Bank: что находится на счетах, какие операции
+исполнены, сколько купонов и дивидендов получено и какие выплаты ожидаются.
+Приложение объединяет эти представления, сохраняя связь суммы с валютой,
+инструментом и брокерским счётом.
+
+## Основные задачи пользователя
+
+После [регистрации или входа](domains/authentication/overview.md) пользователь
+[подключает T-Bank Invest](integrations/tbank.md) в настройках. Локальная
+учётная запись WealthLedger и подключение к брокеру — разные вещи: вход
+открывает приложение, а подключение определяет доступные инвестиционные счета.
+
+| Задача | Что показывает WealthLedger |
+| --- | --- |
+| Найти свой инвестиционный счёт | [Список счетов](domains/accounts/overview.md), их типы и доступные сводки |
+| Понять текущий состав инвестиций | [Портфель](domains/portfolio/overview.md): позиции, денежные остатки и итоги по валютам |
+| Разобрать уже совершённые движения | [Журнал операций](domains/operations/overview.md): исполненные операции с фильтрами и последовательной загрузкой истории |
+| Посчитать полученные выплаты | [Пассивный доход](domains/income/overview.md): исполненные купоны и дивиденды за календарный период |
+| Посмотреть ожидаемые события | [Будущие выплаты](domains/income/upcoming-events.md): купоны, дивиденды, погашения и оферты по текущим позициям |
+| Увидеть общий состав инвестиций | Режим [«Все счета»](domains/portfolio/all-accounts.md), сохраняющий принадлежность строк к счетам |
+| Изучить конкретный инструмент | Поиск и страницы [акций](domains/instruments/stocks.md) и [облигаций](domains/instruments/bonds.md): рынок, личная позиция, история и события |
+
+## Как связаны представления
+
+Пользователь владеет локальными сессиями и одним подключением T-Bank.
+Подключение даёт доступ к поддерживаемым открытым инвестиционным счетам.
+Каждый счёт связывает портфель, операции, полученный доход и будущие выплаты.
+Режим «Все счета» объединяет результаты доступных счетов; отдельного
+брокерского счёта с таким именем он не создаёт.
+
+Портфель отвечает на вопрос «что есть сейчас», журнал — «что исполнено»,
+аналитика дохода — «какие выплаты уже получены», будущие события — «что
+ожидается». Прогноз не подтверждает фактическое зачисление. Полученные купоны
+и дивиденды не равны инвестиционной доходности или результату после налогов.
+
+Денежная сумма всегда относится к одной валюте. Недоступное значение
+отличается от нуля, а объединение счетов не означает автоматическую
+конвертацию всех валют. Краткие определения собраны в [глоссарии](glossary.md).
+
+## Источники и границы продукта
+
+T-Bank поставляет личные брокерские данные и рыночную информацию. Публичные
+данные MOEX дополняют сведения об облигациях и событиях, реестр НКР — рейтинг
+выпуска. Изображения инструментов загружаются из публичного CDN T-Bank.
+[Контекст системы](architecture/context.md) объясняет эти внешние границы.
+
+Инвестиционные возможности предназначены для чтения и анализа. Они не
+описывают размещение торговых поручений или изменение портфеля у брокера.
+Локально сохраняются учётные данные, сессии и зашифрованное подключение;
+финансовые снимки служат временными наблюдениями, а не накопленной историей
+портфеля в собственной базе WealthLedger.
+
+Данные могут зависеть от доступности поставщика и свежести последнего ответа.
+При допустимом использовании сохранённых данных интерфейс сообщает об этом;
+ошибка источника не превращается в нулевой баланс или пустой портфель.
+[Свежесть данных](architecture/cross-cutting/data-freshness.md) и
+[состояния интерфейса](architecture/cross-cutting/ui-resilience.md) объясняют
+эти различия.
+
+Описание относится к подтверждённому локальному устройству приложения.
+Облачная эксплуатация, гарантии доступности и масштабирование не следуют
+из наличия frontend и backend. Их ответственности и ограничения раскрыты
+в [контейнерах системы](architecture/containers.md).
+
+Для выбора темы используйте [карту предметных областей](README.md#предметные-области).