docs: simplify system documentation
This commit is contained in:
@@ -44,15 +44,9 @@ WealthLedger помогает частному инвестору понимат
|
||||
| Разобраться в системе | [Архитектура](architecture/README.md), нужная область выше, [внешние интеграции](integrations/README.md) |
|
||||
| Найти точные сведения | [Глоссарий](glossary.md), [показатели портфеля](domains/portfolio/data-reference.md), [HTTP API](architecture/http-api.md) |
|
||||
| Разобрать расхождение в суммах | [Диагностика портфеля](domains/portfolio/how-to/investigate-discrepancy.md) |
|
||||
| Проверить условия локальной работы | [Окружение и восстановление](development/local-workspace.md) |
|
||||
| Понять ошибку или старые данные | [Состояния интерфейса](architecture/cross-cutting/ui-resilience.md), [свежесть данных](architecture/cross-cutting/data-freshness.md) |
|
||||
| Найти визуальные роли и примеры | [Дизайн-система](development/design-system.md), [UI-каталог](development/ui-catalog.md) |
|
||||
| Понять визуальные роли и состояния | [Визуальные принципы](design/overview.md) |
|
||||
| Узнать причину архитектурного решения | [Журнал ADR](adr/README.md) |
|
||||
| Изменить или проверить систему | [Сопровождение](development/README.md), затем инструкции нужного репозитория |
|
||||
|
||||
Практический tutorial первого инвестиционного сценария пока не подготовлен:
|
||||
он требует подключения брокера. Маршрут первого знакомства выше — чтение, не учебный запуск.
|
||||
UI-каталог содержит безопасные вымышленные примеры и поясняет границы их использования.
|
||||
|
||||
## Границы знаний
|
||||
|
||||
@@ -68,8 +62,8 @@ UI-каталог содержит безопасные вымышленные
|
||||
реализованную функцию; расхождение кода и требования требует разбора.
|
||||
Итоги исследований входят в ADR, когда принято значимое решение, и в тематические
|
||||
страницы, когда уточняют знания о системе. Исходные исследовательские отчёты
|
||||
в docs не хранятся. [Исторические свидетельства](development/README.md#исторические-свидетельства)
|
||||
сохраняют результаты своего времени и не заменяют текущее описание системы.
|
||||
в docs не хранятся. История изменений остаётся в Git; документация описывает
|
||||
текущее устройство системы и причины архитектурных решений.
|
||||
|
||||
Правила изменения текста, диаграмм, ссылок и проверки docs-impact находятся
|
||||
в [CONTRIBUTING](CONTRIBUTING.md).
|
||||
|
||||
Reference in New Issue
Block a user