SPB Git

Repository Public

brand-guidelines.md 4.6 KB 69 lines markdown

1<!--2ORIX Docs3File: docs/design/brand-guidelines.md4Description: How the ORIX family traits are embodied in ORIX Docs: plate, ring, accent pair, tone of voice, tagline, do and don't.5Author: Simon-Pierre Boucher6Contact: contact@spboucher.ai7-->8# Brand guidelines910Short and concrete: what makes ORIX Docs recognisably an ORIX application, and where each trait lives in the repository. Tokens and components are in [design-system.md](design-system.md); the icon's history is in [icon-design.md](icon-design.md).1112## Name and tagline1314* Name: **ORIX Docs** — "ORIX" in capitals, "Docs" capitalised, one space. Bundle display name `ORIX Docs` (`project.yml`).15* Tagline: **ORIX Docs — Write Without Limits.** (drawn on the disk-image background by `design/dmg/make-background.swift`)16* Document type: "ORIX Docs Document", extension `.orixdoc`.1718## The three family traits1920| Trait | What it is | Where |21|---|---|---|22| **The plate** | A deep ink rounded square (`#1B1F3B` to `#0B0D1A`) with a soft glow in the top-left corner and a faint light edge. The common ground of every ORIX icon. | `plate(_:glow:)` in `design/icon/make-icon.swift` |23| **The ring** | The ORIX "O": a thick ring with a diagonal gradient (`#8B7BFF` → `#6366F1` → `#4F46E5`), which an application may open or cross with its own subject. In ORIX Docs it opens on the right where the page passes through it. | `ring(_:center:radius:width:gaps:colors:)` |24| **The accent pair** | Each ORIX app brings two colours. ORIX Docs: **ink indigo `#4F46E5`** and **page amber `#F59E0B`**. | Indigo: `ORIX.Palette.accent`, the asset catalogue's `AccentColor`, the default shape stroke, the "ORIX" document theme. Amber: the caret in the icon. |2526<img src="../assets/orix-docs-icon-256.png" width="128" alt="The ORIX Docs icon: an indigo ring on a dark plate, a white page with text lines and an amber caret">2728### The accent pair in the interface2930| | Light appearance | Dark appearance |31|---|---|---|32| Indigo (`accent`) | `#4F46E5` | `#818CF8` |33| Amber (`secondary`) | `#D97706` | `#FBBF24` |3435The brand amber `#F59E0B` is the icon's value. The interface token `secondary` uses a darker amber on light backgrounds and a lighter one on dark backgrounds so that it stays readable as text; it is the same hue family, not a different colour.3637Indigo carries selection and state (selected mode, active toggle, caret, selection tint). Amber is the rare second voice: it marks the writing point in the icon and warnings in the interface (`warning` is `#B45309` / `#FBBF24`). The gradient `#7C74FF` → `#4F46E5` → `#3730A3` is reserved for the three places that say "this is the main thing": the selected mode, a sheet's header badge, a prominent button.3839## Typography4041* Interface: the system font at the sizes of the type ramp; a serif design only for the `display` token.42* Documents: the default "ORIX" theme sets body text in New York and headings in SF Pro Display with the indigo accent (`Theme.orix` in `DocModel/Styles.swift`). Other themes are neutral on purpose and carry no ORIX colour.4344## Tone of voice4546Taken from the strings in the application:4748* **Say what happens, plainly.** "Tables with vertically merged cells cannot be sorted." "The image could not be read." "Comments are not included in the PDF."49* **Name limits before the user meets them.** Export shows what a format cannot carry; the PDF option reads "Conformance to PDF/UA is not claimed."50* **No exclamation marks, no superlatives, no humour in errors.** Empty states explain the next step: "No headings yet. Apply a heading style and the contents will appear here."51* **Menu vocabulary follows macOS**: "Paste and Match Style", "Revert To", "Browse All Versions…", ellipsis on commands that open a sheet.52* **Private by default, and said so**: the reviewer name is "entered by the user; never sent anywhere" (`AppSettings.swift`).5354## Do5556* Use the plate and the ring unmodified when a new ORIX mark is drawn; vary the subject, not the ground.57* Keep indigo for state and selection; let one element per view carry the gradient.58* Leave the page white and the chrome quiet: the document is the content.59* Pair every colour signal with a shape, an icon or a word.60* Write interface text in sentence case for messages and title case for commands, as the existing strings do.6162## Don't6364* Don't recolour the ring or place it on a light plate.65* Don't use amber for large surfaces or as a second selection colour.66* Don't imitate the icons of Microsoft Word or Apple Pages, or borrow a letter mark or pen motif from them: the ORIX Docs mark is the ring with a page.67* Don't add a claim the product cannot back ("accessible PDF", "PDF/A", "fully compatible with Word").68* Don't theme the paper in dark mode.69
Files main
Menu

Theme