72 lines
1.5 KiB
Markdown
72 lines
1.5 KiB
Markdown
# Template: logic_block
|
|
|
|
```md
|
|
---
|
|
id: logic-<stable-id>
|
|
title: <Human-readable title>
|
|
doc_type: logic_block
|
|
status: draft
|
|
source_of_truth: code
|
|
domain: <domain-name>
|
|
owner: system-analyst
|
|
related_docs:
|
|
- <doc-id>
|
|
related_code:
|
|
- <path/to/file>
|
|
entities:
|
|
- <EntityName>
|
|
tags:
|
|
- logic
|
|
---
|
|
|
|
# <Logic Block Title>
|
|
|
|
## Purpose
|
|
|
|
Кратко опиши, какую переиспользуемую или устойчивую логику реализует блок.
|
|
|
|
## Where Used
|
|
|
|
- Called from: `<ui/api/jobs/services if known>`
|
|
- Used by: `<list of known callers>`
|
|
|
|
## Technical Use Case
|
|
|
|
Опиши пошагово, как работает логический блок:
|
|
|
|
- входные данные;
|
|
- ключевые проверки;
|
|
- преобразования;
|
|
- обращения к данным;
|
|
- результат работы.
|
|
|
|
## Functional Requirements
|
|
|
|
Вынеси сюда устойчивые правила и ограничения:
|
|
|
|
- бизнес-правила;
|
|
- проверки;
|
|
- ветвления;
|
|
- ограничения на вход и выход;
|
|
- условия отказа.
|
|
|
|
## Dependencies
|
|
|
|
- Uses logic: `<other logic blocks if known>`
|
|
- Reads DB: `<if known>`
|
|
- Writes DB: `<if known>`
|
|
- Integrates with: `<if known>`
|
|
|
|
## Error Cases
|
|
|
|
Опиши значимые ошибки и условия их возникновения, если они подтверждены кодом.
|
|
|
|
## Related Code
|
|
|
|
- `<path/to/file>`
|
|
|
|
## Related Documents
|
|
|
|
- [<Related document>](<path-or-doc-link>)
|
|
```
|