Namenskonventionen
Gute Namen machen Shortcuts selbsterklärend. Schlechte Namen sorgen dafür, dass sie nicht genutzt werden. Diese Seite beschreibt die technischen Regeln, die Lora durchsetzt, und die Konventionen, die eine wachsende Link-Bibliothek konsistent halten.
Erlaubte Zeichen
Shortcut-Slugs dürfen nur Kleinbuchstaben (a–z), Ziffern (0–9) und Bindestriche (-) zwischen Segmenten enthalten — so wie sie serverseitig geprüft werden (^[a-z0-9]+(?:-[a-z0-9]+)*$ in der Datenbank). Unterstriche sind nicht erlaubt.
- Kleinbuchstaben (a–z)
- Zahlen (0–9)
- Bindestriche (-) als Trenner zwischen Wortteilen (z. B.
urlaub-antrag)
Großbuchstaben werden automatisch in Kleinbuchstaben umgewandelt. Leerzeichen sind nicht erlaubt. Emojis und andere Sonderzeichen werden abgelehnt.
Eindeutigkeit und Schreibweise
Jeder Shortcut hat genau einen gespeicherten Slug-String. Zwei verschiedene gültige Namen — etwa all-hands und allhands — sind zwei verschiedene Shortcuts, wenn beide angelegt werden. Stimmt euch im Team auf eine Schreibweise ab und bleibt dabei. Bindestriche sind die gängigste Konvention, weil sie in URLs üblich und gut lesbar sind.
Länge
Es gibt kein hartes Zeichenlimit, aber kürzere Slugs sind besser. Ein bis drei Wörter sind ein guter Richtwert. Wenn der Name länger wird, lohnt es sich, ihn zu vereinfachen.
Einige Beispiele:
| Statt | Besser |
|---|---|
/urlaubsantrag-formular | /urlaub |
/quarterly-business-review-deck | /qbr |
/engineering-standup-notizen | /standup |
/interne-wissensdatenbank-wiki | /wiki |
Reservierte Slugs
Der Slug /d ist für das Lora-Verzeichnis reserviert und kann nicht für Shortcuts verwendet werden. Alle anderen einstelligen Slugs sind verfügbar.
Sprache
Eine Sprache für alle Shortcuts im Workspace wählen. In internationalen Teams ist Englisch die gängigste Wahl. In Teams, in denen alle dieselbe Sprache sprechen, funktioniert die Landessprache genauso gut.
Sprachen zu mischen (/onboarding neben /einarbeitung neben /new-hire-prozess) stiftet Verwirrung und erschwert das Erraten von Shortcut-Namen.
Präfixe
Für Workspaces mit vielen Shortcuts kann ein leichtes Präfix helfen, Links nach Bereich zu ordnen:
/hr-urlaub,/hr-gehalt,/hr-benefits/it-vpn,/it-passwort,/it-ticket/eng-deploy,/eng-runbook,/eng-oncall
Tiefe Hierarchien wie /hr/recruiting/bewerbung/formular vermeiden. Niemand merkt sich den vollständigen Pfad, und Abteilungsnamen ändern sich.
Wenn ein Begriff allein eindeutig genug ist (/vpn, /roadmap, /wiki), das Präfix weglassen.
Aliase
Wenn ein Shortcut unter mehreren Namen bekannt sein könnte, einen Alias statt eines zweiten Shortcuts anlegen. Der primäre Slug könnte zum Beispiel /urlaub sein, mit /pto und /vacation als Aliase.
Aliase halten die Bibliothek sauber (ein kanonischer Eintrag) und berücksichtigen trotzdem die verschiedenen Begriffe, die Leute verwenden.
Aufräumen
Shortcuts vierteljährlich prüfen. Nach Links suchen, die in den letzten 90 Tagen nicht geklickt wurden, Links, die auf Seiten zeigen, die nicht mehr existieren, und Namen, die sich überschneiden oder in Konflikt stehen. Tote Shortcuts zu entfernen hält die Bibliothek vertrauenswürdig und macht Suchergebnisse nützlicher.