File: 7rules.ui

package info (click to toggle)
udo 6.4.1-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,680 kB
  • sloc: ansic: 42,702; makefile: 81; cpp: 19
file content (57 lines) | stat: -rw-r--r-- 1,930 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
!subnode Sieben goldene Regeln fr das Schreiben eines Quelltextes
!ignore_links

Bevor Sie mit dem Schreiben eines UDO-Quelltextes beginnen, werfen Sie
bitte einen Blick auf die folgenden Regeln und prgen Sie sie sich ein:

!begin_enumerate

#1
!item	(!B)Geben Sie Ihrem Text eine bersichtliche Struktur!(!b)

#2
!item	(!B)Sprechen Sie den Leser direkt an.(!b)

Verwenden Sie ""Sie knnen!.."" bzw. ""Du kannst"" anstatt ""Man kann!.."".

#3
!item	(!B)Benutzen Sie Schriftarten sparsam und einheitlich.(!b)

Der bermige 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
grundstzlich mit einer nichtproportionalen Schrift dar, Kommandos werden
immer kursiv angezeigt.

#4
!item	(!B)Fassen Sie sich so kurz wie mglich.(!b)

Holen Sie nicht zu weit aus, sondern kommen Sie mglichst schnell auf den
Punkt. Der Leser langweilt sich sonst oder wird unkonzentriert und
berliest womglich noch die wichtigen Stellen.
		
Ich gebe zu, ich schaffe es meistens auch nicht, mich kurz zu fassen.
(!grin)

#5
!item	(!B)Verwenden Sie kurze Kapitelberschriften.(!b)

Der Leser wird dann das gewnschte Kapitel beim berfliegen des
Inhaltsverzeichnisses schneller (wieder)finden. Auerdem nehmen Sie UDO
dadurch eine Menge Arbeit bei der Referenzierung ab, was durch eine
schnellere Umwandlung belohnt wird.

#6
!item	(!B)Vermeiden Sie gleichnamige berschriften.(!b)

Nicht nur da Sie damit UDO und Hypertext-Compiler verwirren, nein, auch
der potentielle Leser gert bei gleichnamigen Kapiteln durcheinander.
		
#7
!item	(!B)Gehen Sie sparsam mit Makros und Definitionen um.(!b)

UDO mu jede Zeile bis zu zweimal nach allen benutzten Makros und
Definitionen durchsuchen. Jedes zustzliche Makro und jede zustzliche
Definition verlangsamt den Umwandlungsvorgang.

!end_enumerate