[UI review] Helpdesk: visual and interaction conformance #1

Open
opened 2026-09-08 18:40:32 +02:00 by zemion · 1 comment
Owner

Status and objective

Pending / not reviewed. This module track belongs to the product-wide UI review epic.
Apply the Core design principles using the shared review process. The current heading-help icon pass and any existing isolated fixes are preparation, not evidence that this whole module is complete. Source documents are being prepared in the current working tree; this issue does not claim they are released.

Prioritize usability defects, consistent interaction and shared-component fixes before broader features. Preserve permissions, security, optional-module boundaries and data integrity.

Source inventory to verify

This is a source-derived starting inventory, not a completed runtime audit. Verify nested routes, embedded dialogs and contributions in the installed module context; add missing surfaces to this issue.

Repository: govoplan-helpdesk.
Manifest source: src/govoplan_helpdesk/backend/manifest.py.

Declared routes (1):

  • /helpdesk — HelpdeskProfilesPage

Declared public routes (0):
None declared in this manifest; verify indirect/contributed surfaces before marking anything not applicable.

Declared settings routes (0):
None declared in this manifest; verify indirect/contributed surfaces before marking anything not applicable.

Declared navigation (1):

  • /helpdesk — Helpdesk profiles

Declared view, settings and contributed surfaces (1):

  • helpdesk.action.save-profile — Save Helpdesk service profile
Source entrypoint seed (1 TSX files; classification is heuristic)

Pages and navigation entrypoints (1):

Review and implementation TODO

  • Confirm every actual page, nested route, dialog, field/form, table/tree, settings level, public/operator surface, widget and cross-module contribution; document role/module prerequisites.
  • Exercise EN/DE, keyboard/focus, narrow and wide layouts, long content, empty/loading/error states and realistic datasets.
  • Check UI-01 heading/label help placement and UI-02 display-first/scoped editing; document any justified large-grid bulk-edit exception with explicit mode, Save/Cancel and dirty-navigation guard.
  • Verify consistent top-right actions (Reload left of New), clean/dirty Save/Cancel behavior, destructive separation and safe navigation/reload.
  • Verify full-width cards/tables, visible last-column actions, pagination, initial sizing, two-way pointer/keyboard resizing and preference reload with fixed columns and horizontal overflow.
  • Check scoped progress/error feedback and predictable tree selection versus expansion; no unnecessary global blocking or repeated background reload.
  • Record findings and implement shared-contract corrections plus all affected consumers, not local CSS/action-row exceptions without justification.
  • Verify save/cancel/retry and partial-failure behavior without unintended writes, sends, deletes or loss of persisted/unsaved data.
  • Update owning manifest-driven EN/DE documentation; record targeted automated checks and manual evidence against actual module surfaces.
  • Complete the principle matrix, list unresolved decisions/manual checks and link follow-ups before proposing closure.

Principle applicability / application / evidence / exceptions

Reviewed Core principle revision: not yet recorded. No exceptions approved.

Principle Applicable surfaces / justified N/A Applied / remaining work Evidence Exception / owner / follow-up
UI-01: Help icons beside the relevant heading/label, not action-button rows Pending inventory Pending review Not yet recorded None approved
UI-02: Display-first with scoped edit dialogs; explicit bulk-grid editing exception Pending inventory Pending review Not yet recorded None approved
UI-03: Shared page actions, Reload/New ordering, Save/Cancel and destructive separation Pending inventory Pending review Not yet recorded None approved
UI-04: Full-width table/card geometry, visible actions, pagination and two-way resizing Pending inventory Pending review Not yet recorded None approved
UI-05: Scoped loading/error feedback, useful progress and retained state Pending inventory Pending review Not yet recorded None approved
UI-06: Predictable tree selection, expansion, grouping and reordering Pending inventory Pending review Not yet recorded None approved
UI-07: Keyboard/focus/accessibility, responsive layouts and understandable German Pending inventory Pending review Not yet recorded None approved
UI-08: Authorization, optional-module boundaries and save/cancel/retry data integrity Pending inventory Pending review Not yet recorded None approved
UI-09: Revision evidence and retroactive checks for changed design principles Pending inventory Pending review Not yet recorded None approved

When a principle changes after this review, re-check applicability and record current evidence. Reopen this issue or link an owned follow-up for outstanding work; notify the central epic. A past review must not silently remain green against an obsolete rule.

Findings / TODO / done ledger

Finding / surface / reproduction Principle and expected behavior TODO / implementation or follow-up Verified done evidence
Full review not started UI-01–UI-09 Inventory and review pending None; no completed review claimed

Manual checks, decisions and closure evidence

  • Manual work pending: safe actual-module walkthrough in both languages and realistic viewports, keyboard/focus, permissions/optional-module contexts, loading/error/empty states, edits/Save/Cancel/navigation/reload, tables/trees and progress.
  • Decisions: none invented by this bootstrap. Record any product or policy choice with context and a recommendation; isolate independent implementation work from blocked decisions.
  • Automated evidence: not yet recorded for this complete module review. Existing targeted fixes/tests may be linked as partial evidence only.
  • Closure gate: verified inventory, complete current principle matrix, resolved required findings, owning EN/DE documentation and automated/manual evidence. Unimplemented placeholders remain pending until real surfaces can be reviewed or an explicit catalog/product decision changes scope.
<!-- govoplan-ui-review:v1:module:helpdesk --> ## Status and objective **Pending / not reviewed.** This module track belongs to the [product-wide UI review epic](https://git.add-ideas.de/GovOPlaN/govoplan/issues/56). Apply the [Core design principles](https://git.add-ideas.de/GovOPlaN/govoplan-core/src/branch/main/docs/UI_DESIGN_PRINCIPLES.md) using the [shared review process](https://git.add-ideas.de/GovOPlaN/govoplan/src/branch/main/docs/project/UI_REVIEW_PROGRAM.md). The current heading-help icon pass and any existing isolated fixes are preparation, not evidence that this whole module is complete. Source documents are being prepared in the current working tree; this issue does not claim they are released. Prioritize usability defects, consistent interaction and shared-component fixes before broader features. Preserve permissions, security, optional-module boundaries and data integrity. ## Source inventory to verify This is a **source-derived starting inventory, not a completed runtime audit**. Verify nested routes, embedded dialogs and contributions in the installed module context; add missing surfaces to this issue. Repository: [govoplan-helpdesk](https://git.add-ideas.de/GovOPlaN/govoplan-helpdesk). Manifest source: [src/govoplan_helpdesk/backend/manifest.py](https://git.add-ideas.de/GovOPlaN/govoplan-helpdesk/src/branch/main/src/govoplan_helpdesk/backend/manifest.py). **Declared routes (1):** - `/helpdesk` — HelpdeskProfilesPage **Declared public routes (0):** None declared in this manifest; verify indirect/contributed surfaces before marking anything not applicable. **Declared settings routes (0):** None declared in this manifest; verify indirect/contributed surfaces before marking anything not applicable. **Declared navigation (1):** - `/helpdesk` — Helpdesk profiles **Declared view, settings and contributed surfaces (1):** - `helpdesk.action.save-profile` — Save Helpdesk service profile <details><summary>Source entrypoint seed (1 TSX files; classification is heuristic)</summary> **Pages and navigation entrypoints (1):** - [webui/src/features/helpdesk/HelpdeskProfilesPage.tsx](https://git.add-ideas.de/GovOPlaN/govoplan-helpdesk/src/branch/main/webui/src/features/helpdesk/HelpdeskProfilesPage.tsx) </details> ## Review and implementation TODO - [ ] Confirm every actual page, nested route, dialog, field/form, table/tree, settings level, public/operator surface, widget and cross-module contribution; document role/module prerequisites. - [ ] Exercise EN/DE, keyboard/focus, narrow and wide layouts, long content, empty/loading/error states and realistic datasets. - [ ] Check UI-01 heading/label help placement and UI-02 display-first/scoped editing; document any justified large-grid bulk-edit exception with explicit mode, Save/Cancel and dirty-navigation guard. - [ ] Verify consistent top-right actions (Reload left of New), clean/dirty Save/Cancel behavior, destructive separation and safe navigation/reload. - [ ] Verify full-width cards/tables, visible last-column actions, pagination, initial sizing, two-way pointer/keyboard resizing and preference reload with fixed columns and horizontal overflow. - [ ] Check scoped progress/error feedback and predictable tree selection versus expansion; no unnecessary global blocking or repeated background reload. - [ ] Record findings and implement shared-contract corrections plus all affected consumers, not local CSS/action-row exceptions without justification. - [ ] Verify save/cancel/retry and partial-failure behavior without unintended writes, sends, deletes or loss of persisted/unsaved data. - [ ] Update owning manifest-driven EN/DE documentation; record targeted automated checks and manual evidence against actual module surfaces. - [ ] Complete the principle matrix, list unresolved decisions/manual checks and link follow-ups before proposing closure. ## Principle applicability / application / evidence / exceptions Reviewed Core principle revision: **not yet recorded**. No exceptions approved. | Principle | Applicable surfaces / justified N/A | Applied / remaining work | Evidence | Exception / owner / follow-up | | --- | --- | --- | --- | --- | | UI-01: Help icons beside the relevant heading/label, not action-button rows | Pending inventory | Pending review | Not yet recorded | None approved | | UI-02: Display-first with scoped edit dialogs; explicit bulk-grid editing exception | Pending inventory | Pending review | Not yet recorded | None approved | | UI-03: Shared page actions, Reload/New ordering, Save/Cancel and destructive separation | Pending inventory | Pending review | Not yet recorded | None approved | | UI-04: Full-width table/card geometry, visible actions, pagination and two-way resizing | Pending inventory | Pending review | Not yet recorded | None approved | | UI-05: Scoped loading/error feedback, useful progress and retained state | Pending inventory | Pending review | Not yet recorded | None approved | | UI-06: Predictable tree selection, expansion, grouping and reordering | Pending inventory | Pending review | Not yet recorded | None approved | | UI-07: Keyboard/focus/accessibility, responsive layouts and understandable German | Pending inventory | Pending review | Not yet recorded | None approved | | UI-08: Authorization, optional-module boundaries and save/cancel/retry data integrity | Pending inventory | Pending review | Not yet recorded | None approved | | UI-09: Revision evidence and retroactive checks for changed design principles | Pending inventory | Pending review | Not yet recorded | None approved | When a principle changes after this review, re-check applicability and record current evidence. Reopen this issue or link an owned follow-up for outstanding work; notify the central epic. A past review must not silently remain green against an obsolete rule. ## Findings / TODO / done ledger | Finding / surface / reproduction | Principle and expected behavior | TODO / implementation or follow-up | Verified done evidence | | --- | --- | --- | --- | | Full review not started | UI-01–UI-09 | Inventory and review pending | None; no completed review claimed | ## Manual checks, decisions and closure evidence - Manual work pending: safe actual-module walkthrough in both languages and realistic viewports, keyboard/focus, permissions/optional-module contexts, loading/error/empty states, edits/Save/Cancel/navigation/reload, tables/trees and progress. - Decisions: none invented by this bootstrap. Record any product or policy choice with context and a recommendation; isolate independent implementation work from blocked decisions. - Automated evidence: not yet recorded for this complete module review. Existing targeted fixes/tests may be linked as partial evidence only. - Closure gate: verified inventory, complete current principle matrix, resolved required findings, owning EN/DE documentation and automated/manual evidence. Unimplemented placeholders remain pending until real surfaces can be reviewed or an explicit catalog/product decision changes scope.
Author
Owner

Partial implementation evidence — UI-01 heading help

Implemented locally; uncommitted and unpushed. This review remains pending. No module review checkbox, principle matrix or issue state is being marked complete by this comment.

The current govoplan-helpdesk UI-01 pass moves migrated documentation-book affordances beside their relevant visible headings/labels using the shared Core contract, removing isolated action-row placement. This is the scope of this partial implementation; it does not certify every screen or every design principle in this module.

Owning manifest-driven English and German help text was updated for the changed placement/workflows. Permissions, business operations and persistence semantics are not intentionally changed by this help-placement pass.

Source scope in the local working tree

  • webui/src/features/helpdesk/HelpdeskProfilesPage.tsx
  • src/govoplan_helpdesk/backend/manifest.py

These paths identify the current uncommitted source scope, not a released commit. Some listed files also contain earlier fixes; this comment claims only the UI-01 changes described above.

Verification

Verified rollout checks (shared evidence, not a complete manual review of this module):

  • Main product WebUI build and bundle-budget gate: passed.
  • Conformance TypeScript: passed.
  • Heading-help / EN-DE guard tests: 21 passed.
  • Workspace placement scan: 129 links across 327 TSX files in 47 WebUI modules passed.
  • Manifest-shape/documentation validation: 72/72 modules passed.
  • Core help/layout component tests: passed.
  • Targeted browser checks: 12 passed; full Core browser conformance: 253/253 passed in 7.2 minutes, with no failures or source fixes during that full run.

Shared/rollout checks are partial evidence, not exhaustive manual review of this module. Record the actual surfaces and principle revision during the full review.

Still pending

  • The complete module inventory and principle-by-principle UI-01–UI-09 review, realistic data/roles/optional modules, EN/DE walkthroughs, keyboard/focus, responsive layouts, errors/loading, save/cancel/navigation and data-integrity checks.
  • Display-first/scoped editing review (UI-02), remaining usability findings and any explicitly justified editing-mode exceptions.
  • Commit/release provenance and any still-required manual acceptance; no deployment or release is claimed here.

Coordination: Meta review epic; authoritative rules: Core UI design principles. Reusable lessons must be checked against already-reviewed modules through linked follow-ups or reopened reviews.

<!-- govoplan-ui-review:v1:partial-evidence:2026-09-08-heading-help:helpdesk --> ## Partial implementation evidence — UI-01 heading help **Implemented locally; uncommitted and unpushed. This review remains pending.** No module review checkbox, principle matrix or issue state is being marked complete by this comment. The current `govoplan-helpdesk` UI-01 pass moves migrated documentation-book affordances beside their relevant visible headings/labels using the shared Core contract, removing isolated action-row placement. This is the scope of this partial implementation; it does not certify every screen or every design principle in this module. Owning manifest-driven English and German help text was updated for the changed placement/workflows. Permissions, business operations and persistence semantics are not intentionally changed by this help-placement pass. ### Source scope in the local working tree - `webui/src/features/helpdesk/HelpdeskProfilesPage.tsx` - `src/govoplan_helpdesk/backend/manifest.py` These paths identify the current uncommitted source scope, not a released commit. Some listed files also contain earlier fixes; this comment claims only the UI-01 changes described above. ### Verification Verified rollout checks (shared evidence, not a complete manual review of this module): - Main product WebUI build and bundle-budget gate: **passed**. - Conformance TypeScript: **passed**. - Heading-help / EN-DE guard tests: **21 passed**. - Workspace placement scan: **129 links across 327 TSX files in 47 WebUI modules passed**. - Manifest-shape/documentation validation: **72/72 modules passed**. - Core help/layout component tests: **passed**. - Targeted browser checks: **12 passed**; full Core browser conformance: **253/253 passed in 7.2 minutes**, with no failures or source fixes during that full run. Shared/rollout checks are partial evidence, not exhaustive manual review of this module. Record the actual surfaces and principle revision during the full review. ### Still pending - The complete module inventory and principle-by-principle UI-01–UI-09 review, realistic data/roles/optional modules, EN/DE walkthroughs, keyboard/focus, responsive layouts, errors/loading, save/cancel/navigation and data-integrity checks. - Display-first/scoped editing review (UI-02), remaining usability findings and any explicitly justified editing-mode exceptions. - Commit/release provenance and any still-required manual acceptance; no deployment or release is claimed here. Coordination: [Meta review epic](https://git.add-ideas.de/GovOPlaN/govoplan/issues/56); authoritative rules: [Core UI design principles](https://git.add-ideas.de/GovOPlaN/govoplan-core/src/branch/main/docs/UI_DESIGN_PRINCIPLES.md). Reusable lessons must be checked against already-reviewed modules through linked follow-ups or reopened reviews.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: GovOPlaN/govoplan-helpdesk#1