Die VorgabenDer Autoren-GuideCopyright

Die Formatvorlage

Es folgen nun die einzelnen Format-Details. Zum besseren Vergleich sind die einzelnen Teile der Formatvorlage als Grafiken eingebunden und mit einem Kommentartext versehen. Die Nummern im Text entsprechen den roten-geränderten Markierungen in den Vorlagegrafiken.

1) Der Doku-Titel sollte als Überschrift im Dokument stehen. Ob fett oder unterstrichen ist egal. Wichtig ist auch die Nennung des Autors oder der Autoren mit vollem Namen. Alternativ ist auch die Nennung des Nicknames aus dem MCSEboard möglich.
2) Den normalen Textkörper am besten mit ARIAL, Größe 10 – 11, linksbündig formatieren. Dient nur der Lesbarkeit.
3) Hervorhebungen wie fetter Text können im CMS so formatiert und übernommen werden.
4) Befehle oder Code sollte zur deutlichen Erkennung innerhalb des Textes in der Schriftart Courier oder Courier New formatiert werden.

Abb. 1

5) Über jeder Grafik sollte eine eindeutige Bezeichnung gestellt werden, welche mit dem Namen der separaten Grafikdatei im Verzeichnis übereinstimmt. Die Bildüberschrift wird später nicht in der Online-Doku auftauchen, sondern ist nur als Unterstützung für das Einpflegen der Doku gedacht.
6) Wie schon erwähnt – alle Grafiken nach Möglichkeit im Format BMP oder TIFF.
7) Jede Grafik sollte innerhalb der Doku eindeutig nummeriert werden. Die Nummerierung wird in die Online-Doku übernommen.
8) Bei fremdem Material immer eine Quellangabe (Buch, Webseite usw.) und – wenn vorhanden – einen Copyright-Verweis darunter setzen.

Abb. 2

9) Besonders wichtige Details innerhalb von Grafiken können sehr leicht hervorgehoben werden. Allerdings sollte man damit sparsam umgehen und nicht die Grafik damit zupflastern.

Abb. 3

10) Wichtige Details innerhalb einer Grafik können auch im Text hervorgehoben werden. Auch damit sollte man sparsam umgehen. Die Hervorhebungen im Text müssen manuell im CMS formatiert werden.

Abb. 4

Zum Schluß: Bitte nicht zuviel auf eine Doku-Seite packen. Lieber eine Seite mehr, aber dafür übersichtlich und für das MCSEboard-Team gut zu lesen.

 

Die VorgabenDer Autoren-GuideCopyright