Spaces:
Sleeping
Sleeping
solidprivacy-nl commited on
Commit ·
c792de7
1
Parent(s): c49e63e
Record MVP UI cleanup and export redesign priority decision
Browse files- DECISION_LOG.md +34 -55
DECISION_LOG.md
CHANGED
|
@@ -4,6 +4,40 @@ This file records accepted strategic, product and architecture decisions.
|
|
| 4 |
|
| 5 |
---
|
| 6 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
## 2026-06-18 — D025 — PERSON-name implementation requires green contract tests first
|
| 8 |
|
| 9 |
Status: accepted tests/specification decision
|
|
@@ -26,15 +60,6 @@ Consequence:
|
|
| 26 |
Implementation package must satisfy the contract fixture before benchmark review.
|
| 27 |
```
|
| 28 |
|
| 29 |
-
Implications:
|
| 30 |
-
|
| 31 |
-
- Future implementation must preserve role/context words.
|
| 32 |
-
- Future implementation must match only the sensitive name value for role/title cases.
|
| 33 |
-
- Negative cases such as court names, addresses, care locations, legal articles and document-navigation references must not become PERSON matches.
|
| 34 |
-
- Single-surname handling remains high ambiguity and must follow the contract policy.
|
| 35 |
-
- Weak name-near-contact/reference contexts remain candidate-only unless separately approved.
|
| 36 |
-
- No production threshold or gate is created by this decision.
|
| 37 |
-
|
| 38 |
---
|
| 39 |
|
| 40 |
## 2026-06-18 — D024 — PERSON-name improvement proceeds test-first
|
|
@@ -59,15 +84,6 @@ Consequence:
|
|
| 59 |
Contract tests are required before recognizer implementation.
|
| 60 |
```
|
| 61 |
|
| 62 |
-
Implications:
|
| 63 |
-
|
| 64 |
-
- Role/context words such as `cliënt`, `slachtoffer`, `minderjarige`, `arts`, `getuige`, `eiser`, `verweerder`, `verpleegkundige`, `zorgmedewerker`, `behandelaar` and `mantelzorger` must remain readable.
|
| 65 |
-
- Future PERSON-name matching should mask the sensitive name value, not the legal/care role meaning.
|
| 66 |
-
- Broad capitalization-based matching is not acceptable as a design route.
|
| 67 |
-
- Single-surname handling requires strong context and may remain candidate-only unless contract tests prove low false-positive risk.
|
| 68 |
-
- Human review remains necessary.
|
| 69 |
-
- No production threshold or gate is created by this decision.
|
| 70 |
-
|
| 71 |
---
|
| 72 |
|
| 73 |
## 2026-06-15 — D023 — Synchronized scrolling is default review behavior, not a user-facing technical control
|
|
@@ -80,19 +96,6 @@ Decision:
|
|
| 80 |
In the central side-by-side review surface, synchronized scrolling should be on by default and should not be exposed as a visible checkbox.
|
| 81 |
```
|
| 82 |
|
| 83 |
-
Rationale:
|
| 84 |
-
|
| 85 |
-
The coordinator confirmed that there is no clear normal-user use case for turning synchronized scrolling off. In this review task, synchronized movement of source and processed panes is expected behavior rather than a technical choice. Removing the checkbox reduces interface noise.
|
| 86 |
-
|
| 87 |
-
Accepted UI behavior:
|
| 88 |
-
|
| 89 |
-
- markers default on;
|
| 90 |
-
- marker control remains available as `Markeringen tonen`;
|
| 91 |
-
- synchronized scrolling stays active;
|
| 92 |
-
- no visible synchronized-scroll checkbox;
|
| 93 |
-
- short explanatory copy remains visible;
|
| 94 |
-
- review table remains source of truth and fallback.
|
| 95 |
-
|
| 96 |
Boundary:
|
| 97 |
|
| 98 |
This decision does not change replacement behavior, export/download behavior, Scrub Key behavior or reinsert behavior.
|
|
@@ -109,29 +112,15 @@ Decision:
|
|
| 109 |
After visual review of the isolated synchronized-scroll prototype, bounded synchronized scrolling may be integrated into the existing side-by-side review surface.
|
| 110 |
```
|
| 111 |
|
| 112 |
-
Rationale:
|
| 113 |
-
|
| 114 |
-
The coordinator confirmed that the isolated prototype looked good and may be integrated into the production environment. The integration must remain bounded: source and processed panes stay in the review surface, the review table remains source of truth and fallback, and synchronized scrolling remains a visual/navigation aid only.
|
| 115 |
-
|
| 116 |
Implementation boundaries:
|
| 117 |
|
| 118 |
-
- Use local escaped HTML/JS inside the app.
|
| 119 |
- Keep synchronized scrolling bounded to the side-by-side review surface.
|
| 120 |
- Do not change replacement behavior.
|
| 121 |
- Do not mutate review table state.
|
| 122 |
- Do not write or change Scrub Key data.
|
| 123 |
- Do not change export/download behavior.
|
| 124 |
- Do not change reinsert behavior.
|
| 125 |
-
- Do not add dependencies.
|
| 126 |
-
- Do not use cloud processing.
|
| 127 |
- Do not use real data.
|
| 128 |
-
- Preserve the warning that percentage-based sync can be imperfect when source and processed text differ structurally.
|
| 129 |
-
|
| 130 |
-
Verification requirement:
|
| 131 |
-
|
| 132 |
-
```text
|
| 133 |
-
GitHub Actions green -> Hugging Face sync green -> coordinator app screenshot.
|
| 134 |
-
```
|
| 135 |
|
| 136 |
---
|
| 137 |
|
|
@@ -145,19 +134,9 @@ Decision:
|
|
| 145 |
The review UX should move toward one unified side-by-side main review surface: source text on the left, processed/checked text on the right, with optional highlights integrated in the processed-text pane. The product should not keep adding separate helper panels or duplicate preview expanders for every review feature.
|
| 146 |
```
|
| 147 |
|
| 148 |
-
Rationale:
|
| 149 |
-
|
| 150 |
-
The current interface risks becoming less intuitive because each new review function can become another expander/panel. The coordinator feedback is that a simpler professional workflow should let the user compare source and processed output directly, with visual support in the same main review area. A separate highlight-only preview and repeated inline labels such as `Gemarkeerd` add cognitive noise when the highlight color already communicates the marker.
|
| 151 |
-
|
| 152 |
Implications:
|
| 153 |
|
| 154 |
-
- Add `SIDE_BY_SIDE_REVIEW_UX_DIRECTION.md` as the central direction document for this UX line.
|
| 155 |
- Future review UX work should centralize around source-vs-processed comparison.
|
| 156 |
-
- The highlight toggle should belong near/in the main side-by-side review surface, not primarily as a separate duplicate preview panel.
|
| 157 |
-
- Repeated per-highlight labels such as `Gemarkeerd` should not be the long-term design when the marker itself is sufficient.
|
| 158 |
-
- Synchronized scrolling is a valid UX goal but requires separate planning/testing because it may need custom HTML/component work.
|
| 159 |
-
- D022 records the later approved bounded implementation route for synchronized scrolling after prototype review.
|
| 160 |
-
- D023 records that synchronized scrolling should now behave as default UI behavior without a visible checkbox.
|
| 161 |
- The review table remains source of truth and fallback.
|
| 162 |
- Serial review remains a guided review layer, not a replacement of the table.
|
| 163 |
- The old replacement decision helper panel must not return as normal user-facing UI.
|
|
|
|
| 4 |
|
| 5 |
---
|
| 6 |
|
| 7 |
+
## 2026-06-18 — D026 — Temporarily prioritize MVP UI cleanup and export/download redesign
|
| 8 |
+
|
| 9 |
+
Status: accepted product-direction decision
|
| 10 |
+
|
| 11 |
+
Decision:
|
| 12 |
+
|
| 13 |
+
```text
|
| 14 |
+
Pause new recall/benchmark follow-up packages temporarily and prioritize MVP UI cleanup/export redesign.
|
| 15 |
+
```
|
| 16 |
+
|
| 17 |
+
Reason:
|
| 18 |
+
|
| 19 |
+
```text
|
| 20 |
+
The app must move from a prototype/debug interface toward a professional MVP workflow.
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
Consequence:
|
| 24 |
+
|
| 25 |
+
```text
|
| 26 |
+
Next packages focus on export/download UX and hiding/collapsing debug details without weakening safety controls.
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
Implications:
|
| 30 |
+
|
| 31 |
+
- Recall/benchmark follow-up packages are parked unless a concrete blocker appears.
|
| 32 |
+
- Export/download UX is now the active next user-visible improvement line.
|
| 33 |
+
- Technical/audit details must remain available but move out of the primary flow where appropriate.
|
| 34 |
+
- Scrub Key must stay clearly separated and visibly sensitive.
|
| 35 |
+
- Export semantics must not change silently.
|
| 36 |
+
- The review table remains source of truth and fallback.
|
| 37 |
+
- No Streamlit implementation is approved by this planning decision; implementation requires separate workpackages.
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
## 2026-06-18 — D025 — PERSON-name implementation requires green contract tests first
|
| 42 |
|
| 43 |
Status: accepted tests/specification decision
|
|
|
|
| 60 |
Implementation package must satisfy the contract fixture before benchmark review.
|
| 61 |
```
|
| 62 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
---
|
| 64 |
|
| 65 |
## 2026-06-18 — D024 — PERSON-name improvement proceeds test-first
|
|
|
|
| 84 |
Contract tests are required before recognizer implementation.
|
| 85 |
```
|
| 86 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 87 |
---
|
| 88 |
|
| 89 |
## 2026-06-15 — D023 — Synchronized scrolling is default review behavior, not a user-facing technical control
|
|
|
|
| 96 |
In the central side-by-side review surface, synchronized scrolling should be on by default and should not be exposed as a visible checkbox.
|
| 97 |
```
|
| 98 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 99 |
Boundary:
|
| 100 |
|
| 101 |
This decision does not change replacement behavior, export/download behavior, Scrub Key behavior or reinsert behavior.
|
|
|
|
| 112 |
After visual review of the isolated synchronized-scroll prototype, bounded synchronized scrolling may be integrated into the existing side-by-side review surface.
|
| 113 |
```
|
| 114 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 115 |
Implementation boundaries:
|
| 116 |
|
|
|
|
| 117 |
- Keep synchronized scrolling bounded to the side-by-side review surface.
|
| 118 |
- Do not change replacement behavior.
|
| 119 |
- Do not mutate review table state.
|
| 120 |
- Do not write or change Scrub Key data.
|
| 121 |
- Do not change export/download behavior.
|
| 122 |
- Do not change reinsert behavior.
|
|
|
|
|
|
|
| 123 |
- Do not use real data.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 124 |
|
| 125 |
---
|
| 126 |
|
|
|
|
| 134 |
The review UX should move toward one unified side-by-side main review surface: source text on the left, processed/checked text on the right, with optional highlights integrated in the processed-text pane. The product should not keep adding separate helper panels or duplicate preview expanders for every review feature.
|
| 135 |
```
|
| 136 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 137 |
Implications:
|
| 138 |
|
|
|
|
| 139 |
- Future review UX work should centralize around source-vs-processed comparison.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 140 |
- The review table remains source of truth and fallback.
|
| 141 |
- Serial review remains a guided review layer, not a replacement of the table.
|
| 142 |
- The old replacement decision helper panel must not return as normal user-facing UI.
|