Namenskonventionen
Gute Namen machen Shortcuts selbsterklärend. Schlechte Namen sorgen dafür, dass sie nicht genutzt werden. Beim Erstellen eines Shortcuts trägst du den Shortcut-Namen in das Feld Slug ein. Er wird Teil der Shortcut-URL.
Erlaubte Zeichen
Shortcut-Namen sind 1–50 Zeichen lang. Sie dürfen Kleinbuchstaben (a–z), Ziffern (0–9), Bindestriche und Unterstriche enthalten. Der Name muss mit einem Buchstaben oder einer Ziffer beginnen und enden.
- Kleinbuchstaben (a–z)
- Zahlen (0–9)
- Bindestriche (-) als Trenner zwischen Wortteilen (z. B.
urlaub-antrag) - Unterstriche (_) innerhalb des Slugs
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 Namen. all-hands und allhands sind deshalb zwei verschiedene Shortcuts, wenn du beide anlegst. Einigt euch im Team auf eine Schreibweise und bleibt dabei. Bindestriche sind die gängigste Konvention, weil sie in URLs üblich und gut lesbar sind.
Länge
Das Zeichenlimit liegt bei 50 Zeichen. Kürzere Namen lassen sich leichter merken. Ein bis drei Wörter sind ein guter Richtwert.
Einige Beispiele:
| Statt | Besser |
|---|---|
/urlaubsantrag-formular |
/urlaub |
/quarterly-business-review-deck |
/qbr |
/engineering-standup-notizen |
/standup |
/interne-wissensdatenbank-wiki |
/wiki |
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.
Alternative Namen
Lora unterstützt derzeit keine Aliase. Wenn zwei Namen notwendig sind, lege zwei Shortcuts zum selben Ziel an und dokumentiere, welcher bevorzugt werden soll.
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.