Hilfe im System
Überblick
Die Hilfe beantwortet auf jeder Seite dieselbe Frage: Was ist das hier, und wie arbeite ich damit? Sie erreichen sie auf drei Wegen, die alle dasselbe zeigen:
- Das Fragezeichen in der Kopfzeile öffnet die Hilfe zur Seite, auf der Sie gerade sind.
- Die Taste F1 tut dasselbe, ohne die Hand von der Tastatur zu nehmen.
- Das Hilfe-Center unter
/helpzeigt den gesamten Bestand mit Suche.
Der Hilfe-Text erscheint neben Ihrer Arbeit, nicht darüber: Die Seite dahinter bleibt sichtbar und bedienbar. Das ist Absicht — Hilfe, für die man die Arbeit unterbrechen muss, wird nicht gelesen.
Ein Hinweis zur Tastenwahl: Das Fragezeichen ? ist bereits mit der Übersicht der Tastatur-Kürzel belegt. Beide Flächen verlinken aufeinander.
Kernaufgaben
Hilfe zur aktuellen Seite lesen. F1 drücken oder das Fragezeichen anklicken. Hat eine Seite mehrere passende Themen, erscheinen sie oben als Auswahl; das passendste steht vorn.
Etwas Bestimmtes suchen. ⌘K (bzw. Strg+K) öffnet die Befehls- und Suchleiste. Tippen Sie einen Begriff ein — unter Hilfe stehen die passenden Handbuch-Seiten. Enter öffnet die Seite im Drawer, Ihre Arbeit bleibt stehen.
Den gesamten Bestand durchsehen. Das Hilfe-Center listet links alle Seiten dieser Instanz, gruppiert nach Handbuch, Modulen und Administration. Die Suche dort greift auch auf Seiteninhalte zu.
Eine Seite verlinken. Jede Hilfe-Seite hat eine eigene Adresse der Form /help/<bereich>/<seite> — zum Beispiel /help/crm/deals. Der Schlüssel dazu (crm.deals) steht am Fuß jeder Seite im Hilfe-Center.
Felder im Detail
Die Hilfe wird gelesen; bearbeitet wird sie nur mit dem Recht dafür — unter Einstellungen → Hilfe & Dokumentation. Die Spalte Was es bewirkt beantwortet, was sich im System ändert; der graue Name dahinter ist das Feld der API, unter dem dasselbe über Automation und KI-Werkzeuge läuft.
Was die Bearbeitungsfläche schreibt
| Feld | Pflicht | Werte / Format | Was es bewirkt |
|---|---|---|---|
Sprache locale | ja | eine der eingerichteten Sprachen | Welche Sprachfassung bearbeitet wird. Eine Bearbeitung gilt für genau diese eine Sprache; die andere zieht weiter mit jedem Update automatisch nach, bis auch sie bearbeitet wird. |
Inhalt bodyHtml | nein | formatierter Text | Der Text der Seite in dieser Sprache. Gespeichert wird er als Anpassung dieser Instanz — die öffentliche Dokumentation bleibt beim Auslieferungsstand. |
Status status | nein | draft, review, published | Wie weit die Seite ist. Nur published erscheint für alle; Entwürfe sehen ausschließlich Nutzer mit dem Verwaltungsrecht, erkennbar am Hinweis über dem Text. |
Sichtbarkeit visibility | nein | public oder internal | Ob die Seite nach außen darf. internal erscheint nie öffentlich und nie im Portal-Assistenten. |
Aktiv active | nein | Ja/Nein | Ob die Seite überhaupt ausgeliefert wird. Aus heißt: nicht im Drawer, nicht im Hilfe-Center, nicht in der Suche. |
Nur über Schnittstelle und Automation
Der Bestand kommt mit dem Produkt und wird beim Update abgeglichen. Diese Felder legen fest, wo eine Seite hingehört; sie werden deshalb nicht in der Oberfläche gepflegt, sondern beim Anlegen eines eigenen Themas über die Schnittstelle mitgegeben.
| Feld | Werte / Format | Was es bewirkt |
|---|---|---|
key | Text, max. 120 Zeichen, Form <bereich>.<seite> | Die stabile Adresse der Seite — in der App, im Portal, in der Suche, im KI-Zitat und in jedem Deep-Link. Sie wird nicht umbenannt; eine Seite wird abgelöst, nicht verschoben. |
kind | guide, module, admin, developer, reference | Welche Art von Seite es ist. Bedien-Seiten (guide) hängen an Routen, Modul- und Administrationsseiten nicht; developer und reference entstehen aus dem Code und sind nur lesbar. |
audience | staff, portal, both | Wer die Seite in der Anwendung sieht — Mitarbeiter, Portal-Nutzer oder beide. |
channels | Teilmenge aus app, portal, web | Wo der Inhalt erscheint. Es ist das einzige Feld, das darüber entscheidet; kanalspezifische Zweitfassungen gibt es bewusst nicht. |
moduleKey | Feature-Flag, etwa module.crm | An welches Modul die Seite gebunden ist. Ist das Modul aus, ist die Seite aus — serverseitig, nicht nur in der Anzeige. |
routeNames | Liste von Routen-Namen | Für welche Seiten der Anwendung dieses Thema die Kontexthilfe ist. Daraus entscheidet sich, was F1 öffnet. |
pathPrefixes | Liste von Pfad-Anfängen | Dasselbe über den Pfad; Unter- und Detailseiten erben die Hilfe darüber. |
sortOrder | Zahl | Wo die Seite innerhalb ihres Bereichs in der Gliederung steht. |
bodyMarkdown | Text | Derselbe Inhalt als Markdown — das Format für Schnittstelle, Import und KI-Werkzeuge. |
Wie die Hilfe zu Ihnen kommt
| Weg | Was er tut |
|---|---|
| F1 bzw. Fragezeichen | Öffnet die zur aktuellen Seite passende Hilfe, ohne die Arbeit zu verlassen. |
| Hilfe-Center | Alle Seiten mit Suche und Gliederung. |
| ⌘K | Springt aus der Befehlsleiste direkt in ein Thema. |
| KI-Assistent | Beantwortet Bedienfragen aus dieser Hilfe, mit Angabe der Seite. Was hier nicht steht, erfindet er nicht. |
| Zurücksetzen | Verwirft die Anpassung dieser Sprache und stellt die ausgelieferte Fassung wieder her. Der Weg zurück, wenn eine Anpassung nach einem Update nicht mehr passt. |
Eine bearbeitete Seite überlebt jedes Update: der Abgleich lässt geänderte Sprachfassungen in Ruhe und zieht nur nach, was unverändert ist.
Einstellungen & Rechte
Hilfe lesen darf jeder angemeldete Nutzer; ein eigenes Recht braucht es dafür nicht.
Hilfe verwalten setzt platform.docs.manage voraus. Die Fläche dafür liegt unter Einstellungen → Hilfe & Dokumentation. Dort lässt sich jeder Text je Sprache überschreiben, ein Thema deaktivieren und jede Anpassung wieder auf den Auslieferungsstand zurücksetzen; ein eigenes Thema anzulegen ist ein Weg über die Schnittstelle, nicht über diese Fläche. Nur Nutzer mit diesem Recht sehen außerdem Seiten, die noch im Entwurf stehen — erkennbar am Entwurfs-Hinweis über dem Text.
Zwei Eigenschaften der Pflege sind wichtig, weil sie oft anders erwartet werden. Erstens: Eine Anpassung gilt nur für die bearbeitete Sprache. Wer den deutschen Text ändert, bekommt den englischen weiterhin mit jedem Update nachgezogen. Zweitens: Entwickler- und Referenzseiten werden aus dem Code erzeugt und sind deshalb nur lesbar — eine Änderung daran wäre beim nächsten Erzeugungslauf wieder weg.
Zwei Dinge, die die Hilfe bewusst nicht tut: Sie zeigt keine Seiten zu Modulen, die in dieser Instanz abgeschaltet sind. Und Anpassungen, die hier vorgenommen werden, bleiben in dieser Instanz — die öffentliche Dokumentation zeigt weiterhin den Auslieferungsstand.
FAQ & Fehlerbilder
Zu meiner Seite gibt es keine Hilfe. Dann ist die Seite noch nicht beschrieben. Der Bestand wächst laufend; das Hilfe-Center zeigt, was bereits vorhanden ist.
Der Text weicht von dem ab, was ich online lese. Dann wurde er in dieser Instanz angepasst. Im Hilfe-Center steht in diesem Fall der Vermerk In dieser Instanz angepasst am Fuß der Seite.
F1 tut nichts. Manche Browser belegen F1 selbst mit ihrer eigenen Hilfe. Nutzen Sie in dem Fall das Fragezeichen in der Kopfzeile.