83 lines
1.8 KiB
Markdown
83 lines
1.8 KiB
Markdown
# Template: ui_page
|
|
|
|
```md
|
|
---
|
|
id: ui-<stable-id>
|
|
title: <Human-readable title>
|
|
doc_type: ui_page
|
|
status: draft
|
|
source_of_truth: code
|
|
domain: <domain-name>
|
|
owner: system-analyst
|
|
related_docs:
|
|
- <doc-id>
|
|
related_code:
|
|
- <path/to/file>
|
|
entities:
|
|
- <EntityName>
|
|
tags:
|
|
- ui
|
|
---
|
|
|
|
# <Page Title>
|
|
|
|
## Purpose
|
|
|
|
Кратко опиши, какую пользовательскую задачу решает страница.
|
|
|
|
## Route and Entry Points
|
|
|
|
- Route: `<route-if-known>`
|
|
- Entry points: `<where user comes from>`
|
|
|
|
## Technical Use Case
|
|
|
|
Опиши пошаговый сценарий работы страницы как поток действий и системных реакций.
|
|
|
|
## UI Structure
|
|
|
|
Перечисли основные UI-элементы и для каждого укажи:
|
|
|
|
- назначение;
|
|
- источник данных;
|
|
- значение по умолчанию или placeholder;
|
|
- условия доступности или активации;
|
|
- поведение при взаимодействии;
|
|
- правила валидации.
|
|
|
|
## Functional Requirements
|
|
|
|
Вынеси сюда детальные правила, которые не стоит перегружать в use case:
|
|
|
|
- вызовы API;
|
|
- обработку ответов;
|
|
- локальные правила отображения;
|
|
- условия переходов;
|
|
- feature toggles.
|
|
|
|
## Related APIs
|
|
|
|
- [<API document title>](<path-or-doc-link>)
|
|
|
|
## Related Logic Blocks
|
|
|
|
- [<Logic block title>](<path-or-doc-link>)
|
|
|
|
## Non-Functional Requirements
|
|
|
|
Укажи НФТ, если они подтверждены:
|
|
|
|
- analytics events;
|
|
- observability;
|
|
- feature toggles;
|
|
- security constraints.
|
|
|
|
## Related Code
|
|
|
|
- `<path/to/file>`
|
|
|
|
## Related Documents
|
|
|
|
- [<Related document>](<path-or-doc-link>)
|
|
```
|