Passer au contenu principal

​
Ton und Stimme

Schreiben Sie in einem technischen, direkten und prägnanten Stil und bleiben Sie dabei zugänglich. Geben Sie Klarheit Vorrang vor Formalität.
  • Verwenden Sie die aktive Stimme und die zweite Person („Sie“).
  • Halten Sie die Sätze kurz – eine Idee pro Satz
  • Gehen Sie mit dem Ziel voran und geben Sie dann Anweisungen
  • Vermeiden Sie unnötige Füllwörter
  • Keine Absicherung – seien Sie selbstbewusst und direkt
  • Keine Marketingsprache – Dokumente informieren, sie verkaufen nicht

​
Sprachattribute

Die Dokumentationsstimme von Primo ist immer klar, souverän, strukturiert, handlungsorientiert und professionell.
AttributMittelBedeutet NICHT
KlarKlare Sprache, eine Idee pro Satz, keine MehrdeutigkeitVerdummt oder herablassend
SelbstbewusstDirekte Aussagen, keine Absicherung oder EntschuldigungArrogant oder aufdringlich
StrukturiertOrganisiert, scanbar, logischStarr oder robotisch
AktionsorientiertFührt den Benutzer zu den nächsten SchrittenKommandierend oder aggressiv
ProfessionellRespektiert IT-Fachwissen und verwendet die korrekte TerminologieVollgestopft mit Unternehmensjargon

​
Toneinstellungen

Help-Center-Artikel verwenden mittlere Formalität, mittlere Energie und hohe technische Tiefe. Schreiben Sie professionell, aber gesprächig, in einem gleichmäßigen Tempo und verwenden Sie die Fachterminologie frei – Leser sind IT-Profis.

​
Sprachkonventionen

​
Terminologie

Verwenden Sie immer exakte Begriffe aus dem Glossar. Ersetzen Sie Glossarbegriffe niemals durch Synonyme.
BenutzenVermeiden
HR-SystemHRIS
das Armaturenbrettin Primo bis Primo
GeräteverwaltungMDM (bei der ersten Verwendung, buchstabieren)
GerätMaschine, Computer
einschreibenregistrieren, hinzufügen
zero-touch-Bereitstellungautomatische Einrichtung
Onboarding/OffboardingAd-hoc-Alternativen

​
Produktreferenzen

Erwähnungen von „in Primo“ oder „bis Primo“ minimieren. Geben Sie den Produktnamen nur an, wenn:
  • Unterscheidung von Primo von einem anderen System
  • Erste urkundliche Erwähnung
  • Ohne sie wäre der Kontext unklar
Vermeiden Sie: „Navigieren Sie zu Primo und klicken Sie auf Einstellungen“
Bevorzugen: „Zu Einstellungen navigieren“ Vermeiden: „Mitarbeiter nach Primo importieren“
Bevorzugen: „Mitarbeiter importieren“

​
Akronyme

Buchstabieren Sie Akronyme bei der ersten Verwendung, gefolgt von der Abkürzung in Klammern. Benutzen Sie bei späteren Erwähnungen die Abkürzung. Beispiel: Mobile Device Management (MDM) ermöglicht die Remote-Konfiguration. MDM-Richtlinien steuern Geräteeinstellungen.

​
Stilkonventionen

​
Überschriften

  • Verwenden Sie den Satzfall: „Richten Sie Ihr Konto ein“ und nicht „Richten Sie Ihr Konto ein“
  • Verwenden Sie Imperativverben: „SSO konfigurieren“ und nicht „SSO konfigurieren“.
  • Halten Sie Überschriften prägnant und handlungsorientiert
VermeidenBevorzugen
Konfigurieren Ihrer EinstellungenEinstellungen konfigurieren
Mitarbeitergeräte verwaltenGeräte verwalten
zero-touch verstehenVerstehen Sie zero-touch
Importieren per CSVImport über CSV

​
Formatierung

  • Fett für UI-Elemente: Klicken Sie auf Einstellungen > Integrationen
  • Achten Sie auf verirrte ** – fettgedruckte Markierungen, die nicht richtig geschlossen wurden oder aus einem früheren Abschnitt ausgelaufen sind. Eine Linie sollte immer eine gerade Anzahl von **-Markern haben. Häufige Muster zum Erkennen:
    • ***word** (zusätzliches führendes *) → **word**
    • **word **other** (verschachtelter offener Marker) → **word other**
  • Code formatting für:
    • Dateinamen: config.json
    • Befehle: mint dev
    • Pfade: /api/employees
    • Code-Referenzen: deviceId
  • Verwenden Sie <Steps> für aufeinanderfolgende Schritte – bevorzugen Sie dies gegenüber nummerierten Listen, wenn Schritte einer definierten Reihenfolge folgen
  • Verwenden Sie in <Step title="...">-Attributen keine Markdown-Formatierung – Fettdruck (**) und Links ([text](url)) werden in JSX-Attributen als Literalzeichen dargestellt. Nur Klartext in Titeln; Verwenden Sie bei Bedarf den Schrittkörper für umfangreiche Inhalte
  • Verwenden Sie Aufzählungspunkte für nicht aufeinanderfolgende Elemente
<Steps>
  <Step title="Navigate to Settings > Team">
  </Step>
  <Step title="Click 'Add member'">
  </Step>
  <Step title="Enter one or multiple email address(es) and choose a role">
    To invite multiple members at the same time, you can specify multiple
    emails separated with commas in the 'Email' field.
  </Step>
</Steps>

​
Artikelstruktur

Folgen Sie in allen Artikeln einem einheitlichen Muster:
  1. Titel – Imperativverb + Objekt (z. B. „Verbinden Sie Ihr HR-System“)
  2. Beschreibung – Zusammenfassung dessen, was der Leser in einem Satz erreichen wird
  3. Voraussetzungen – Listen Sie die Anforderungen auf, bevor Sie beginnen (falls zutreffend)
  4. Schritte – Nummerierte Anweisungen mit klaren Aktionen
  5. Nächste Schritte – Link zu verwandten Inhalten (falls zutreffend)

​
Kartengruppen

Verwenden Sie <CardGroup>, um verwandte Links als visuelle Karten anzuzeigen. Befolgen Sie diese Richtlinien:
  • Maximum 3 cards per row — Use cols={3} or fewer for readability
  • Kartenkopie synchron halten – Kartentitel und -beschreibungen müssen mit dem Titelthema des referenzierten Artikels übereinstimmen
  • Verwenden Sie Karten für Sammlungen – Am besten für Übersichtsseiten geeignet, die auf verwandte Inhalte verweisen
<CardGroup cols={3}>
  <Card title="Connect your HR system" icon="users" href="/de/employees/connect-hris">
    Sync employee data automatically from your HR system.
  </Card>
  <Card title="Import via CSV" icon="file-csv" href="/de/employees/import-via-csv">
    Bulk import employees using a spreadsheet.
  </Card>
  <Card title="Automate onboardings" icon="wand-magic-sparkles" href="/de/employees/automate-onboardings">
    Set up automatic device provisioning for new hires.
  </Card>
</CardGroup>
Wartung: Wenn Sie den Titel oder die Beschreibung eines Artikels aktualisieren, suchen Sie nach Karten, die auf diese Seite verweisen, und aktualisieren Sie sie entsprechend.

​
Kurzreferenz

ElementKonventionBeispiel
ÜberschriftenSatzfall, Imperativ„Festplattenverschlüsselung konfigurieren“
UI-ElementeFettKlicken Sie auf Speichern
Code/BefehleBackticksFühren Sie mint dev aus
ProduktnameMinimieren Sie den VerbrauchLassen Sie „in Primo“ weg, wenn dies offensichtlich ist
AkronymeErläutern Sie die erste Verwendung„HR-System“ nicht „HRIS“
Card groupsMax 3 columns, synced copy<CardGroup cols={3}>
Sequentielle SchritteVerwenden Sie <Steps>@@I18N_SEG_117@@<Steps><Step title="...">