Skip to content

glossary.md

Latest commit

 

History

History
28 lines (18 loc) · 3.59 KB

glossary.md

File metadata and controls

28 lines (18 loc) · 3.59 KB
Raw

Glossary and naming

The authoritative names are English — used in code, tests and all documentation (AGENTS.md rule 12). Norwegian appears only as the user-facing UI labels the app ships in nb. This file pins the domain vocabulary so names don't drift; quote the Norwegian label in double quotes when it matters, never as a code identifier.

Domain entities

  • Station — a rotation post in an exercise; rotation math lives in the stationIndex extension. The Norwegian UI label is "post"/"poster". Code, tests, file names and docs always say station(s), never "post".
  • RolePlay — the publishable role a marker enacts (behaviour, background, effective identity). Norwegian UI: "Rolle", and "Markør" for the marker as a whole. Never model it as RolePlayer.
  • Actor — the real person cast to play a RolePlay (enacted by). Carries PII, stored locally, stripped on publish (ADR-0018, ADR-0047). "Spilles av {actor}" / "played by {actor}" names the Actor, not the role. The Norwegian "Markør" spans the RolePlay+Actor concept in the UI; in code they are separate types.
  • Location — a station-owned scenario place (label, kind, coordinate, note). station.loc.<slug> (ADR-0047, DESIGN-009).
  • Person — a station-owned fictional scenario person (name, age, gender, description, notes, linked location). No PII — the real human is the Actor. station.person.<slug>.
  • Team — a rotating group of participants. Team.name is free text, deliberately: naming conventions are subject-area specific — a Norwegian SAR callsign ("Larvik 21", where the first digit denotes the function and the second the ordinal), a military unit designation and a plain "Lag 3" all fit a name field, and none of them fit a shared scheme. There is therefore no team analogue of ExerciseNumberFormat/StationNumberFormat; Numbering.team renders the bare 1-based ordinal for badges, and the convention, if any, lives in the name the author wrote. Generated fallback names ("Lag N" / "Team N") exist only for teams the author never named.
  • Plan — the model type backing the "Plan" UI tab (PlanScope, PlanVariables, …). Named Plan throughout, matching the UI; it does not change the .drill wire format — the archive root stays program.json (ADR-0007) and JSON keys are unaffected.

Roles / audience

  • BriefAudience — participant / instructor / director (IDs stay English in code). Norwegian labels: participant → "Deltaker", instructor → "Veileder" (not "Instruktør"), director → "Øvelsesleder".

Formats and tooling

  • Source format — the one-YAML-file authoring surface a person or an agent writes, compiled to a .drill by ringdrill build (DESIGN-014, ADR-0058). Norwegian: kildeformat. Not a synonym for the .drill archive: the archive is the build artifact, and the format deliberately cannot express anything derived.
  • Migration ladder / rung — the ordered set of normalizers that bring an older .drill's content up to the shape the current model reads (ADR-0059). A rung is one step of it: one migration, handling one historical shape, named and self-describing (lib/data/drill_migrations.dart). Say "rung" rather than "migration step" — the ordering is real, and "delete the bottom rung" is how a support floor gets raised. A rung may fill an absent field or rename a key; it may never rewrite an authored value.

Surfaces

  • Site — the public website (the Site / PWA / API origin split, ADR-0039). Do not call it "marketing" — that is too narrow.

See also: docs/ui-conventions.md, and the ADRs referenced above.