Sieben goldene Regeln beim Schreiben von Quelltexten
Bevor Sie mit dem Schreiben eines UDO-Quelltextes beginnen, werfen
Sie bitte einen Blick auf die folgenden Regeln und prägen Sie sie
sich ein:
- 1. Geben Sie Ihrem Text eine übersichtliche Struktur.
-
Eine weiser Zeitgenosse sagte mal:
Wenn etwas einfach
ausgedrückt werden kann, kann es einfach ausgedrückt werden.
- 2. Sprechen Sie die Leserinnen und Leser direkt an.
-
Verwenden Sie
Sie können ...
bzw. Du kannst
anstatt Man kann ...
.
- 3. Benutzen Sie Schriftarten sparsam und einheitlich.
-
Der übermäßige Einsatz von kursivem, fettem
und unterstrichenem Text verwirrt Leser eher, als das er ihnen
hilft. Falls Sie Schriftarten einsetzen, tun Sie dies allerdings
einheitlich.
- 4. Fassen Sie sich so kurz wie möglich.
-
Holen Sie nicht zu weit aus, sondern kommen Sie möglichst
schnell auf den Punkt. Leser langweilen sich sonst oder werden
unkonzentriert und überlesen womöglich noch die wichtigen Stellen.
Okay, wir schaffen es meistens auch nicht, uns kurz zu fassen, wie
dieser Text zeigt. ;-)
- 5. Verwenden Sie kurze Kapitelüberschriften.
-
Leser werden dann das gewünschte Kapitel beim Überfliegen des
Inhaltsverzeichnisses schneller (wieder)finden. Außerdem nehmen Sie
UDO dadurch eine Menge Arbeit bei der Referenzierung ab, was durch
eine schnellere Umwandlung belohnt wird.
- 6. Vermeiden Sie gleichnamige Überschriften.
-
Nicht nur, dass Sie damit UDO und Hypertext-Compiler verwirren,
nein, auch die Leser geraten bei gleichnamigen Kapiteln durcheinander.
- 7. Gehen Sie sparsam mit Makros und Definitionen um.
-
UDO muss jede Zeile bis zu zweimal nach allen benutzten Makros
und Definitionen durchsuchen. Jedes zusätzliche Makro und jede
zusätzliche Definition verlangsamen den Umwandlungsvorgang. Wägen
Sie selbst ab zwischen Tempo und Komfort.
Copyright © www.udo-open-source.org (Kontakt)
Letzte Aktualisierung am 19. Mai 2014