7.1 KiB
WealthLedger: документация системы
WealthLedger помогает частному инвестору понимать состав портфеля T-Bank, исполненные операции, полученный доход и будущие выплаты. Здесь объясняются продукт, понятия, функции, взаимодействия и причины архитектурных решений. Основной текст можно читать без исходников; технические ссылки нужны для дальнейшей проверки и изменения системы.
Первое знакомство
- Обзор продукта — задачи пользователя и границы приложения.
- Глоссарий — пользователь, сессия, подключение, счёт, портфель, полученный доход и прогноз выплаты.
- Контекст — WealthLedger и внешние системы.
- Контейнеры — браузерное приложение, API, локальное хранение и обмен данными.
- Портфель и его загрузка — как источник превращается в позиции, суммы и состояние свежести.
После этого читатель должен уметь объяснить происхождение финансового показателя и отличить данные брокера, расчёт сервера и сохранённый экран.
Предметные области
Папки областей группируют знания; они не объявляют отдельные сервисы.
| Тема | Что здесь искать |
|---|---|
| Аутентификация | Регистрация, вход, восстановление и завершение сессии |
| Счета | Доступные счета, сводки и состояния каждого счёта |
| Портфель | Позиции, остатки, суммы, структура и свежесть |
| Все счета | Общий портфель, происхождение строк и сводные разделы |
| Операции | Исполненные операции, фильтры и пагинация |
| Доход | Полученные купоны и дивиденды, периоды и состав расчёта |
| Будущие выплаты | Календарь по текущим позициям и ограничения прогноза |
| Акции и облигации | Поиск выпуска, рыночные показатели и личная история |
Найти материал по задаче
| Потребность | Маршрут |
|---|---|
| Разобраться в системе | Архитектура, нужная область выше, внешние интеграции |
| Найти точные сведения | Глоссарий, показатели портфеля, HTTP API |
| Разобрать расхождение в суммах | Диагностика портфеля |
| Проверить условия локальной работы | Окружение и восстановление |
| Понять ошибку или старые данные | Состояния интерфейса, свежесть данных |
| Найти визуальные роли и примеры | Дизайн-система, UI-каталог |
| Узнать причину архитектурного решения | Журнал ADR |
| Изменить или проверить систему | Сопровождение, затем инструкции нужного репозитория |
Практический tutorial первого финансового сценария пока не подготовлен: он требует подключения брокера, а запуск на новой базе имеет известное ограничение. Маршрут первого знакомства выше — чтение, не учебный запуск. UI-каталог содержит безопасные вымышленные примеры и поясняет границы их использования.
Границы знаний
Основные спецификации сохраняют согласованное проверяемое
поведение, а OpenSpec changes — предложения, дизайн и задачи изменений.
Фактический Store находится в specs/openspec/, основные требования — в
specs/openspec/specs/. Docs объясняет систему; код, тесты, схемы и конфигурация
задают конкретный механизм, а ADR сохраняют принятые решения.
Локальные инструкции frontend и backend
описывают изменение реализации и её проверки.
Эти источники дополняют друг друга. Найденный незавершённый change не доказывает реализованную функцию; расхождение кода и требования требует разбора. Итоги исследований входят в ADR, когда принято значимое решение, и в тематические страницы, когда уточняют знания о системе. Исходные исследовательские отчёты в docs не хранятся. Исторические свидетельства сохраняют результаты своего времени и не заменяют текущее описание системы.
Правила изменения текста, диаграмм, ссылок и проверки docs-impact находятся в CONTRIBUTING.