WritingStandards de¶
Angelehnt an WritingStandards_ mit Berücksichtigung der deutschen Eigenheiten.
Ratschläge¶
- Kurze Sätze bevorzugen: Subjekt Objekt Verb / Subjekt Verb Objekt
- in der Kürze liegt die Würze (oder wie die Franzosen sagen Ce qui se conçoit bien, s'énonce clairement [Boileau])
- Ein Absatz pro Thema.
- Zu viele Bemerkungen stören den Lesfluss, daher sich damit etwas zurückhalten oder an einer Stelle sammeln.
Regeln¶
- GLPI-Begriffe müssen im Glossar erfasst werden.
- Infinitiv und Passiv verwenden
- Tätigkeiten, Beschreibungen, Überschriften müssen im Infinitiv stehen. Keine direkte Anrede mit Sie. Die französische Regeln verlangen Zurückhaltung mit Substantiven, dies gilt für Deutsch nicht.
Beispiel:
GLPI kann auf der Projektseite, mit einem Klick auf den Link Download heruntergeladen werden.Falsch:
Im Menü X werden Sie
finden. Damit können Sie
- Es geht darum, die Funktionalitäten einer Anwendung zu bescreiben, also reden wir auch von der Anwendung.
Beispiel:
GLPI bietet im Menü X folgende Funktionen an:
Vorschläge für sprachliche Wendungen¶
GLPI bietet
(an), ermöglicht
, zeigt
(an), verfügt über
, verwendet
, benutzt, kommt mit
.Weitere Elemente¶
- Listen werden, im Gegensatz zum Französischen, im Deutschen nicht mit Interpunktion versehen.
- Menüs oder klickbare Elemente (wie bei Tätigkeiten) müssen fett angezeigt werden. Dies wird mit den Elementen menucascade und uicontrol bewirkt.
Beispiel für ein Menü:
<menucascade>
<uicontrol>Konfiguration</uicontrol>
<uicontrol>Authentifikation</uicontrol>
<uicontrol>Konfiguration der Authentifikation</uicontrol>
</menucascade>
Beispiel für ein klickbares Element:
Ein automatischer Job <uicontrol>Abholen der Meldungen</uicontrol>
- Zitate müssen kursiv angezeigt werden.
- Code muss fett angezeigt werden. Dafür muss codeph benutzt werden.
zum Beispiel:
Name: Regulärer Ausdruck entspricht <codeph>/DESKTOP_(.*)/</codeph>