GovOPlaN/govoplan
2
0
Fork 0
Code Issues 18 Pull Requests Actions Packages Projects Releases 3 Wiki Activity

[User Story] Establish and apply a whole-system GovOPlaN interface pattern language #11

New Issue
Closed
opened 2026-07-20 14:40:41 +02:00 by zemion · 4 comments
zemion commented 2026-07-20 14:40:41 +02:00
Owner
Copy Link
Copy Source

User Story

As a GovOPlaN user and module developer, I want the whole system to use a coherent, documented interface pattern language, so that moving between modules feels predictable, accessible, calm, and accountable while each domain remains appropriately specialized.

Scope and Pilot

This covers every user-facing surface: navigation, focused views, directories, workspaces, guided review, forms/imports, previews, decisions, asynchronous operations, reporting, policy/provenance, monitoring, public entry points, responsive behavior, accessibility, and contextual help.

Campaign is the first full-domain pilot because it combines list/detail, import, settings, policy, files, templates, build/review, preview, asynchronous send, interventions, and reporting. The program does not depend on Workflow; Workflow later consumes the proven focused-view and review patterns.

Acceptance Criteria

  • Inventory every active WebUI route/surface with owner, audience, primary task, layout archetype, sensitivity/consequence, shared components, deviations, related issues, and migration priority.
  • Define a task/layout taxonomy including directory/explorer, list-detail workspace, guided review, create/edit, import/mapping, dashboard, monitoring/reporting, configuration, decision/approval, and public service surfaces.
  • Canonical patterns cover shell/navigation, focused task views, hierarchy, lists/filtering, detail/forms, progressive disclosure, wizards/dialogs/overlays, validation/problem lists, review/approval, async progress/retry/reconciliation, empty/loading/error/offline states, provenance, blocked/destructive actions, notifications/help, accessibility/keyboard, responsive behavior, i18n/theme, and privacy/redaction.
  • Each pattern documents purpose, use/non-use, anatomy, states, placement, wording, accessibility, permission/privacy behavior, component/extension point, examples, anti-patterns, and tests.
  • Reconcile Core #227's interface-ethics doctrine, Core #225's admin work, existing layout principles, and the UI/UX decision ledger into one pattern language.
  • Core owns reusable primitives/contracts; modules own domain composition and do not import sibling-private components.
  • Docs #15 renders pattern/reference topics and stable route/field/blocker help.
  • Campaign audits every surface and maps deviations to existing/new Campaign or Core issues.
  • Campaign #59, #62, #63, #65, #73, and #35 are concrete pilot cases for details, async progress, review interventions, filtering, stable previews, and guided entry.
  • Extract a generic Core primitive only after a second consumer or clear cross-module contract exists.
  • Shared behavior/accessibility tests cover critical patterns; visual regression supplements rather than replaces behavioral contracts.
  • Each module gets a bounded migration plan and a rollout matrix with current/target pattern, owner, issue, status, and verification evidence.
  • Definition of done for changed surfaces includes the applicable pattern, accessibility, privacy, permissions, consequences, provenance, async/error behavior, and docs.

Initial Slices

  1. Whole-system route/surface/component inventory.
  2. Pattern taxonomy and reconciliation of doctrine, ledger, and layout docs.
  3. Campaign UX architecture review and issue map.
  4. Campaign pilot: build/review/intervention, preview/detail, and send-progress surfaces.
  5. Extract proven Core primitives with behavior/accessibility tests.
  6. Seed live pattern/reference documentation through Docs #15.
  7. Prioritized per-module migration program.

View Composition Principle

A focused view is one pattern in this language: it composes only the modules, navigation, and actions relevant to the current task while preserving an obvious escape to the broader system. Activation may later come from workflow step, role/user default, manual switching, or another policy source; those activation semantics remain separate from this design-system program.

## User Story As a GovOPlaN user and module developer, I want the whole system to use a coherent, documented interface pattern language, so that moving between modules feels predictable, accessible, calm, and accountable while each domain remains appropriately specialized. ## Scope and Pilot This covers every user-facing surface: navigation, focused views, directories, workspaces, guided review, forms/imports, previews, decisions, asynchronous operations, reporting, policy/provenance, monitoring, public entry points, responsive behavior, accessibility, and contextual help. Campaign is the first full-domain pilot because it combines list/detail, import, settings, policy, files, templates, build/review, preview, asynchronous send, interventions, and reporting. The program does not depend on Workflow; Workflow later consumes the proven focused-view and review patterns. ## Acceptance Criteria - [ ] Inventory every active WebUI route/surface with owner, audience, primary task, layout archetype, sensitivity/consequence, shared components, deviations, related issues, and migration priority. - [ ] Define a task/layout taxonomy including directory/explorer, list-detail workspace, guided review, create/edit, import/mapping, dashboard, monitoring/reporting, configuration, decision/approval, and public service surfaces. - [ ] Canonical patterns cover shell/navigation, focused task views, hierarchy, lists/filtering, detail/forms, progressive disclosure, wizards/dialogs/overlays, validation/problem lists, review/approval, async progress/retry/reconciliation, empty/loading/error/offline states, provenance, blocked/destructive actions, notifications/help, accessibility/keyboard, responsive behavior, i18n/theme, and privacy/redaction. - [ ] Each pattern documents purpose, use/non-use, anatomy, states, placement, wording, accessibility, permission/privacy behavior, component/extension point, examples, anti-patterns, and tests. - [ ] Reconcile Core #227's interface-ethics doctrine, Core #225's admin work, existing layout principles, and the UI/UX decision ledger into one pattern language. - [ ] Core owns reusable primitives/contracts; modules own domain composition and do not import sibling-private components. - [ ] Docs #15 renders pattern/reference topics and stable route/field/blocker help. - [ ] Campaign audits every surface and maps deviations to existing/new Campaign or Core issues. - [ ] Campaign #59, #62, #63, #65, #73, and #35 are concrete pilot cases for details, async progress, review interventions, filtering, stable previews, and guided entry. - [ ] Extract a generic Core primitive only after a second consumer or clear cross-module contract exists. - [ ] Shared behavior/accessibility tests cover critical patterns; visual regression supplements rather than replaces behavioral contracts. - [ ] Each module gets a bounded migration plan and a rollout matrix with current/target pattern, owner, issue, status, and verification evidence. - [ ] Definition of done for changed surfaces includes the applicable pattern, accessibility, privacy, permissions, consequences, provenance, async/error behavior, and docs. ## Initial Slices 1. Whole-system route/surface/component inventory. 2. Pattern taxonomy and reconciliation of doctrine, ledger, and layout docs. 3. Campaign UX architecture review and issue map. 4. Campaign pilot: build/review/intervention, preview/detail, and send-progress surfaces. 5. Extract proven Core primitives with behavior/accessibility tests. 6. Seed live pattern/reference documentation through Docs #15. 7. Prioritized per-module migration program. ## View Composition Principle A focused view is one pattern in this language: it composes only the modules, navigation, and actions relevant to the current task while preserving an obvious escape to the broader system. Activation may later come from workflow step, role/user default, manual switching, or another policy source; those activation semantics remain separate from this design-system program.
zemion commented 2026-07-20 15:29:50 +02:00
Author
Owner
Copy Link
Copy Source

The first interface-program slice now exists locally:

  • docs/INTERFACE_PATTERN_LANGUAGE.md
  • docs/INTERFACE_SURFACE_INVENTORY.md
  • cross-links from docs/FRONTEND_LAYOUT_PRINCIPLES.md

The language covers surface archetypes, placement/visual/wording grammar, state and consequence/provenance contracts, focused views, accessibility/responsive behavior, ownership, tests, and definition of done. The inventory distinguishes tracked baseline from local WIP and maps the Campaign-first rollout. Workflow remains postponed and is not a prerequisite for focused views.

The first Campaign pilot (#59/#73) also passes its focused regression test, structural i18n audit, and Campaign-only production build. This program remains open for integration and the remaining per-surface rollout.

<!-- codex-progress-interface-language-2026-07-20 --> The first interface-program slice now exists locally: - `docs/INTERFACE_PATTERN_LANGUAGE.md` - `docs/INTERFACE_SURFACE_INVENTORY.md` - cross-links from `docs/FRONTEND_LAYOUT_PRINCIPLES.md` The language covers surface archetypes, placement/visual/wording grammar, state and consequence/provenance contracts, focused views, accessibility/responsive behavior, ownership, tests, and definition of done. The inventory distinguishes tracked baseline from local WIP and maps the Campaign-first rollout. Workflow remains postponed and is not a prerequisite for focused views. The first Campaign pilot (#59/#73) also passes its focused regression test, structural i18n audit, and Campaign-only production build. This program remains open for integration and the remaining per-surface rollout.
zemion commented 2026-07-30 17:46:46 +02:00
Author
Owner
Copy Link
Copy Source

Platform-control and visual-language groundwork pushed in meta c9fcdc9, Core f0898fc, Access e8ea347, and Workflow c505e81.

The new source-derived inventory extracts UI fields, help candidates, labels/translations, routes, frontend API references, module surfaces, and backend endpoints. docs/PLATFORM_CONTROL_PLANE.md defines the boundary for a self-describing platform without granting a meta-layer arbitrary authorization bypass. The admin tree and Workflow stage rail are concrete pattern-language slices. Canonical declarations/CI are tracked in #25 and endpoint reachability classification in #26.

Platform-control and visual-language groundwork pushed in meta `c9fcdc9`, Core `f0898fc`, Access `e8ea347`, and Workflow `c505e81`. The new source-derived inventory extracts UI fields, help candidates, labels/translations, routes, frontend API references, module surfaces, and backend endpoints. `docs/PLATFORM_CONTROL_PLANE.md` defines the boundary for a self-describing platform without granting a meta-layer arbitrary authorization bypass. The admin tree and Workflow stage rail are concrete pattern-language slices. Canonical declarations/CI are tracked in #25 and endpoint reachability classification in #26.
zemion commented 2026-08-03 08:46:33 +02:00
Author
Owner
Copy Link
Copy Source

Codex State: progress

Summary

  • Refreshed the durable rollout ledger at meta commit 935c1fe from the generated 65-module/40-route/1,156-field/836-endpoint inventory.
  • Created 33 bounded module migration issues; Campaign #74 and completed Docs #15 cover the other WebUI contributors.
  • Implemented the first post-pilot slices in Scheduling 3d8272b and Admin 6dbccd5 using the shared lifecycle, actionable blocker, and contextual-help contracts.

Verification

  • tools/checks/check-focused.sh passed with 46 module permutations and full-product bundle budgets before the new bounded module slices.
  • Scheduling and Admin targeted model/structure/backend/type/i18n/manifest checks passed.

Next / Blocked

  • Keep open until Campaign #74 receives its manual accessibility/responsive evidence and the per-module issues record their own completion evidence.

Suggested status label: status/in-progress

## Codex State: progress ### Summary - Refreshed the durable rollout ledger at meta commit 935c1fe from the generated 65-module/40-route/1,156-field/836-endpoint inventory. - Created 33 bounded module migration issues; Campaign #74 and completed Docs #15 cover the other WebUI contributors. - Implemented the first post-pilot slices in Scheduling 3d8272b and Admin 6dbccd5 using the shared lifecycle, actionable blocker, and contextual-help contracts. ### Verification - `tools/checks/check-focused.sh passed with 46 module permutations and full-product bundle budgets before the new bounded module slices.` - `Scheduling and Admin targeted model/structure/backend/type/i18n/manifest checks passed.` ### Next / Blocked - Keep open until Campaign #74 receives its manual accessibility/responsive evidence and the per-module issues record their own completion evidence. Suggested status label: `status/in-progress`
zemion commented 2026-08-04 00:04:41 +02:00
Author
Owner
Copy Link
Copy Source

Codex State: done

Summary

  • Completed the whole-system interface pattern-language program and canonical rollout ledger.
  • All 33 bounded module-owned migration issues are now closed; Campaign #74 and Campaign #38 are complete, and Docs/Core shared contracts remain the platform implementation baseline.
  • The final Workflow, Search, Reporting, Projects, and Portal surfaces now record their archetype, states, authority/consequence behavior, optional-module boundaries, contextual documentation, and focused regression evidence.

Changed Files

  • docs/INTERFACE_SURFACE_INVENTORY.md
  • govoplan-workflow/docs/INTERFACE_PATTERN_MIGRATION.md
  • govoplan-search/docs/INTERFACE_PATTERN_MIGRATION.md
  • govoplan-reporting/docs/INTERFACE_PATTERN_MIGRATION.md
  • govoplan-projects/docs/INTERFACE_PATTERN_MIGRATION.md
  • govoplan-portal/docs/INTERFACE_PATTERN_MIGRATION.md
  • govoplan-core/docs/UI_UX_DECISION_LEDGER.md

Verification

  • 48 Core module permutations and full-product bundle budgets passed.
  • Final default full-product production build, structural localization/theme/interface checks, and 65/65 manifest shapes passed.
  • Final five module backend and interface-pattern suites passed; Campaign browser/accessibility closure evidence passed.

Next / Blocked

  • Complete locally and pending the next multi-repository push. New modules must satisfy the standing pattern-language definition of done; GovOPlaN #25 remains independent control-plane hardening.
## Codex State: done ### Summary - Completed the whole-system interface pattern-language program and canonical rollout ledger. - All 33 bounded module-owned migration issues are now closed; Campaign #74 and Campaign #38 are complete, and Docs/Core shared contracts remain the platform implementation baseline. - The final Workflow, Search, Reporting, Projects, and Portal surfaces now record their archetype, states, authority/consequence behavior, optional-module boundaries, contextual documentation, and focused regression evidence. ### Changed Files - `docs/INTERFACE_SURFACE_INVENTORY.md` - `govoplan-workflow/docs/INTERFACE_PATTERN_MIGRATION.md` - `govoplan-search/docs/INTERFACE_PATTERN_MIGRATION.md` - `govoplan-reporting/docs/INTERFACE_PATTERN_MIGRATION.md` - `govoplan-projects/docs/INTERFACE_PATTERN_MIGRATION.md` - `govoplan-portal/docs/INTERFACE_PATTERN_MIGRATION.md` - `govoplan-core/docs/UI_UX_DECISION_LEDGER.md` ### Verification - `48 Core module permutations and full-product bundle budgets passed.` - `Final default full-product production build, structural localization/theme/interface checks, and 65/65 manifest shapes passed.` - `Final five module backend and interface-pattern suites passed; Campaign browser/accessibility closure evidence passed.` ### Next / Blocked - Complete locally and pending the next multi-repository push. New modules must satisfy the standing pattern-language definition of done; GovOPlaN #25 remains independent control-plane hardening.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
HTTP API contracts, routers, schemas, or API smoke behavior.
 area/auth
Authentication, sessions, access bootstrap, or login behavior.
 area/db
Database sessions, models, transactions, or persistence primitives.
 area/devex
Local developer workflow, scripts, tests, tooling, or release helpers.
 area/docs
Durable documentation and project guidance.
 area/governance
Governance policy, audit, privacy, retention, or compliance behavior.
 area/marketing
Public website, product messaging, publication copy, or legal page content.
 area/migrations
Alembic migrations, schema bootstrap, or persistence evolution.
 area/module-system
Module discovery, manifests, capabilities, routing, or optional integrations.
 area/rbac
Permissions, roles, delegation, or authorization policy.
 area/release
Versioning, release locks, tags, packaging, or dependency pins.
 area/security
Security posture, static analysis, supply-chain hardening, or vulnerability remediation.
 area/tenancy
Tenant boundaries, provisioning, or tenant-scoped data behavior.
 area/webui
Shared WebUI shell, frontend components, routing, or frontend tests.
 audit/complexity
Complexity finding from Radon, Xenon, or equivalent maintainability scans.
 audit/duplication
Duplicated-code finding from jscpd or equivalent similarity scans.
 audit/false-positive
Audit finding reviewed as a narrow false positive or acceptable risk.
 audit/needs-design
Audit finding that needs an architectural or product decision before implementation.
 audit/quick-fix
Audit finding that appears narrow and directly fixable.
 audit/structural
Audit finding that needs design, refactoring, or behavior review.
 codex/needs-human
Needs an explicit human decision before Codex should implement.
 codex/ready
Suitable for Codex to pick up with the existing issue context.
 module/access
GovOPlaN access, identity, authentication, RBAC, and administration behavior.
 module/addresses
GovOPlaN Addresses module behavior or integration.
 module/admin
GovOPlaN Admin module behavior or integration.
 module/appointments
GovOPlaN Appointments module behavior or integration.
 module/approvals
GovOPlaN Approvals module behavior or integration.
 module/audit
GovOPlaN Audit module behavior or integration.
 module/calendar
GovOPlaN Calendar module behavior or integration.
 module/campaign
GovOPlaN campaign module behavior or integration.
 module/cases
GovOPlaN Cases module behavior or integration.
 module/committee
GovOPlaN Committee module behavior or integration.
 module/connectors
GovOPlaN Connectors module behavior or integration.
 module/core
GovOPlaN core runner, shared primitives, shell, or extension points.
 module/dashboard
GovOPlaN Dashboard module behavior or integration.
 module/dataflow
GovOPlaN Dataflow module behavior or integration.
 module/datasources
GovOPlaN governed datasource contracts, catalogs, and integrations.
 module/decisions
GovOPlaN formal Decisions module behavior or integration.
 module/dist-lists
GovOPlaN Distribution Lists module behavior or integration.
 module/dms
GovOPlaN Dms module behavior or integration.
 module/docs
GovOPlaN Docs module behavior or integration.
 module/encryption
GovOPlaN Encryption key custody, cryptographic policy, and E2EE integration.
 module/erp
GovOPlaN Erp module behavior or integration.
 module/evaluation
GovOPlaN Evaluation module behavior or integration.
 module/files
GovOPlaN files module behavior or integration.
 module/fit-connect
GovOPlaN Fit Connect module behavior or integration.
 module/forms
GovOPlaN Forms module behavior or integration.
 module/forms-runtime
GovOPlaN Forms Runtime module behavior or integration.
 module/helpdesk
GovOPlaN Helpdesk module behavior or integration.
 module/identity
GovOPlaN Identity module behavior or integration.
 module/identity-trust
GovOPlaN Identity Trust module behavior or integration.
 module/idm
GovOPlaN Idm module behavior or integration.
 module/ledger
GovOPlaN Ledger module behavior or integration.
 module/mail
GovOPlaN mail module behavior or integration.
 module/mandates
GovOPlaN Mandates, jurisdiction, responsibility, and authority behavior or integration.
 module/notifications
GovOPlaN Notifications module behavior or integration.
 module/ops
GovOPlaN Ops module behavior or integration.
 module/organizations
GovOPlaN Organizations module behavior or integration.
 module/parties
GovOPlaN procedure Parties, representation, and delivery-authority behavior or integration.
 module/payments
GovOPlaN Payments module behavior or integration.
 module/permits
GovOPlaN Permits module behavior or integration.
 module/policy
GovOPlaN Policy module behavior or integration.
 module/poll
GovOPlaN Poll module behavior or integration.
 module/portal
GovOPlaN Portal module behavior or integration.
 module/postbox
GovOPlaN Postbox module behavior or integration.
 module/projects
GovOPlaN Projects module behavior or integration.
 module/quick-access
GovOPlaN configurable task-local Quick Access behavior and integrations.
 module/records
GovOPlaN Records and eAkte lifecycle behavior or integration.
 module/reporting
GovOPlaN Reporting module behavior or integration.
 module/risk-compliance
GovOPlaN Risk Compliance module behavior or integration.
 module/scheduling
GovOPlaN Scheduling module behavior or integration.
 module/search
GovOPlaN Search module behavior or integration.
 module/services
GovOPlaN versioned institutional Services behavior or integration.
 module/tasks
GovOPlaN Tasks module behavior or integration.
 module/templates
GovOPlaN Templates module behavior or integration.
 module/tenancy
GovOPlaN Tenancy module behavior or integration.
 module/tickets
GovOPlaN Tickets module behavior or integration.
 module/views
GovOPlaN governed task views, interface projections, and workflow view integration.
 module/voting
GovOPlaN Voting module behavior or integration.
 module/wiki
GovOPlaN Wiki module behavior or integration.
 module/workflow
GovOPlaN Workflow module behavior or integration.
 module/workflow-engine
GovOPlaN Workflow Engine runtime, persistence, or integration.
 module/xoev
GovOPlaN Xoev module behavior or integration.
 module/xrechnung
GovOPlaN Xrechnung module behavior or integration.
 module/xta-osci
GovOPlaN Xta Osci module behavior or integration.
priority
p0
Immediate stop-the-line priority.
priority
p1
High priority for the next focused work window.
priority
p2
Normal planned priority.
priority
p3
Low priority or opportunistic cleanup.
source/backlog-import
Imported from markdown backlog, roadmap, plan, or TODO files.
 source/security-audit
Created from a structured security or code-quality audit report.
 source/todo-scan
Imported from inline TODO/FIXME/HACK markers by the Gitea TODO importer.
status
blocked
Cannot progress without a decision, dependency, credential, or external change.
status
in-progress
Currently being worked.
status
needs-info
Needs clarifying input before implementation can proceed safely.
status
ready
Ready for implementation.
status
triage
Needs review, ownership, priority, or acceptance criteria.
type
bug
A reproducible defect, regression, or incorrect behavior.
type
debt
Cleanup, refactoring, risk reduction, or deferred engineering work.
type
docs
Documentation, process, or developer workflow work.
type
feature
New user-visible behavior or platform capability.
type
task
Implementation, maintenance, migration, or operational work.
type
user-story
End-to-end user journey or real-world process story used to steer product slices.
No labels area/webui codex/ready module/core
priority
p1
status
ready
type
user-story
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
govoplan-package-publisher zemion (Albrecht Degering)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: GovOPlaN/govoplan#11