Übersicht
Dieses Beispiel-Plugin hat keine Funktion. Es zeigt, welche Darstellungsformen in der Plugin-Dokumentation zur Verfügung stehen, und dient Autor:innen als Vorlage zum Abschauen.
Die Quelltexte liegen im Portal-Repo unter examples/darstellungs-beispiel/docs/.
Was du hier findest
| Seite | Inhalt |
|---|---|
| Textformatierung | Überschriften, Hervorhebungen, Zitate, Fußnoten, Tastenkürzel |
| Listen | Aufzählungen, nummerierte Listen, Verschachtelung, Checklisten |
| Hinweisboxen | Hinweis, Tipp, Info, Warnung, Gefahr |
| Tabellen | Ausrichtung, breite Tabellen, Formatierung in Zellen |
| Bilder | Screenshots, breite Grafiken, Bildunterschriften |
| Lange Anleitung | Lange Seite mit Sprungmarken, Inhaltsverzeichnis und aufklappbaren Abschnitten |
Für Entwickler:innen zeigt die Entwickler-Doku Codeblöcke, Diagramme und eine lange API-Referenz.
Grundregeln für gute Benutzer-Doku
- Nach Aufgaben gliedern, nicht nach Menüpunkten: „Hinweis zeitlich begrenzen“ statt „Feld Gültig bis“.
- Admin-Pfade fett und mit
›getrennt: Einstellungen › System › Caches & Indizes. - Kein Code in der Benutzer-Doku – technische Details gehören in die Entwickler-Doku.
- Ein Screenshot pro Schritt, wenn die Stelle schwer zu finden ist.