Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/ui-ux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,26 @@ These reference screens define the intended product direction for Cloud ERD UI w
- Modals should be centered, restrained, and form-first.
- The ERD editor should prioritize canvas space, toolbars, side properties, sharing, and export workflows.

Execution planning:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HIGH OpenCode could not establish approval sufficiency

  • Problem: the model pool exhausted without a valid current-head review control block, so this changed line cannot be approved from deterministic check state alone.
  • Impact: PR-intent mismatches, missing files, robustness bugs, UX/DX regressions, and CodeGraph-backed flow changes could be missed.
  • Fix: rerun OpenCode after model availability recovers, or add the missing source/test/docs/generated verification evidence needed for a source-backed approval.
  • Verification: rerun the OpenCode Review workflow and confirm it emits APPROVE or source-backed REQUEST_CHANGES for this head SHA.


- [Product Design and Figma execution plan](product-design-figma-execution-plan.md)
- [Product Design UX audit](product-design-audit.md)
- [Design QA checklist](design-qa-checklist.md)
- [Core user flow Mermaid source](core-user-flow.mmd)
- [Product Design Kit Figma file](https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si)
with the nine screenshots placed on `01 Current References`, local variables
on `02 Foundations`, component sets on `03 Components`, and a desktop core
flow prototype on `04 Core Flow Prototype`
- [Core user flow FigJam board](https://www.figma.com/board/kHs1cKzwGzkNIBNaMt0xVq?utm_source=codex&utm_content=edit_in_figjam&oai_id=&request_id=b079e329-893d-4418-8909-b22a816fa588)

Current Figma implementation anchors:

- [Foundations](https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=17-2)
- [ERD table node variants](https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=25-78)
- [Toolbar button variants](https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=28-33)
- [Share/export modal states](https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=29-143)
- [Core flow prototype](https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=32-2)

Screens:

1. `01-login-screen.png`
Expand Down
69 changes: 69 additions & 0 deletions docs/ui-ux/core-user-flow.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
flowchart LR
start(["Signed-in workspace"])

subgraph intake ["Workspace setup"]
dashboard["Dashboard overview"]
project{ "Project exists?" }
createProject["Create project"]
selectProject["Select project"]
connection{ "Connection exists?" }
createConnection["Save PostgreSQL or Snowflake DSN"]
schemaFilter["Set optional schema filter"]
end

subgraph snapshotPhase ["Reverse engineering"]
createSnapshot["Create schema snapshot"]
snapshotStatus{ "Snapshot status" }
retrySnapshot["Fix DSN or retry"]
snapshotReady["Snapshot succeeded"]
end

subgraph editorPhase ["ERD editor"]
renderErd["Render React Flow ERD"]
searchTables["Search tables and columns"]
autoLayout["Auto-layout canvas"]
editTables["Add or edit tables"]
editRelations["Edit relationships"]
groupTables["Assign business groups"]
cardinality["Review cardinality recommendations"]
end

subgraph handoffPhase ["Share and export"]
openExport["Open share/export modal"]
shareLink["Create share link"]
ddlExport["Copy SQL DDL"]
diagramExport["Download SVG, PlantUML, or Mermaid"]
teammate["Teammate reviews shared ERD"]
end

start --> dashboard
dashboard --> project
project -->|"No"| createProject
project -->|"Yes"| selectProject
createProject --> selectProject
selectProject --> connection
connection -->|"No"| createConnection
connection -->|"Yes"| schemaFilter
createConnection --> schemaFilter
schemaFilter --> createSnapshot
createSnapshot --> snapshotStatus
snapshotStatus -->|"Failed"| retrySnapshot
retrySnapshot --> createConnection
snapshotStatus -->|"Succeeded"| snapshotReady
snapshotReady --> renderErd
renderErd --> searchTables
renderErd --> autoLayout
renderErd --> editTables
renderErd --> editRelations
renderErd --> groupTables
renderErd --> cardinality
searchTables & autoLayout & editTables & editRelations & groupTables & cardinality --> openExport
openExport --> shareLink
openExport --> ddlExport
openExport --> diagramExport
shareLink --> teammate

style intake fill:#E8F2FF,stroke:#3D7DD8
style snapshotPhase fill:#FFF2D8,stroke:#D99A20
style editorPhase fill:#EAF7EA,stroke:#3A9B4A
style handoffPhase fill:#F1E8FF,stroke:#7B61D1
158 changes: 158 additions & 0 deletions docs/ui-ux/design-qa-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# Design QA Checklist

Use this checklist before implementing or merging UI changes derived from the
Product Design and Figma work. It is not a final QA report by itself; a passing
QA decision requires side-by-side evidence from both a source visual target and a
rendered implementation.

## Required Evidence

- Source visual target:
- Figma design node, FigJam flow board, screenshot, mockup, or `docs/ui-ux`
reference PNG.
- Record the URL or file path.
- Rendered implementation:
- Local or deployed app screenshot of the same state.
- Record the URL, viewport, browser, and screenshot file path.
- Same-state match:
- Same route or workspace view.
- Same selected project/diagram state.
- Same modal open/closed state.
- Same data density where possible.
- Same viewport class: desktop editor, narrow review layout, or modal-focused
capture.

## Current Figma Baseline

Use these source nodes for the first implementation comparison pass:

- Component foundations:
<https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=17-2>
- ERD table node density variants:
<https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=25-78>
- Editor toolbar button variants:
<https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=28-33>
- Share/export modal states:
<https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=29-143>
- Core flow prototype dashboard:
<https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=32-2>

The Figma component and prototype screenshots were checked for clipped text and
overlap during the design pass. A code implementation still requires a separate
browser screenshot comparison before merge.

## Required Screens

Run the QA pass on these screens before broad UI implementation:

1. Auth gate or signed-in entry.
2. Dashboard with recent projects and diagrams.
3. Project list with empty and populated states.
4. Diagram list with empty, running, succeeded, and failed statuses when
available.
5. First-run setup path for project, connection, DSN, schema filter, and
snapshot creation.
6. ERD editor with at least four tables, relationships, minimap, toolbar, and
search.
7. ERD editor empty state and snapshot-running state.
8. Table node stress state with long names, comments, examples, PK/FK badges,
NOT NULL badges, indexes, and business group badge.
9. Add/edit table modal.
10. Relationship settings modal.
11. Business group modal.
12. Cardinality recommendation modal.
13. Share/export modal with no project, loading, success, copy-feedback, error,
and no-DDL states.
14. Narrow viewport review/share state.

## Fidelity Surfaces

### Fonts and Typography

- Product font family follows the source target and implementation CSS.
- Heading, body, table, caption, badge, and monospace export text sizes are
visually consistent.
- Line heights do not crop Korean or English text.
- Long schema, table, column, index, and URL values wrap or truncate
intentionally.
- Button and toolbar labels fit their controls at all required viewport widths.

### Spacing and Layout Rhythm

- Sidebar width, padding, and section gaps match the design target.
- Dashboard cards and tables align to the same grid rhythm.
- Toolbar groups do not overlap the canvas, minimap, empty state, or React Flow
controls.
- Modals preserve header, section, form, and action spacing at desktop and narrow
widths.
- Table node density remains scannable with high metadata volume.

### Colors and Visual Tokens

- Primary blue, active states, focus ring, borders, neutral text, status colors,
and modal shadows map to named Figma variables or CSS custom properties.
- Disabled states remain legible and distinguishable from active controls.
- Status pills communicate succeeded, failed, running, and not-found states
without relying on color alone.
- Business group colors remain distinguishable against table-node backgrounds.

### Image and Asset Fidelity

- Use real source screenshots, Figma captures, product icons, or an approved icon
library.
- Do not replace product-relevant icons or screenshots with placeholder boxes,
CSS drawings, text glyphs, or handcrafted approximations.
- ERD canvas captures must show real table-node content, relationship lines, and
controls rather than blank canvas placeholders.

### Copy and Content

- Korean and English labels use one consistent product voice per surface.
- Toolbar, modal, and disabled-state copy explains the next action.
- Share/export copy distinguishes project share links from DDL text and diagram
file exports.
- DSN and schema-filter hints are explicit about PostgreSQL and Snowflake.
- Error states say what failed and what the user can try next.

## Accessibility Checks

- Keyboard can reach every visible control in a logical order.
- Skip link lands on the main workspace.
- Focus ring is visible against all backgrounds.
- Dialogs trap focus, close on Escape, and return focus to the opener.
- Destructive actions are not adjacent to primary actions without enough visual
separation.
- `aria-live` regions announce snapshot, copy, loading, and search-result
changes without excessive noise.
- Icon-only toolbar actions have accessible names and visible tooltips.
- Tables and table-like rows expose useful structure to assistive tech.

## QA Report Format

Save each implementation QA pass as `docs/ui-ux/design-qa-report.md` or as a
dated file under `docs/ui-ux/qa/`.

Required fields:

- Source visual truth path or Figma node URL.
- Implementation URL and screenshot path.
- Viewport and state.
- Full-view comparison evidence.
- Focused-region comparison evidence for toolbar, table node, and modal details,
or a reason focused regions were not needed.
- Findings ordered by severity.
- Fix checklist.
- Final result: `passed` or `blocked`.

Use `passed` only when no actionable P0, P1, or P2 findings remain. P3 polish
can remain as follow-up. Use `blocked` when any actionable P0, P1, or P2 finding
remains.

## First QA Target

Start with the share/export modal because it is the recommended first
implementation surface from `product-design-audit.md` and has a clear existing
reference in `09-share-export-modal.png`.

First source target:
<https://www.figma.com/design/OTN0rBGtnVy0P7yq4Iv9Si?node-id=29-143>
Loading