Über diesen Redaktionsleitfaden

Dieser Leitfaden enthält redaktionelle Richtlinien für das Schreiben klarer und konsistenter cusy-bezogener Dokumentation.

Wenn dieser Leitfaden neu für euch ist, und ihr nach einführenden Themen zu unserem Stil sucht, dann beginnt mit den Abschnitten Highlights, Stimme und Tonfall sowie Schreibstil. Andernfalls könnt ihr den Leitfaden als Referenzdokument für spezifische Fragen verwenden. Zum Beispiel könnt ihr Begriffe in der Wortliste nachschlagen.

Redaktionelle Ressourcen

Wir empfehlen die folgenden redaktionellen Hilfsmittel in ihrer hierarchischen Reihenfolge zu verwenden:

  1. Projektspezifischer Stil

    Befolgt die projekt- oder produktspezifischen Stilrichtlinien, z.B. notwendige Ausnahmen von diesem Leitfaden oder Begriffe, die nur für euer spezifisches Produkt relevant sind.

  2. Dieser redaktionelle Leitfaden

    Wenn die projektspezifischen Stilrichtlinien keine explizite Anleitung bieten, dann folgt diesem Leitfaden.

  3. Externe Referenzen

    Wenn die vorangegangenen Referenzen keine explizite Anleitung bieten, dann lest diese externen Referenzen, abhängig von der Art eurer Frage:

    Externe Referenzen je nach Fragestellung

    Art der Frage

    Referenz

    Rechtschreibung

    Duden, s.a. Rechtschreibregeln, DWDS-Wörterbuch

    Nichttechnischer Stil

    Universität Stuttgart: Redaktionsleitfaden und Webstyleguide; s.a. Bundeszentrale für politische Bildung: einfach POLITIK: Lexikon

    Technischer Stil

    Microsoft German Style Guide; beachtet jedoch, dass einige Richtlinien nur für Microsoft und deren Produkte zutreffend sein werden.

Andere Redaktionsleitfäden

Hier sind noch einige andere englischsprachige Redaktionsleitfäden aus der Informationstechnologie:

Brecht die Regeln

Brecht eher eine dieser Regeln, als dass ihr etwas schreckliches sagt.

– George Orwell, «Politik und englische Sprache» (1946)

Dieser Leitfaden enthält Richtlinien, keine Regeln. Weicht davon ab, wenn euer Inhalt dadurch besser wird.