SPB Git

Repository Public

brand-guidelines.md 8.1 KB 125 lines markdown

1# Brand guidelines23How the ORIX family identity is applied in ORIX Sheet. The repository contains no family-wide brand4book; the rules below are the ones that can be read from this project's sources, artwork generators5and research notes. Where a rule is a convention observed in the code rather than a written6decision, it is labelled as such.78Related: [design system](design-system.md) (tokens and components), [icon design](icon-design.md),9[localization](../development/localization.md), [accessibility](../development/accessibility.md).1011## The family, as recorded in this repository1213`docs/research/technology-evaluation.md` (environment audit) lists the sibling apps present on the14build machine: ORIX Scan, Calc, Audio (iOS), ORIX Monitor, Clean, Secure and Camera (in progress),15and states two facts that shape the brand work here:16171. **Each app ships its own design tokens.** There is no shared runtime package.182. **The shared palette is reused**: navy canvas, cyan accent `#0891B2` (light) / `#22D3EE` (dark),19   indigo secondary.2021ORIX Sheet follows both: its tokens live in `Packages/SheetUI/Sources/SheetUI/Design/Tokens.swift`22and its icon uses the same navy plate and cyan-to-indigo gradient (see [icon design](icon-design.md)).23This project did not inspect the sibling apps' sources; consistency with them rests on the palette24values quoted above, not on a side-by-side comparison.2526## Principles as applied here2728| Principle | How it shows in ORIX Sheet | Where it is implemented or recorded |29|---|---|---|30| Local first | No account, no analytics; the About/Settings text says so and the copyright line reads "ORIX Sheet works entirely on this Mac." | `App/Sources/AppSettings.swift`, `App/Sources/Welcome.swift`, `NSHumanReadableCopyright` in `App/Resources/Info.plist`; verification of the network claim is in [security.md](../security.md) |31| Honest about limits | Foreign formats are imported, never silently overwritten; exports show a report of what the format cannot hold | `App/Sources/WorkbookDocument.swift`, `App/Sources/CompatibilityReport.swift`; see [persistence](../architecture/persistence.md) |32| No comparative claims | "No performance claim against a competitor is made anywhere in this project: we publish only our own measurements." | `docs/research/competitive-analysis.md` |33| Native, dense, calm | One toolbar and contextual inspectors instead of a ribbon; 4-pt spacing grid; one animation in the shared UI | `WorkbookView.swift`, `Tokens.swift`; see [design system](design-system.md) |34| Accessible by construction | Contrast of every token pair is a unit test; state is never carried by colour alone when the user asks for it | `ContrastTests`, `ToolButton`; see [accessibility](../development/accessibility.md) |3536Source: the files named in the right-hand column.3738## Naming3940- **Product name:** "ORIX Sheet" — two words, ORIX in capitals, a space, never "OrixSheet" or41  "ORIX Sheets" in user-facing text. It is the value of `CFBundleName`, `CFBundleDisplayName` and42  `PRODUCT_NAME`.43- **Identifiers** drop the space: module `ORIXSheet`, bundle identifier `ai.spboucher.orix.sheet`,44  document type `ai.spboucher.orix.sheet.workbook`, file extension `.orixsheet`, artifacts45  `ORIXSheet-<version>.dmg` / `.zip`.46- **Document noun:** "ORIX Sheet Workbook" (`CFBundleTypeName`), "ORIX workbook" in running text47  ("classeur ORIX" in French).48- **Feature names** found in the sources: Python Studio, Data Studio, Figure Studio, Model Auditor,49  ORIX Transform, ORIX Intelligence. The "ORIX" prefix is used for the two features that are50  engines of their own (Transform, Intelligence); the others are plain descriptive names.51- **Names stay in English in every language.** localization.md lists ORIX Sheet, Python Studio,52  ORIX Transform and ORIX Intelligence as untranslated product names. Function names (`SUM`, `IF`)53  also stay in English because formulas are stored in one locale-independent form.54- **Namespaces in code:** design tokens under `ORIX.` (`ORIX.Palette`, `ORIX.Space`, …); shared55  components carry the prefix only when the bare name would be too generic (`ORIXCard`).5657## Tagline5859"Beyond Spreadsheets." appears in exactly one place: the DMG window background drawn by60`design/dmg/make-background.swift` (26 pt medium, cyan). It is not shown inside the application61(`grep -r "Beyond Spreadsheets"` over the Swift sources and string catalogs finds no other use on622026-11-21). Treat it as packaging artwork; if it is ever used elsewhere it needs a French version,63which does not exist yet.6465## Tone of UI text6667Conventions observed in the string catalogs (`Scripts/translations/*.json`, the English keys are68the source text):6970- **Say what happened and what it means for the user's file.** Example (export preflight): "This71  format cannot hold everything in the workbook. Review what will change before exporting; your72  ORIX workbook is not modified."73- **State guarantees in the indicative, without marketing adjectives.** Example: "This workbook74  contains VBA macros. ORIX Sheet never runs macros; they are kept only if you export as .xlsm."75- **Name menu paths with the ▸ separator**: "File ▸ Export To".76- **Sentence case** for labels and menu titles; `SectionHeader` upper-cases its text at display time,77  so keys are written in normal case.78- **Undo names are short nouns or verbs** ("Paste", "Bold", "Page Setup") because macOS prefixes79  them with "Undo"/"Annuler".80- **French is Canadian French (`fr-CA`)** with Québec typography applied by `Scripts/localize.py`:81  no-break space before « : » and inside guillemets, no space before « ; », « ? » and « ! », real82  ellipsis and apostrophes. Translators type ordinary spaces; the script fixes them.83- **Status over decoration:** errors and "no result" messages are also posted as accessibility84  announcements, so the text has to stand on its own without colour or icon.8586Known inconsistencies, recorded in localization.md and not hidden here: function summaries, formula87parse errors and compatibility-issue texts are still English-only, because they come from packages88outside the two localized catalogs.8990## Visual identity9192- **Colour:** cyan accent on navy/near-white surfaces, indigo as the only secondary. Semantic93  colours (success, warning, danger) are reserved for state. Exact values and the measured contrast94  are in the [design system](design-system.md).95- **Gradient:** the brand gradient cyan `#22D3EE` → blue `#3B9BF5` → indigo `#6366F1`, drawn from96  top-left to bottom-right, exists only in the icon artwork (`brand()` in97  `design/icon/make-icons.swift`). The application chrome uses flat token colours; no gradient98  token exists in `Tokens.swift`.99- **Plate:** the navy icon plate (`#1B2A4A` → `#0B0F1E` with a soft teal glow) is shared by the icon100  and, in a wider form (`#16233F` → `#0B0F1E`), by the DMG background.101- **Typeface:** the system font only. No custom typeface is bundled.102- **Symbols:** SF Symbols for all interface icons.103104## What to avoid105106Each item is the negative of a rule that the code or the documents enforce:107108- Using `accent` as a text colour or under white text in light mode (fails 4.5:1; use `accentText`109  / `accentFill`).110- Carrying an on/off state by colour alone.111- Claims of superiority over another product, or numbers that were not measured in this repository.112- Words such as "cloud", "sync" or "account" in UI text: the features do not exist.113- Translating product or function names; hand-editing the generated `.xcstrings` catalogs.114- A second accent hue, decorative gradients in the chrome, or animations that do not go through115  `ORIX.Motion.respecting`.116- Hard-coded hex colours in feature panels instead of tokens. A count on 2026-11-21 finds one117  `Color(hex:)`/`Color(red:)` literal across `Packages/Feature*/Sources`; chart series colours are a118  separate, documented palette (see [chart engine](../architecture/chart-engine.md)).119120## Not defined anywhere in the repository121122- A logo lock-up or wordmark other than the app icon and the text "ORIX Sheet" set in the system font.123- Rules for the icon on coloured backgrounds, minimum clear space, or monochrome variants.124- A written family brand book; licence or trademark statements for the ORIX name.125
Files main
Menu

Theme