Ü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 :doc:`highlights`,
:doc:`Stimme und Tonfall <voice-tone>` sowie :doc:`Schreibstil <writing-style>`.
Andernfalls könnt ihr den Leitfaden als Referenzdokument für spezifische Fragen
verwenden. Zum Beispiel könnt ihr Begriffe in der :doc:`Wortliste <wordlist>`
nachschlagen.

Redaktionelle Ressourcen
------------------------

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

#. Projektspezifischer Stil

   Befolgt die projekt- oder produktspezifischen Stilrichtlinien, :abbr:`z.B.
   (zum Beispiel)` notwendige Ausnahmen von diesem Leitfaden oder Begriffe, die
   nur für euer spezifisches Produkt relevant sind.

#. Dieser redaktionelle Leitfaden

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

#. Externe Referenzen

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

   .. table:: Externe Referenzen je nach Fragestellung

       +-----------------------+-------------------------------------------------------+
       | Art der Frage         | Referenz                                              |
       +=======================+=======================================================+
       | Rechtschreibung       | `Duden`_, :abbr:`s.a. (siehe auch)`                   |
       |                       | `Rechtschreibregeln`_, `DWDS-Wörterbuch`_             |
       +-----------------------+-------------------------------------------------------+
       | Nichttechnischer Stil | Universität Stuttgart: `Redaktionsleitfaden und       |
       |                       | Webstyleguide`_; :abbr:`s.a. (siehe auch)`            |
       |                       | 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:

* `Google developer documentation style guide
  <https://developers.google.com/style/>`_
* `Apple Style Guide <https://help.apple.com/applestyleguide/>`_
* `IBM content design
  <https://www.ibm.com/able/toolkit/design/content/text-meaning/>`_

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.

.. _`Duden`: https://www.duden.de/
.. _`Rechtschreibregeln`:
    https://www.duden.de/sprachwissen/rechtschreibregeln
.. _`DWDS-Wörterbuch`:
    https://www.dwds.de
.. _`Redaktionsleitfaden und Webstyleguide`:
    https://www.beschaeftigte.uni-stuttgart.de/uni-services/oeffentlichkeitsarbeit/projekt-more/more-dateien/Redaktionsleitfaden_web.pdf
.. _`einfach POLITIK: Lexikon`:
    https://www.bpb.de/nachschlagen/lexika/lexikon-in-einfacher-sprache
.. _`Microsoft German Style Guide`:
    https://download.microsoft.com/download/e/f/9/ef9f6d8e-cd8b-420c-8696-afd98b4a367d/deu-deu-StyleGuide.pdf