Der Autoren-GuideFormatvorlage

Die Vorgaben

Die einzelnen Dokus werden später vom MCSEboard-Team manuell in das Content Management System von ServerHowTo.de eingepflegt. Die vorgegebene Formatierung der Dokus soll sicherstellen, dass Texte und Grafiken zu jeder Zeit eindeutig zugeordnet werden können. Als Nebeneffekt wird das Board-Team bei seiner Arbeit entlastet. Hier geht es zur Formatvorlage.

Allgemeine Infos

1) Das Doku-Layout ist für die spätere Darstellung im CMS absolut irrelevant. Die Formatierungen sollen nur sicherstellen, dass Texte und Grafiken eindeutig zugeordnet werden können. Nichts ist nerviger als eine Doku, deren Inhalt nicht in der richtigen Reihenfolge vorliegt.

2) Die Grafiken (Screenshots, Diagramme usw.) sollten, wenn irgendwie möglich, nur in den Formaten BMP oder TIFF vorliegen.
Die zum Teil enorme Datengröße dieser Formate ist technisch gewollt. Nur mit hochwertigem Ausgangsmaterial können gute Grafiken für das CMS erstellt werden. Dies funktioniert nicht mit bereits reduzierten Formaten wie JPG, GIF, PNG und anderen. Bei diesen Formaten können bei der Bearbeitung Farbfehler und Artefakt-Bildung auftreten.
Die Grafiken bitte jeweils im Dokument selber und separat im gleichen Verzeichnis in der Originalgröße und Auflösung mitliefern.

Hinweis: Das Layout von ServerHowTo.de wurde so konzipiert, dass es auch auf Monitoren mit einer niedrigen Auflösung von 800 x 600 Bildpunkten funktioniert. Daher gibt es für Grafiken zwei max. Größen.

Bis zu 600 px Breite: die Grafiken können im Originalformat ins HowTo eingebunden werden.
Ab 601 px - 800 px Breite: die Grafiken werden in kleiner Auflösung (Thumbnail) ins HowTo eingebunden und über ein Popup-Fenster im Original angezeigt.

Grafiken mit einer Breite von mehr als 800 px können nicht mehr in der Originalgröße und Qualität dargestellt werden. Vor dem Screenshot daher das betreffende Fenster entsprechend verkleinern oder eine niedrigere Monitorauflösung einstellen. Wenn diese Maßnahmen nicht ausreichen, bitte das Bild im Original-Format und - sehr wichtig: unbearbeitet - der Doku beifügen. Das Team von ServerHowTo.de wird das Material dann selber nachbearbeiten.

Empfehlung: bei der Erstellung von Screenshots unter Windows Vista nach Möglichkeit vorher das Feature "ClearType" deaktivieren. Der etwas verwaschene Effekt wird bei den Screenshots übernommen, dadurch erreicht das Bild im HowTo nicht die optimale Qualität.

3) Der HowTo-Text sollte als Word-Dokument (*.doc) vorliegen. Nur in Ausnahmefällen kann auch ein PDF mit separaten Grafiken eingereicht werden. Aus einem PDF herauskopierte Grafiken sind nicht brauchbar. Bei PDFs vor den Einreichen bitte nachfragen.
Tipp: Nicht jeder hat Microsoft Word oder das ganze Office-Paket auf seinem Rechner. Die freie Office-Suite  OpenOffice.org kann Dokumente im MS Office-Format abspeichern.

4) Als Ansprache an den Leser bitte eine neutrale Form oder das "Sie" wählen. Höflichkeit und Respekt haben noch nie geschadet. Viele Leser empfinden ein "Du" als unangemessene Vertraulichkeit.

5) Auf alle Fälle bitte eigenes, selbsterstelltes Material verwenden. Fremdes Material nur dann, wenn es unbedingt nötig ist.
Ausnahme: siehe Punkt 6)

In diesem Fall muss mindestens eine Quell-Angabe in die Dokumentation gesetzt werden. Auch muss beim Rechteinhaber vorher eine Erlaubnis eingeholt werden. Bei der Anfrage explizit darauf hinweisen, dass das Material für eine nicht kommerzielle Dokumentation verwendet wird.

6) Wer es sich zutraut, hat auch die Möglichkeit, fremdsprachige Dokus und HowTos ins Deutsche zu übersetzen. Wichtig ist, dass alle Arbeitsschritte und technischen Details korrekt und nachvollziehbar wiedergegeben werden.

Dazu muss beim Urheber des Originals schriftlich die Erlaubnis zum Übersetzen der Doku eingeholt werden.

Weitere Details dazu finden Sie in unserer Copyrightvereinbarung.

Es macht auch keinen Sinn, innerhalb einer Doku mit einen Link auf externe Ressourcen im Internet zu verweisen. Das ist zwar sehr bequem, doch ServerHowTo.de möchte seinen eigenen Doku-Bestand pflegen - keine Linkliste.

Im Zweifelsfall - Finger weg von fremden Material!

Keine Doku ist es wert, einen hässlichen Rechtsstreit zu riskieren.


Fertige HowTos und Endfassungen

Wenn sich für ein Doku-Thema zwei oder mehr Teilnehmer als Autoren gefunden haben, sollten sie die Dokumente direkt untereinander austauschen. Direkte Kommunikation hält ein Team zusammen.
Erst wenn ein Autor oder Autoren-Team seine Doku endgültig zur Veröffentlichung freigeben möchte, senden sie das Verzeichnis mit der *.doc-Datei und den separaten Grafiken als ZIP-Archiv – und bitte nur in diesem Format – direkt an:  doku(at)serverhowto.de

Der Autoren-GuideFormatvorlage