Фиксирую состояние
This commit is contained in:
@@ -91,6 +91,12 @@ Mermaid-диаграмма должна содержать:
|
||||
- `application`
|
||||
- `platform`
|
||||
|
||||
Дополнительные метаданные для случаев изменения существующей документации:
|
||||
|
||||
- `action`
|
||||
- `target_doc_id`
|
||||
- `target_path`
|
||||
|
||||
#### 6.x для `ui_page`
|
||||
|
||||
Обязательная структура:
|
||||
@@ -117,6 +123,24 @@ Mermaid-диаграмма должна содержать:
|
||||
- Поля описывать списком (не таблицей).
|
||||
- Общие правила (например, read-only, поведение при пустом значении) выносить в общий блок, не дублировать для каждого поля.
|
||||
|
||||
Отдельно нужно различать два сценария описания:
|
||||
|
||||
1. Если описывается новая UI-страница или новая самостоятельная UI-форма, раздел оформляется полноценно по шаблону `ui_page`.
|
||||
- Нужно дать достаточный контекст для разработки и тестирования.
|
||||
- Нужно подробно описывать структуру формы, состояния отображения, поведение полей, ошибки, empty state и пользовательские действия.
|
||||
|
||||
2. Если описывается доработка уже существующей страницы или существующей UI-формы, не нужно повторно копировать полное описание из действующей документации.
|
||||
- Нужно учитывать уже существующее описание страницы в документации и аналитике.
|
||||
- В аналитике нужно явно указать, что именно меняется в существующем сценарии: что добавляется, редактируется или удаляется.
|
||||
- Нужно указывать точку изменения: в какой существующей странице, форме, блоке или сценарии вносится изменение.
|
||||
- Нужно ссылаться на существующий документ или раздел, где базовое поведение уже описано.
|
||||
- Нужно описывать только delta изменений, достаточную для реализации доработки и актуализации документации.
|
||||
- Полное описание существующей страницы в таком разделе не дублируется.
|
||||
- Для такой доработки в metadata нужно явно указывать `action: update`.
|
||||
- Если изменение должно попасть в уже существующий markdown-документ, нужно явно указывать `target_doc_id` и/или `target_path`.
|
||||
- `target_doc_id` должен совпадать с `id` существующего документа, который требуется обновить.
|
||||
- Если `target_doc_id`/`target_path` не указаны, агент может ошибочно интерпретировать раздел как создание нового документа.
|
||||
|
||||
Нефункциональные требования для `ui_page`:
|
||||
|
||||
- пользовательская аналитика оформляется таблицей с колонками:
|
||||
@@ -172,6 +196,10 @@ Mermaid-диаграмма должна содержать:
|
||||
- `### Функциональные требования`
|
||||
- `### Нефункциональные требования`
|
||||
|
||||
`logic_block` удобно использовать для фиксации точечных изменений существующего сценария, если раздел не описывает новую самостоятельную страницу или новую самостоятельную форму, а только уточняет delta к уже существующей документации.
|
||||
|
||||
Если точечное изменение должно изменить существующий документ другого типа, `logic_block` для этого использовать нельзя. В этом случае metadata раздела должна указывать тип и идентификатор целевого существующего документа, который требуется обновить.
|
||||
|
||||
## Дополнительные правила по слоям
|
||||
|
||||
- Проверка ролевой модели пользователя обычно выполняется на уровне `ufs`.
|
||||
@@ -182,4 +210,3 @@ Mermaid-диаграмма должна содержать:
|
||||
|
||||
- Аудит: события, которые фиксируют действия пользователя и позволяют ответить на вопрос «кто, что, когда сделал».
|
||||
- Мониторинг: технические события/метрики для контроля стабильности и поиска сбоев.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user