Ressourcen für das technische Schreiben

Diese Seite fasst zusätzliche Ressourcen für das technische Schreiben zusammen.

Redaktionelle Stilrichtlinien

Ein redaktioneller Stilleitfaden definiert die Richtlinien einer Redaktionsgruppe für die Kommunikation. Welche der folgenden Regeln sollte Ihre Organisation beispielsweise für Überschriften übernehmen?

• Überschriften in Satzform schreiben (nur das erste Wort jeder Überschrift groß schreiben)
• Überschriften in Titelform schreiben (die meisten Wörter in jeder Überschrift groß schreiben)

Vergeuden Sie keine Zeit und Energie damit, über diese Art von Fragen zu diskutieren.Ein redaktioneller Leitfaden gibt eine Reihe von Antworten auf die Fragen, die sich in Bezug auf die Wahl der Schriftart stellen. Es spielt keine Rolle, dass ein redaktioneller Leitfaden die Groß- und Kleinschreibung im Satz und ein anderer die Kleinschreibung im Titel bevorzugt. Wichtig ist nur, dass Ihr Unternehmen einen einzigen redaktionellen Leitfaden verwendet.

Aber welchen redaktionellen Leitfaden? Vielleicht sind Sie bereits mit allgemeinen redaktionellen Leitfäden vertraut (z. B. dem Chicago Manual of Style oder dem University of Oxford StyleGuide).Ihr Ingenieurteam sollte jedoch einen redaktionellen Leitfaden verwenden, der auf technische Texte spezialisiert ist. Wir empfehlen, einen der folgenden Leitfäden zu verwenden:

• Der Google-Entwicklerdokumentationsleitfaden bietet redaktionelle Richtlinien für alle, die Entwicklerdokumentation für Google-bezogene Projekte schreiben.
• Der Microsoft Writing Style Guide bietet Richtlinien für alle, die technische Dokumentation schreiben.

Schreiben Sie keinen eigenen redaktionellen Leitfaden. Die Erstellung und Pflege eines „hauseigenen“ Redaktionsleitfadens erfordert enorme Ressourcen und führt zu enormen Konflikten. Einige Unternehmen führen jedoch neue Begriffe ein, die in einem bestehenden Leitfaden für redaktionelle Gestaltung nicht auftauchen. In diesem Fall kann die Organisation eine der folgenden Maßnahmen ergreifen:

• Die Betreuer einer redaktionellen Stilrichtlinie bitten, die neuen Begriffe hinzuzufügen.
• Eigene Verwendungsrichtlinien oder Stilvorlagen erstellen und pflegen, die die Schreibweisen und Wortverwendungen für das Fachvokabular der Organisation kodifizieren.

Möglichkeiten für Open-Source-Dokumentation