ksv741
951f1a9a20
7.0 KiB
Documentation Impact
Summary
После реализации нужна актуализация существующих AS-IS страниц: раздел «Акции» перестанет быть только текстовым поиском. Целевой контракт и мотивы выбора временного снимка остаются в change; документация описывает получившуюся функцию и границы данных.
Documentation Changes
| Action | Target | Category | Resulting AS-IS | Source | Verification |
|---|---|---|---|---|---|
| update | docs/domains/instruments/stocks.md |
domain | Описать скринер с явной кнопкой поиска, необязательным текстом и шестью условиями, отбор только по подтверждённым признакам покупки и торговли через API, одну карточку на выпуск, стабильные страницы по 30 и время получения каталога. Разъяснить, что это не проверка возможности немедленной сделки и что подтверждённая пустота отличается от отказа источника. Прежнее описание автопоиска на /stocks заменить на фактическое поведение; сохранённый текстовый API и переход к отдельной акции описывать отдельно. |
Delta spec, System Analysis, Design | Сверить страницу с реализованным UI, порядком выдачи и доступными полями; не называть признак покупки гарантией сделки или цену условием скринера. |
| update | docs/integrations/tbank.md |
integration | Кратко объяснить источник полного online-каталога для скринера и смысл признаков доступности; не смешивать справочный каталог с личным портфелем или торговым статусом. | System Analysis | Сверить с фактическим вызовом полного списка акций и опубликованным поведением backend, не дублировать протокол целиком. |
| update | docs/architecture/http-api.md |
architecture | Отметить семантику нового запуска поиска и чтения страницы зафиксированного результата: повторный запуск получает новый список, чтение страницы сохраняет состав и время, недоступный результат не становится пустым. Ссылаться на backend-generated OpenAPI для точной формы операций. | Target contract, System Analysis | Сверить описание с опубликованным backend OpenAPI и фактической обработкой ошибок, не переносить YAML в docs. |
| update | docs/overview.md |
overview | Задача «Изучить конкретный инструмент» включает подбор акций по параметрам наряду с открытием отдельной акции и поиском облигаций. | Proposal, Delta spec | Убедиться, что обзор ссылается на актуальную страницу акций и не обещает фильтры по финансовым показателям. |
| update | docs/README.md |
overview | Строка навигации «Акции и облигации» явно называет скринер акций, не создавая новую страницу ради функции. | Delta spec | Проверить ссылку на существующий раздел акций и согласованность с обзором. |
| update | docs/glossary.md |
domain | Определить «Скринер акций» как подбор выпусков по условиям из каталога с указанием времени получения; отличить его от текстового поиска конкретного инструмента, личного портфеля и подтверждения исполнимости сделки. | Delta spec, System Analysis | Определение не содержит маршрутов, классов, механизма хранения или перечня HTTP-полей. |
Diagram Promotion
По умолчанию не переносить system-analysis/sequences/stock-screener.mmd: он объясняет согласование change и не нужен для понимания устойчивого пользовательского поведения сверх тематической страницы. Если после реализации поток страниц окажется существенным для AS-IS архитектуры, пересмотреть отдельно по фактическому состоянию, а не копировать диаграмму автоматически.
ADR Decision
N/A: краткоживущий снимок результатов — обратимый способ обеспечить стабильные страницы при текущем одном экземпляре backend. Альтернативы и последствия уже записаны в Design; нового долгоживущего инфраструктурного стандарта не вводится.
Glossary / Navigation Impact
Добавить один термин в существующий docs/glossary.md; обновить существующие строки docs/README.md и docs/overview.md. Новая страница или раздел индекса не требуются.
No-Change Rationale
docs/architecture/cross-cutting/data-freshness.md уже различает online-справочные сведения и сохранённые личные данные; обновление нужно лишь при изменении этой границы при реализации. Прочие страницы, включая облигации, не затрагиваются. Канонический OpenAPI в docs не создаётся.