Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 775 Bytes

DESIGN.md

File metadata and controls

32 lines (19 loc) · 775 Bytes

Design guidelines

Guidelines for UI design, covering GUI, CLI, documentation, log messages, etc

Text

Sentences

Short, single-sentence text do NOT end in a period in the UI.

Multi-sentence text ALWAYS ends in a period.

Casing

We prefer normal casing, and avoid Title Casing.

We only use Title Casing for company and product names (Rerun, Rerun Viewer, Discord, …), but NOT for concepts like “container”, “view”, etc.

Examples

Good: log("File saved")

Bad: log("file saved.")

Buttons

When a button action requires more input after pressing, suffix it with .

Good: Save recording… (leads to a save-dialog)

GUI labels

We do not use a colon suffix for labels in front of a value.

Good: Color 🔴

Bad: Color: 🔴