10 Tipps für Überschriften in AsciiDoc
Überschriften verbessern die Lesbarkeit Ihrer technischen Dokumente. Hier sind 10 Tipps, wie sie dieses Stilmittel in AsciiDoc effektiv einsetzen.
1. Verwenden Sie eine logische Struktur
Gliedern Sie Ihr Dokument mit einer klaren Hierarchie. Beginnen Sie mit = für den Haupttitel, dann == für die Hauptabschnitte, === für die Unterabschnitte und so weiter. Genau wie die meisten Auszeichnungssprachen ordnet AsciiDoc Überschriften hierarchisch an. Diese Anordnung hilft dem Leser, die Struktur des Dokuments auf einen Blick zu erfassen.
Entwerfen Sie die Struktur Ihres Dokuments, bevor Sie den Inhalt schreiben. Auf diese Weise können Sie effektiver gegen Schreibblockaden vorgehen, da Sie bereits wissen, welche Themen Sie in welchen Abschnitten behandeln möchten.
2. Seien Sie prägnant und beschreibend
Halten Sie Überschriften und Zwischenüberschriften kurz, aber aussagekräftig, um das Wesentliche des jeweiligen Abschnitts zu vermitteln. Vermeiden Sie vage Überschriften, damit die Leser wissen, was sie in den einzelnen Abschnitten erwartet. Schreiben Sie im Aktiv und nicht im Passiv, wobei das Subjekt die Handlung ausführt und vor dem Verb steht. Im Vergleich dazu konzentriert sich das Passiv auf die Handlungen des Objekts.
3. Verwenden Sie Parallelstrukturen
Achten Sie bei Überschriften auf derselben Ebene auf eine einheitliche grammatikalische Struktur. Diese Einheitlichkeit trägt zu einem reibungslosen Ablauf bei und verbessert die Lesbarkeit. Das Stichwort heißt "Paralellismus". Verfassen Sie Überschriften in einer einheitlichen Satzstruktur.
Die Überschriften in diesem Artikel beginnen stets mit einem Verb im imperativ und addressieren Sie direkt. Dadurch liegt der Fokus direkt auf den Handlungen und Empfehlungen.
4. Binden Sie Schlüsselwörter ein
Verwenden Sie relevante Schlüsselwörter in Ihren Überschriften und Zwischenüberschriften, um die Auffindbarkeit zu verbessern und die wichtigsten Punkte des Dokuments hervorzuheben. Vermeiden Sie jedoch Keyword-Stuffing. Es bringt beispielsweise keinen Mehrwert, den Namen Ihres Produkts in alle Überschriften zu integrieren.
Behalten Sie Ihre Leser im Auge: Nach welchen Schlüsselwörtern werden sie am ehesten suchen? Dies sollte ein wesentlicher Bestandteil Ihrer Zielgruppenanalyse sein. Fragen Sie sich, wonach Ihr Leser sucht, wenn er Ihr Dokument durchsucht. Haben sie Fragen zu Ihrem Produkt/Ihrer Dienstleistung? Lesen sie aus Neugierde, weil sie das volle Potenzial des Produkts ausschöpfen wollen?
5. Begrenzen Sie die Anzahl der Ebenen
Zu viele Ebenen können Ihr Dokument kompliziert erscheinen lassen. Beschränken Sie die Struktur Ihres Dokuments idealerweise auf drei oder vier Überschriftenebenen, um es übersichtlich zu halten.
Ausgewogen ist eine Gliederung dann, wenn die Anzahl der Abschnitte und Unterabschnitte in jedem Kapitel nicht zu stark voneinander abweichen. Es ergibt nicht viel Sinn, wenn ein Kapitel nur einen Unterabschnitt oder Abschnitt enthält.
6. Trennen Sie Abschnitte deutlich voneinander
AsciiDoc erstellt Abstände zwischen Text und Überschrift automatisch. Achten Sie darauf, dass sich Ihre Überschriften vom Text und voneinander abheben, damit das Dokument leichter zu scannen ist. Wenn Sie das Stylesheet für das Layout und Design des Dokuments anpassen, achten Sie darauf, dass über der Überschrift genügend Leerraum bleibt.
7. Verwenden Sie Anker für die Verlinkung
In den meisten Fällen werden technische Dokumente nicht wie Romane von Anfang bis Ende gelesen, sondern gezielt nach Themen gesucht. Hierfür ist eine schnelle Navigation essentiell. Digitale Dokumente haben gegenüber ausgedruckten Dokumenten einen Vorteil, da sie Texte miteinander verlinken können. Hier ein Tipp, wie Sie diese Verlinkung effektiv einsetzen können, damit Ihre Leser schnell zur gewünschten Textstelle finden:
Sie können den Überschriften sogenannte "Anker" zuweisen. Das ist ein Element, das in der Ausgabe unsichtbar ist und einen Referenzpunkt für Verweise erstellt. Definieren Sie den Anker in der Zeile über Ihrer Überschrift/Unterüberschrift mit [#Anker-Name]. Jetzt können Sie in anderen Teilen Ihres Dokuments auf den Abschnitt verweisen. Für den Verweis schreiben Sie <#Anker-Name>. Wenn Sie dem Verweis einen benutzerdefinierten Titel hinzufügen möchten, können Sie ihn mit einem Komma in die Syntax einfügen: <#Anker-Name, Titel>.
Sie können auch direkt auf die Überschrift verweisen, jedoch empfehlen wir Ihnen, stets einen Anker zu verwenden. Dadurch müssen Sie bei Änderungen in der Überschrift den Verweis nicht anpassen. Der Verweis funktioniert, solange Sie den Anker nicht ändern. Da er in der Ausgabe nicht erscheint, haben Sie auch kein Problem damit, den Anker-Namen unverändert bestehen zu lassen.
8. Vermeiden Sie verwaiste Überschriften
Verwaiste Überschriften sind vom Text losgelöst. Sie stehen beispielsweise auf einer anderen Seite, und sind durch einen Seitenumbruch von ihrem Inhalt getrennt. Versuchen Sie das zu vermeiden.
9. Achten Sie auf eine einheitliche Ausrichtung
Vergewissern Sie sich, dass alle Überschriften und Unterüberschriften einheitlich ausgerichtet sind. In den meisten Fällen bedeutet dies, dass sie linksbündig ausgerichtet werden, um ein sauberes, professionelles Erscheinungsbild und eine gute Lesbarkeit zu gewährleisten.
In manchen Fällen kann eine mittige Ausrichtung sinnvoll sein. Sie können in AsciiDoc die Ausrichtung von links auf zentriert ändern, indem Sie [.text-center] in die Zeile direkt über der Überschrift schreiben.
10. Prüfen Sie auf Konsistenz
Achten Sie auf eine einheitliche Großschreibung, Zeichensetzung und Formatierung in Ihrem Dokument. Konsistenz hilft, die Professionalität zu wahren und erleichtert die Lesbarkeit.
Denken Sie daran, dass gut formulierte Überschriften und Zwischenüberschriften nicht nur Ihren Inhalt gliedern, sondern auch den Leser durch Ihr Dokument führen und so die Navigation und das Verständnis komplexer Informationen erleichtern.
