Dokumentationsrichtlinie

Aus RO.WIKI
Wechseln zu: Navigation, Suche

Einleitung

Willkommen beim RotaryWiki. Diese Richtlinie soll Ihnen helfen, Ihre Beiträge in allen Teilen so vorzubereiten, dass sie mit einem Minimum an Zeit und Mühe – sowohl für Sie als auch für uns als Administratoren – in ein vollständiges Wiki umgesetzt werden können.

Bitte lesen Sie die nachstehenden Ausführungen sorgfältig durch und nehmen Sie mit uns Kontakt auf, wenn sich Fragen zu einzelnen Punkten ergeben (E-Mail: wiki (at) rotary.de).

Aufbau

Allgemeines zum Text

Schreiben Sie den Text in der Briefform mit „Sie“ als Anrede des Lesers. Wenn Sie eine Software beschreiben, so beschreiben Sie, wie die Software funktioniert. Fehler in der Software kommen vor, sind aber nicht Gegenstand einer Beschreibung.

Formale Aspekte

Texte sollen als fortlaufender Text, endlos und ohne Tabulatoren oder Leerzeicheneinrückungen erstellt werden.

Absätze sollen linksbündig (nicht als Blocksatz) formatiert werden. Trennen Sie Absätze durch einfaches <RETURN> voneinander.

Orthographie

In den Texten richten Sie sich bitte nach dem DUDEN und verwenden Sie die neuen Deutschen Rechtschreibregeln. Verlassen Sie sich nicht auf die automatische Rechtschreibprüfung eines Textverarbeitungsprogramms und verwenden Sie keine Trennhilfeprogramme.

Hervorhebungen

Hervorhebungen im Text sind sparsam zu verwenden. Verwenden Sie zur Hervorhebung keine Unterstreichungen und keinen Fettdruck, sondern Kursivschreibung. Kursivschreibung wird in folgenden Fällen verwendet: Zur Hervorhebung (bitte sparsam!) und für fremdsprachige Worte und Wendungen, soweit sie in der jeweiligen Sprache nicht gängig sind.

Wenn Sie den Anwender darauf hinweisen wollen, einen Knopf oder eine Registerkarte anzuklicken, setzen Sie den Text in Spitze Klammern und verwenden Sie Versalien (Beispiel: <SPEICHERN>). Verwenden Sie für Tasten oder Tastenschlüssen die gleiche Formatierung (Beispiel: <Strg+G>). Setzen Sie die Tastenschlüssel für Apple Rechner zusätzlich Kursiv.

Einheiten und Abkürzungen

Abkürzungen von Fachbegriffen bitte bei der ersten Nennung stets definieren; Abkürzungen wie u.a., s.o., ggf. oder etc. möglichst vermeiden.

Zahlen und Zahlwörter

Zahlen bis zwölf bitte ausschreiben, es sein denn, sie stehen im Zusammenhang mit Einheiten oder Maßen, beispielsweise zwei Versuche, fünf Mitglieder oder 13 Protokolle. Vor dem Dezimalpunkt ist bei Werten kleiner Eins eine Null zu setzen, Dezimalpunkte stehen auf der Zeile.

Überschriften

Die Überschriften sind nach einer logischen Hierarchie zu gliedern, die Durchnummerierung erfolgt automatisch. Vier Ebenen von Überschriften reichen aus, mehr als fünf sollen sie nicht verwenden. Die Überschriften werden automatisch in ein Inhaltsverzeichnis übernommen.

Literatur und Bibliographie

Wenn Sie mit Literaturzitaten arbeiten, muss jede Literaturstelle im Text erwähnt werden. Gebräuchliche Zitiersysteme: Name, Datum, System, Seite; Beispiel: Schmitt, H. (1998), Seite 21 [Harvard-Zitation], Zeitschriftentitel bitte konsequent abkürzen.

Bitte beachten Sie, dass das Kopieren urheberrechtlich geschützter Werke verboten ist! Setzen Sie statt dessen einen Link.

Für eine Bibliographie werden in einem mit "Weiterführende Literatur" überschriebenen Teil alle sonstigen Werke zusammengefasst, die im Text nicht erwähnt sind.

Abbildungen

Abbildungen sollten Bildunterschriften haben und bei Verweisen auf die Abbildungen im Text sollte darauf geachtet werden, dass die Verweise der Beschriftung an der Abbildung entsprechen.

Hilfen

Eine Hilfe gibt die Seite https://meta.wikimedia.org/wiki/Help:Contents/de