Home Tips & Tricks Tips & Tricks Allgemeine Tips & Tricks

Sieben goldene Regeln für das Schreiben eines Quelltextes

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!
     
  2. Sprechen Sie den 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 unterstrichenen verwirrt den Leser eher, als das er ihm hilft. Falls Sie Schriftarten einsetzen, so tun Sie dies allerdings einheitlich. Diese Anleitung stellt Dateinamen grundsätzlich mit einer nichtproportionalen Schrift dar, Kommandos werden immer kursiv angezeigt.
     
  4. Fassen Sie sich so kurz wie möglich.
     
    Holen Sie nicht zu weit aus, sondern kommen Sie möglichst schnell auf den Punkt. Der Leser langweilt sich sonst oder wird unkonzentriert und überliest womöglich noch die wichtigen Stellen.
     
    Ich gebe zu, ich schaffe es meistens auch nicht, mich kurz zu fassen. ;-)
     
  5. Verwenden Sie kurze Kapitelüberschriften.
     
    Der Leser wird 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 daß Sie damit UDO und Hypertext-Compiler verwirren, nein, auch der potentielle Leser gerät bei gleichnamigen Kapiteln durcheinander.
     
  7. Gehen Sie sparsam mit Makros und Definitionen um.
     
    UDO muß jede Zeile bis zu zweimal nach allen benutzten Makros und Definitionen durchsuchen. Jedes zusätzliche Makro und jede zusätzliche Definition verlangsamt den Umwandlungsvorgang.
     

Home Tips & Tricks Tips & Tricks Allgemeine Tips & Tricks