User Documentation Im Folgenden werden die grundlegenden Anforderungen an die Formatierung von Dokumentationsartikeln festgelegt.
Referenzen
Übersichtsseiten
Ein Beitrag, der einen Abschnitt mit Einleitungen und Links zu Unterabschnitten vorstellt.
Einleitungsabsatz
Links zu Abschnitten mit kurzen Beschreibungen
- Für jeden Link einen Einzug verwenden
- Der Link ist identisch mit der Darstellung im Menü.
- Dem Link folgt ein Gedankenstrich (Leerzeichen-Gedankenstrich-Leerzeichen) und dann eine kurze Einleitung von ein bis zwei Sätzen zum Unterabschnitt, die beschreibt, wie er das übergeordnete Thema erweitert.
Der Zusammenfassungsabsatz stellt den Bezug zwischen dem Abschnitt und der Kategorie her, d. h. ein Thema zum Bereich Content-Management wird auf Content-Management bezogen.
Verlinkung zu einem Unterabschnitt
Links zu Unterabschnitten
Überschriften
Großschreibung der wichtigen Wörter (Title Case)
Großschreiben
- Das erste und letzte Wort (immer)
- Substantive, Verben, Adjektive, Adverbien
- Wörter mit 4 oder mehr Buchstaben (gängige Faustregel)
Kleinschreiben
- Kurze Präpositionen: in, on, at, by, for, of, up, to
- Artikel: a, an, the
- Kurze Konjunktionen: and, but, or, nor, so, yet
Beispiel
A Guide to the Rules of Title Case and How to Use Them
Kaufmännisches Und &
Nur in Menüs als Ersatz für das Wort „and“ verwenden, niemals in Beitragstiteln.
Menüeintrag
6 Pagination & Read More
Beitragstitel
6 Pagination and Read More
Nummerierung
Wenn der Inhalt einer nummerierten Gliederung oder Indexstruktur folgt, wird am Ende einer Zahl kein Punkt gesetzt.
Richtig
6 Pagination and Read More
Falsch
6. Pagination and Read More
Schlagwörter (Tags)
- Tutorial
- Content-Management
- Site Building
- Site-Wartung
Screenshots
Ausführliche Hinweise finden sich unter Tipps für bessere Screenshots.
Hinweise: 1500–2500 px Breite; heller (kein dunkler) Browserhintergrund; passend zuschneiden, um den Benutzer zu orientieren und relevante Details anzuzeigen; Browser-Zoom zur besseren Lesbarkeit des Textes; Dateiformat PNG.
Bildunterschriften
Wenn eine Bildunterschrift konfiguriert ist (Rechtsklick und Kontrollkästchen „Bildunterschrift“ aktivieren), wird das Bild in einen <figure>-Block mit passender Bildunterschrift eingebettet; andernfalls wird das Bild im normalen Inline-Format angezeigt.
Platzierung
Größe
Standardbreiten: 960 px für volle Breite sowie 320 px oder 640 px für Teilbreiten.
Größere Breiten (über 1000 px) werden im Browser automatisch auf die Beitragsbreite angepasst. Kleinere Bilder werden linksbündig ausgerichtet.
Quellenangabe
Wenn der Screenshot Bilder enthält, sollte die Quelle angegeben werden? Und wie?