spec: unify income payment cards and drop period comparisons (WealthLedger/main#33)
51 lines
7.2 KiB
Markdown
51 lines
7.2 KiB
Markdown
# Documentation Impact
|
||
|
||
## Summary
|
||
|
||
Обновление canonical AS-IS нужно: документы сейчас прямо описывают сравнения
|
||
дохода и три разных формы карточек выплат. После поставки описание должно
|
||
отражать только выбранный период и единое представление купонов/дивидендов
|
||
с разной степенью подтверждения. Целевые страницы уже существуют; новых
|
||
разделов навигации не требуется.
|
||
|
||
## Documentation Changes
|
||
|
||
| Action | Target | Category | Resulting AS-IS | Source | Verification |
|
||
| --- | --- | --- | --- | --- | --- |
|
||
| update | `docs/domains/income/overview.md` | domain | Удалены блоки и расчёт comparisons, а также сведения о comparison coverage и процентах; income API содержит только данные выбранного периода, buckets сохраняются; плоский список фактических выплат использует общее представление купона/дивиденда. | `specs/brokerage-account-income-analytics/spec.md`; `system-analysis/analysis.md` §§ Contracts, Data and State Semantics | Сверить текст о расчёте, полноте, пустоте и карточках с двумя income API ответами и фактической страницей. |
|
||
| update | `docs/domains/portfolio/all-accounts.md` | domain | Для `all` доход учитывает доступные счета, выбранный период, source currencies и принадлежность entries без годового/предыдущего сравнения. | `specs/brokerage-account-income-analytics/spec.md`; `system-analysis/analysis.md` §§ Contracts, Security and NFR at System Boundaries | В документе нет правил year comparison; данные `all` соответствуют ответу и интерфейсу. |
|
||
| update | `docs/domains/operations/overview.md` | domain | Купоны/дивиденды в полном журнале, пяти недавних операциях и истории инструмента показаны одним предметным представлением исполненной выплаты; не-доходные операции сохраняют прежнюю семантику и детали. | `specs/brokerage-account-ledger/spec.md`; `design.md` § Decisions/frontend | Сопоставить три экрана, знак, исходную валюту, описание и дополнительную историю инструмента. |
|
||
| update | `docs/domains/income/upcoming-events.md` | domain | Полный прогноз и превью используют общее представление купона/дивиденда с пометкой прогноза, nullable Money и датой реестра для dividend; offer/maturity сохраняют смысл. | `specs/brokerage-account-upcoming-events/spec.md`; `system-analysis/analysis.md` § Data and State Semantics | Сверить оба экрана с типизированным ответом, неизвестной суммой, dateKind и отсутствием фактического дохода в прогнозе. |
|
||
| update | `docs/domains/instruments/stocks.md` | domain | Будущий и прошедший дивидендный график используют общую карточку с пометкой события по графику; сумма на акцию, оценка и дата реестра не выдаются за личное зачисление. История личных операций остаётся отдельной. | `specs/instrument-income-schedules/spec.md`; `design.md` §§ Decisions/frontend, UI/UX Package | Сверить разные деньги/даты и границу между графиком и операцией на странице акции. |
|
||
| update | `docs/domains/instruments/bonds.md` | domain | Купонный календарь и прошлые события используют общую карточку с суммой на облигацию, отдельной оценкой и известными параметрами; исполнение подтверждает только личная история. | `specs/instrument-income-schedules/spec.md`; `design.md` §§ Decisions/frontend, UI/UX Package | Сверить ближайший/прошлый/недатированный купон и неизвестную сумму на странице облигации. |
|
||
| update | `docs/architecture/http-api.md` | architecture | Зафиксировать, что оба income-analytics ответа больше не содержат данных сравнения; публичный контракт остаётся backend-generated OpenAPI, frontend получает обновлённый snapshot отдельно. Не дублировать машинную схему. | `system-analysis/analysis.md` §§ Contracts, Compatibility / Migration | Сверить описание с опубликованным OpenAPI и отсутствием comparison fields/roles. |
|
||
|
||
## Diagram Promotion
|
||
|
||
Не переносить `system-analysis/sequences/income-period.mmd` и
|
||
`system-analysis/sequences/payment-sources.mmd`: устойчивые инварианты
|
||
помещаются в тематические страницы; подробный сценарный flow полезен в
|
||
архиве change, а не как параллельная AS-IS диаграмма.
|
||
|
||
## ADR Decision
|
||
|
||
N/A: изменяется продуктовый UI и ответ income API, не вводится новое
|
||
долгоживущее архитектурное правило или интеграция. Существующий
|
||
`docs/adr/017-local-tbank-reads-and-background-sync.md` — исторический
|
||
принятый документ о старом поведении; не переписывать старое решение
|
||
задним числом. Актуальный текст о выбранном периоде должен жить в
|
||
`docs/domains/income/overview.md` и cross-cutting AS-IS при необходимости.
|
||
|
||
## Glossary / Navigation Impact
|
||
|
||
Новых терминов или маршрутов нет. Существующие значения «выплата», «прогноз»,
|
||
«операция» и «событие графика» разъясняются в тематических страницах.
|
||
`docs/overview.md` сохраняет существующую ссылку на доход.
|
||
|
||
## No-Change Rationale
|
||
|
||
Не создавать новую страницу `docs/design/`, не переносить target JSON Schema
|
||
и не менять интеграционные описания T-Bank/MOEX: данные их источников и
|
||
вычисления не изменяются. Остальные docs/ и исторические ADR не требуют
|
||
обновления.
|