Dokumentation/Infos zum Dokumentations-Team/Vorlagenhandbuch
TDF LibreOffice Document Liberation Project Community Blogs Weblate Nextcloud Redmine Ask LibreOffice Spende
| zurück: Kapitel 3 | oben: Vorwort | Nächstes: Kapitel 5 |
Einführung
Dieses Handbuch hilft bei der Erstellung oder Aktualisierung von Kapiteln des Benutzer Handbuches und stellt ein konsistentes und professionelles Bild des Handbuches sicher.
In den meisten Fällen sind die Vorschläge in diesem Dokument Richtlinien, keine Regeln. Entscheiden Sie selbst über deren Anwendung und fragen Sie andere nach deren Meinung, falls Sie nicht sicher sind. Dieses Handbuch enthält einige "Regeln", die beachtet werden müssen, um Konsistenz über alle Kapitel sicher zu stellen. Diese sind mit einem Stern am Rand gekennzeichnet: 
andere Informationsquellen
Design Informationen (wie Kapitel aussehen sollten, inklusive einer Erklärung, wann welche Vorlage für Absätze, Zeichen, Seiten, Rahmen und Aufzählungen verwendet werden soll) finden sich in der LibreOffice Kapitel-Vorlage, der Libre Office Buch-Vorlage und Kapitel 5 dieses Leitfadens.
Textvorlagen
Die folgende Liste fasst unsere bevorzugte Textvorlage zusammen. Einige dieser Punkte werden in den Tipps für Autoren, Lektoren und Korrektoren genauer betrachtet.
- Verwende kurze, einfache und leicht zu verstehende Worte. Sei prägnant und klar. Idealerweise:
- solten Absätze nicht mehr als sechs Sätze haben.
- sollten Sätze nicht mehr als 20 Wörter haben, mit Nebensatz nicht mehr als 25 Wörter.
- Sätze sind im Aktiv oder Imperativ. Passiv wird nur verwendet, wenn es notwendig oder angebracht ist. z. Bsp. Tu dies und dann tu jenes. Passiv ist dann angebracht, wenn das Subjekt offensichtlich oder uninteressant ist. z. Bsp. Der Datei Dialog wird angezeigt.
- Der Text ist in der Gegenwart verfasst, Zukunft wird nur verwendet, wenn sie angebracht oder notwendig ist. Beschreibungen sollten zeitlos geschrieben sein. z. Bsp. Der Datei Dialog wird angezeigt. statt Der Datei Dialog wird angezeigt werden. Zukunft wird nur verwendet, wenn ein Ergeignis zwingend nach einem anderen stattfindet. Z. Bsp. Wenn Sie Vorlagen verwenden, werden Ihre Dokumente einfacher zu verstehen sein.
- Die dritte Person, wie z. Bsp. der Benutzer, sollten vermieden werden. Stattdessen sollte die zweite Person (Sie) oder der Imperativ verwendet werden.
- Eine Überstrapazierung der zweiten Person sollte ebenso vermieden werden. Statt Falls Sie Tabellen-Titel haben wollen, machen Sie dies und jenes sagen Sie für Tabellen-Titel wiederholen Sie....
- Falls Anweisungen angebracht sind, nutzen Sie den Imperativ. Z. Bsp. statt Sie sollten keine Umganssprache verwenden, schreiben Sie Verwenden Sie keine Umgangssprache.
- Unter Umständen, in denen die einzige Alternative zu Sie das Passiv ist, verwenden Sie das Passiv. Also statt In diesem Dialog können Sie dies und jenes tun schreiben Sie in diesem Dialog kann dieses und jenes getan werden.
- Verwenden Sie Gender neutrale Schreibweise, aber vermeiden Sie sperrige Formulierungen wie er oder sie. Siehe Seite 8 für einige Beispiele.
- Vermeiden Sie Apostroph-s ('s). Schreiben Sie den Satz ein wenig um, um das Apostroph-s zu vermeiden.
- Vermeiden Sie zusammengezogene Wörter (wie auf das statt auf's, oder ähnliches).
Varianten in Deutsch
Um die Konsistenz zu wahren wird die Rechtschreibung nach Duden verwendet. Siehe auch #Zeichensetzung weiter unten.
In anderen Dokumenten können auch andere (lokale) Schreibweisen oder Zeichensetzungen verwendet werden.
Formulierungen für internationales Publikum
Die Handbücher sind für ein internationales Publikum geschrieben. Daher sollten u. a. diese Dinge berücksichtigt werden.
Datumsformat
Meint 3/12/19 den 12. März 2019 oder den 3. Dezember 2019? Schreiben Sie den Monat immer zumindest teilweise aus. Verwenden Sie Formate wie 3. Dezember 2019 oder 3. Dez. 19.
Zeit
Die Zeit steht im 24-Stunden-Format: 08:00, 18:00.
Jahreszeiten und Feiertage
Jahrezeiten haben in unterschiedlichen Teilen der Welt unterschiedliche Bedeutungen.So ist der Sommer im Januar in der südlichen Hemisphäre. Genausowenig weiß nicht jeder, wann Thanksgiving oder Boxing Day ist (bzw. variiert das Datum von Land zu Land). Daher ist es besser, das konkrete Datum zu nennen, oder zumindest so etwas wie "erstes Quartal" oder so.
Umgangssprache und Kultur
Umgangssprache und Dialekt sollten vermieden werden. Eine Bemerkung, die für den einen normal ist, mag für jemand anderen in einem anderen kulturellen Kontext unverständlich (oder übergriffig) sein. Genauso sollten Verweise auf sportliche Ereignisse oder lokale Gewohnheiten als Teil einer Erklärung vermieden werden.
Klartext
"Klartext" heißt nicht "verblödet". Das Prinzip von Klartext ist, dass die Leser die Worte verstehen und diese konsistent genutzt werden. Technischer Jargon sollte genauso vermieden werden wie unterschiedliche Bezeichnungen für die selbe Sache oder dieselbe Bezeichnung für unterschiedliche Sachen.
Humor
Humor ist mit Vorsicht zu geniessen. Viele humoröse Dinge sind kulturabhängig und daher oft ein Stein des Anstoßes. Zumindest lenkt er vom eigentlichen Sinn der Aussage ab.
Abkürzungen und Akronyme
Technische Abkürzungen und Akronyme sind erlaubt, aber ihre Bedeutung muss klar sein. Um ein Akronym einzuführen, wird es ausgeschrieben, gefolgt vom Akronym in Klammern. Z: Bsp. Application Program Interface (API).
Vermeide i. e., e.g, und etc.
Viele Autoren verwenden lateinische Abkürzungen falsch. Sogar wenn sie selbst diese Abkürzungen verstehen, haben sie in einem deutschen Txt nichts verloren. Deswegen wird deutscher Text verwendet. Findet einen Weg, den Satz ohne diese Begriffe zu verwenden. Hier ist eine Liste mit äquivalenten deutschen Texten:
| Lateinische Abkürzung | Deutsche Entsprechung |
|---|---|
| i.e. | das heißt, insbesondere |
| e.g. | Zum Beispiel |
| etc. | Und so weiter; und so fort |
Definitiv unpassend ist die Verwendung weniger gebräuchlicher Lateinischer Abkürzungen wie "cf." und "q.v". "Vs." wird als "versus" ausgeschrieben; noch besser: Der Satz wird umgeschrieben, um den Gebrauch zu vermeiden.
gebräuchliche Bezeichnungen
Es folgt eine Liste gebräuchlicher technischer Bezeichnungen und ihre korrekte Schreibweise.
| Autokorrektur | Backup / Sicherung | sichern | Bitmap | Checkbox |
| Datenbank | Menüleiste | Laufwerk | drop down | drop-down |
| Dateiname | Webseite | Laufwerk | Hardware | |
| Werkzeugleiste | Unterdokument | Quelltext | Tastatur | Metadaten |
| Multitasking | Online | LibreOffice | Quelloffen | überschreiben |
| Passwort | einstöpseln | Einstöpel- | aufploppen | Aufplopp- |
| PostScript | Programm | Software |
Zeichensetzung
Alle Kopfzeilen haben grammatikalisch richtige Zeichensetzung. Genausowie die folgenden Einträge:
- spezielle Querverweise im Text, z. Bsp. Tabelle 1, Anmerkung 2, Abbildung 5
- Beschriftungen zu Abbildungen und Tabellen
- Spalten- und Zeilen-Titel in Tabellen
- Geordnete und ungeordnete Listeneinträge
Querverweise
Für Querverweise in Kopfzeilen und Abbildungen/Tabellen wird die Querverweisfunktion in Writer verwendet (Einfügen > Querverweise). Der Text wird nie kopiert oder Hyperlinks eingesetzt. Wenn Querverweise eingesetzt werden, wird das Wort "Abbildung" oder "Tabelle" geschrieben und die Nummer als Querverweis mit dem Verweistyp "Nummerierung" eingesetzt.
Formatkonventionen
GUI Elemente
Bezeichnungen der Elemente der Benutzeroberfläche (Menüs, Icons, Optionen, Dialog Boxen und Fenster) müssen dem entsprechen, wie sie in der Applikation auftauchen.
Kopfzeile, Titel und Untertitel
Kopfzeilen werden in satzmäßiger Großschift verfasst. D. h., Großbuchstaben werden nur dort verwendet, wo sie gemäß Duden verwendet werden.
Auf einer Ebene werden parallele Konstruktionen für Kopfzeilen verwendet. Zum Beispiel enthält die Kopfzeile in der ersten Ebene immer ein Gerundivum wie Installation.
Kopfzeilen werden nicht nummeriert.
Kapitelnamen (Titel) und Untertitel werden in "überschriftsmäßiger Großschrift" verfasst. Also jeder erste Buchstabe außer bei einigen kleinen Wörtern wie Artikel und kurze Präpositionen werden groß geschrieben.
Kommando Tasten
Die Tastaturvorlage Funktionstasten findet Verwendung.
Kommando Tasten (Tab, Feststelltaste, Steuerung, Umschalt) und Tastenbezeichnungen werden groß geschrieben.
Falls zwei Tasten gleichzeitig gedrückt werden sollen, wird das durch ein "+" ohne ein Leerzeichen vor und nach dem "+" ausgedrückt. Wenn eine Kommando-Taste und ein Buchstabe betroffen sind, wird die Kommando-Taste zuerst genannt. Beispiel: Strg+K.
Listen
Die Einführungsliste endet mit einem Doppelpunkt (:). Einführungslisten können entweder ganze Sätze oder Satzfragmente sein. Einige Vorlagenbücher differenzieren zwischen den beiden Typen und erfordern unterschiedliche Zeichensetzungen am Ende (oder auch gar keine); andere, wie dieses Handbuch, machen da keinen Unterschied. Falls der letzte Satz vor der Liste nicht direkt in die Liste mündet, sollte der Satz mit einem Punkt enden.
Richtlinien zur Erstellung von Listeneinträgen:
- Der erste Buchstabe in einer Liste wird groß geschrieben.
- In einer Liste mit kompletten Sätzen stimmt auch die Zeichensetzung am Ende des Satzes. 😊
- In jeder Liste mit Satzfragmenten steht am Ende des Listenpunktes und am Ende der Liste kein Satzzeichen.
- Mischungen aus ganzen Sätzen und Satzfragmenten sollten tunlichst vermieden werden.
Menüeinträge
Die Zeichenvorlage Starke Betonung findet Anwendung. In mehrstufigen Listen kommt ein ">" mit einem Leerzeichen davor und danach zwischen den Namen der Untermenüs zum Einsatz. Z. Bsp. Ansicht > Symbolleisten > Objekte ausrichten.
Die Menüpunkte werden so übernommen, wie sie auf dem Bildschirm auftreten (inklusive vorhandener Großbuchstaben). Folgende Auslassungspunkte (z. Bsp. wird ein Menüpunkt, der als "Präferenzen..." aufgeführt wird, einfach als "Präferenzen" übernommen) werden nicht übernommen.
Ablauf Beschreibungen
Um einen einzelnen Ablauf zu beschreiben, werden Menüeinträge verwendet. Falls ein Ablauf mehrere Möglichkeiten hat und es einfacher ist, das Kontextmenü, ein Symbol oder eine Tastenkombination zu verwenden, kann diese Information auch angesprochen werden.
Es sollte nicht jede Möglichkeit eines Ablaufes bei jeder Beschreibung angesprochen werden.
Die einzelnen Schritte werden nummeriert, wobei nicht mehr als zehn Schritte verwendet werden sollten.
Jeder Schritt ist kurz und steht für eine Aktion, so dass der Leser dem Ablauf leicht folgen kann. Ausnahme: ein Schritt kann mit "und gehe auf OK" oder "und drücke Enter" abgeschlossen werden.
Beschreibe einen Schritt mit einem kurzen Text und optischen Hinweisen. Der Leser kann erkennen, was nach einem Schritt passiert.
Screenshots oder andere Abbildungen können helfen, einen Schritt zu erklären. Screenshots sollen auf Entscheidendes hinweisen. Ablenkungen werden entfernt.
Tipps, Anmerkungen und Warnungen
Ein Tipp beschreibt praktische, aber nicht-essentielle Informationen, die anderweitig nicht in den Text passen, z. Bsp ein alternativer Weg, einen Schritt in einem Ablauf zu beschreiten.
Eine Anmerkung bringt relevante, verstärkende oder andere spezielle Hinweise, z. Bsp. ein Beispiel oder einen Kommentar.
Eine Warnung ist ein obligatorischer Text, der Nutzer vor Unfällen und Hard- und Software vor Beschädigungen schützt. Die Warnung steht vor der Information, die Gefahren birgt. Erst werden mögliche Schäden an Daten, Ausrüstung oder Personal beschrieben. Dann folgen Aktionen, die vor der Gefahr schützen.
Texte von Tipps, Anmerkungen und Warnungen werden kurz und relevant gehalten.
Die Anzahl an Tipps, Anmerkungen und Warnungen sollte auf nicht mehr als ein oder zwei pro Seite beschränkt sein. Im Zweifel sollte der Text reorganisiert werden, um die Anzahl zu reduzieren.
Nutze angemessene Absatzvorlagen für Kopfzeile und Text in Tipp, Anmerkung und Warnung.
Grafiken und Bilder
Siehe Kapitel 2, LibreOffice-Handbücher erstellen zu technischen Informationen zum Einfügen, Verankern und bilden von Bildlegenden.
Der Duden gibt die gültigen Rechtschreibregeln vor.
Es können Screenshots aus jedem Betriebssystem verwendet werden.
Unser Standard Zeichensatz ist Colibre. Es kann sein, dass dieser Zeichensatz nicht auf jedem Computer vorinstalliert ist.
Auf Betriebssystemen (wie macOS), in denen LibreOffice die Wahl zwischen LibreOffice Dialogen und Betriebssystem spezifischen Dialogen lässt, wählen Sie besser die LibreOffice Dialoge. Diese Einstellung findet sich in Extras > Optionen > LibreOffice > Allgemein (unter macOS LibreOffice > Präfefrenzen > LibreOffice > Allgemein) im Abschnitt Dialoge zum Öffnen/Speichern.
Dateiformate
Für Screenshots werden PNG- und BMP-Formate verwendet und für Fotos JPEG. Im Zweifel sollte PNG verwendet werden (LibreOffice speichert BMP als PNG.)
Farbwahl
Alle Grafiken müssen im Schwarzweissdruck leicht lesbar sein. Das ist insbesondere bei Tortengrafiken und normalerweise farbigen Grafen der Fall.
Größe und Platzierung von Screenshots
Zeigen Sie nur, was für Ihre Nachricht wichtig ist; schneiden Sie unwichtige Teile der Screenshots weg.
Soweit ohne Verschlechterung des Bildes möglich, sollte die Bildergröße unter 15 cm (5,9 Zoll) liegen.
Beschriftung
- Bilder, Zahlen, Tabellen usw. sollten Beschriftungen haben. Mit folgenden Ausnahmen:
- Wenn sich eine Zahl in einer Tabelle befindet und die nächstgelegene Zelle die Zahl erklärt.
- Wenn eine Zahl (oder ein Bild einer Symbolleiste) direkt einer Überschrift folgt, die die Zahl beschreibt.
- Wenn eine Grafik (oder ein Symbol) sehr klein ist und neben oder innerhalb eines Textes ist, der sie beschreibt.
- Für größere Konsistenz sollte die Beschriftungs-Funktion in Writer genutzt werden.
- Regeln zur Bildbeschriftung:
- Beschriftete Bilder, Zahlen aund Zeichnungen heissen "Abbildung", nicht "Illustration" oder haben andere Namen.
- Bildbeschriftungen liegen unter Bildern, Abbildungen und Zeichnungen und über Tabellen oder Listen.
- Alle Abbildungen mit Beschriftungen werden über eine Bereichs-Variable nummeriert; niemals über Abbildungs- oder Tabellen-Nummern. Die Beschriftung in Writer verwendet Bereichs-Variablen automatisch.
Zeichensetzung
Es finden die hochdeutschen Rechtschreibregeln Anwendung. Zum Beispiel kommen Punkte und Kommas ausserhalb von Anführungszeichen zur Anwendung. Oft kann auch der Satz umgeschrieben werden, um Anführungszeichen zu vermeiden. Oder der zitierte Text wird kursiv geschrieben (betonter Zeichensatz).
Textvorlagen (Tipps für Autoren, Lektoren und Editoren)
Dieser Abschnitt enthält Vorschläge, um Ihre Arbeit als Autor, Lektor oder Editor von LibreOffice Handbüchern zu verbessern. Die Begriffe Lektor und Editor sind in diesem Dokument meist austauschbar. In traditionellen unternehmensinternen technischen Handbüchern ist der Editor ein spezieller Lektor; ein anderer Typ des Lektors ist der Spezialist, der die technische Richtigkeit eines Dokumentes überprüft. In der ehrenamtlichen Open Source Welt von LibreOffice füllt oft dieselbe Person beide Rollen.
Sichten auf das Dokument
Es gibt grundsätzlich drei Sichten auf das Dokument:
- Inhalt: Macht die Applikation generell das, was im Dokument beschrieben ist? Sind die Programmpunkte komplett und korrekt beschrieben? Entsprechen die Bezeichnungen im Dokument denen in der Applikation?
- Struktur: Macht der Aufbau des Dokumentes Sinn? Machen die Erklärungen Sinn? Sind die Diagramme klar? Kann ein spezielles Konzept besser erklärt werden?
- Format: Hat das Dokument korrekte Ausdrucksweise, Grammatik und Zeichensetzung? Nutzt es Vorlagen und Stile angemessen?
Beim Gedanken an die Änderungen denken die meisten an das Kopier-Ändern, was die Format-Sicht betrifft. Aber Inhalt und Struktur begutachten (das sogenannte substantielle Ändern) sind wichtige und notwendige Komponenten für ein Projekt wie das Handbuch Projekt. Und natürlich sind Autoren von allen drei Aspekten ihrer Dokumente betroffen.
Inhalt
Die technischen Fakten aus dem Dokument sollten überprüft werden. Manchmal heißt das, Nachforschungen anzustellen (z. Bsp. Entwickler um Informationen zu fragen). Trotzdem können die Fakten meistens durch einfaches Ausprobieren überprüft werden.
- Stimmen die Namen der Bildschirmelemente (Menus, Symbole, Optionen, Dialog Felder und Fenster) mit der Applikation überein?
- Stimmen die Schritte in der Ablaufbeschreibung mit dem überein, was auf dem Bildschirm stattfindet?
- Fehlen Schritte?
- Ist die beschriebene Genauigkeit angemessen für den Durchschnittsnutzer (nicht zu viel und nicht zu wenig)?
Struktur
Überprüfe die Struktur des Dokumentes. Ist die Struktur des Dokumentes klar? Fehlt etwas, das erwähnt werden sollte? Macht die Erklärung Sinn? Ist das Diagramm klar? Kann dieses Konzept besser erklärt werden?
Wo möglich sollten Begutachter neues Material hinzufügen oder bestehendes Material überarbeiten. Nicht nur den Vermerk "muss überabreitet werden" bringen. Bei Fragen und Unklarheiten kann es trotzdem hilfreich sein, das Problem zu benennen.
Alternativen zur Prosa
Traditionelle Prosa (Sätze, Absätze) ist nicht immer der beste Weg, ein Konzept zu vermitteln, selbst wenn sie gut geschrieben ist. Einige empfehlenswerte Alternativen sind:
- Ungeordnete und geordnete Listen.
- Tabellen und Matrizen.
- Diagramme, Ablaufpläne und Logik-Bäume.
- Bilder und Grafiken.
Ihnen sind diese Konzepte vermutlich vertraut. Daher wird hier nur ein kurzer Hinweis auf den Unterschied zwischen geordneter und ungeordneter Liste gegeben:
- Geordnete Listen werden für einen sequentiellen Ablauf verwendet. Z. Bsp. zur Auflistung eines Schritt-für-Schritt-Ablaufes.
- Ungeordnete Listen werden für nicht-sequentielle Listen verwendet. Z. Bsp. zur Auflistung unterschiedlicher Möglichkeiten, eine Aufgabe anzugehen. Oder auch einer Reihe von Aktionen, die nicht in einer speziellen Reihenfolge ausgeführt werden müssen.
Die folgenden Beispiele illustrieren den Gebrauch einiger dieser Alternativen.
Beispiel für Standard-Prosa
Die gegenseitige Begutachtung ist für die LibreOffice Handbücher sehr wichtig. Ein Dokument beginnt sein Leben wie "ausgecheckt". D. h., der Autor arbeitet daran. Wenn das Dokument fertig zur Begutachtung ist, lädt der Autor es in dern Entwurfsordner dieses Buches. Als nächstes lädt ein Begutachter das Dokument herunter und macht Änderungen. Wenn die Änderungen erledigt sind, lädt der Begutachter die geänderte Datei in den entsprechenden Feedbackordner. Der Begutachter informiert den Autor durch die Liste.
Beispiel einer ungeordneten und geordneten Liste
Die gegenseitige Begutachtung ist für die LibreOffice Handbücher sehr wichtig. Gegenseitige Begutachtung beinhaltet die folgenden Schritte:
- Ein Dokument beginnt sein Leben wie "ausgecheckt". D. h., der Autor arbeitet daran.
- Wenn das Dokument fertig zur Begutachtung ist, lädt der Autor es in dern Entwurfsordner dieses Buches.
- Der Begutachter lädt das Dokument herunter und macht Änderungen. Wenn die Änderungen erledigt sind, wird der Begutachter:
- die geänderte Datei in den entsprechenden Feedbackordner hochladen
- den Autor durch die Liste informieren
Diagramme, Ablaufpläne und Logik-Bäume
Ein gut geplantes Diagramm kann signifikant zu einer Erklärung beitragen. So wie in diesem Beispiel:
Dieses Beispiel beinhaltet nicht alle Informationen zum Prozess (z. Bsp. " wo wird die Datei bereitgestellt?"). Daher wird das Diagramm zusätzlich zu anderen Formen der Erklärung verwendet.
Geschlechtsneutrale Sprache
Geschlechtsneutrale Sprache ist nicht nur ein Fall von "politischer Korrektheit". Unser Ziel ist es, Informationen in einer klaren, verständlichen Form zu vermitteln. Falls das Dokument mehrdeutig, offensiv oder frustrierend für einen Teil der Leserschaft ist, dann läuft das einer klaren Kommunikation zuwider. Geschlechtsneutrale Sprache zu verwenden heisst nicht, falsche Grammatik zu verwenden, unpassende Phrasen (wie er oder sie) oder Unwörter wie er/sie/es zu verwenden. Falsche oder erfundene Phrasen sind weder unser Ziel noch das Ergebnis geschlechtsneutraler Formulierungen.
Was zu vermeiden ist
- Vermeide er als generisches Pronomen; verwende es nur in Bezug auf männliche Personen.
- Vermeide sie als generisches Pronomen; verwende es nur in Bezug auf weibliche Personen.
- Am besten ist es immer noch, die Sätze umzuschreiben.
- Vermeide Phrasen wie er oder sie und er/sie oder Konstuktionen wie die Endung *in oder ähnliches.
- Verwende keine weibliche Form (wie Kaufleutinnen) wenn die normale Form (Kaufleute) beide Geschlechter abdeckt.
Was ist zu tun
A propos 'vermeiden': hier sind einige Vermeidens-Techniken:
Umgehe das Geschlechter-Problem, wo immer möglich. Z. Bsp. bei Prozeduren und Anweisungen kann der Leser direkt angesprochen werden:
Anweisungsmodus (Mach es so.).
Zweite Person (Du/Sie) statt der dritten Person (er, der User).
| Nein | Um sich einzuloggen muss der User sein Login und sein Passwort eingeben. |
| Ja | Um sich einzuloggen, geben Sie bitte Login und Passwort ein. |
Vermeide Pronomen komplett soweit möglich. Versuche folgende Techniken:
Wiederhole das Nomen (manchmal macht das die Bedeutung deutlicher):
| Nein | Technische Dokumentation existiert für den Leser. Sie schreiben für ihn, nicht für Ihr Ego. |
| Ja | Technische Dokumentation existiert für den Leser. Sie schreiben für den Leser, nicht für Ihr Ego. |
Verwende stattdessen ein/e oder der/die/das:
| Nein | Der Autor muss sein Publikum im Blick behalten. |
| Ja | Der Autor muss das Publikum im Blick behalten. |
Schreiben Sie den Satz bzw. den Absatz um. In einigen Fällen kann der Satz umgeschrieben werden:
| Nein | Jeder User hat sein eigenes Login und Passwort. |
| Nein | Jeder User hat seine eigenen Login und Passwort. (mehrdeutig) |
| Ja | Jeder User hat ein persönliches Login und Passwort. |
Verwende eine Mischung aus männlichen und weiblichen Namen und Szenarien in Beispielen. John kann dann z. Bsp. für er und Mary als sie verwendet werden.
Titel
Manche Titel sind geschlechtsneutral (Kaufleute, ...). Aber manchmal müssen geschlechtsneutrale Alternativen gefunden werden (z. Bsp. "Personal" statt "Verkäufer").
Die Betonung liegt auf dem Wichtigen im Satz
Der Text soll direkt, klar und prägnant sein. Z. Bsp. können Sätze mit es gibt, da ist, oder da sind durch direktere Versionen ersetzt werden, da diese Phrasen den Leser vom eigentlichen Inhalt des Satzes ablenken.
Beispiele
| Nein | Es gibt eine Gebühr von € 150,-- für diesen Kurs. |
| Ja | Die Gebühr für diesen Kurs beträgt € 150,--. |
| Nein | Es gibt Navigations Knöpfe oben am Bildschirm. |
| Ja | Die Navigationsleiste ist oben am Bildschirm. |
| Ja | Nutzen Sie die Navigationsleiste oben am Bildschirm. |
| Nein | Es gibt drei Möglichkeiten, ein Bild einzufügen . . . |
| Ja | Bilder können wie folgt eingefügt werden: . . . |
So weit, so gut. Diese Beispiele sind nicht schwer zu ändern, einige andere Möglichkeiten für da gibt es, da sind, und da ist sind schwer zu ersetzen. Änderungen schreiben daher oft den ganzen Satz um.
Tipps für Lektoren
Eine Checkliste zum Überprüfen oder Bearbeiten eines Kapitels im Handbuch.
Zeichne Deine Änderungen auf
Zeichne Deine Änderungen beim Querlesen oder Ändern des Dokumentes auf. Der Autor kann dann Deine Änderungen leicht erkennen und sie akzeptieren oder zurückweisen.
Um Änderungen aufzuzeichnen, wähle Bearbeiten > Änderungen Verfolgen > Aufzeichnen (Bearbeiten > Änderungen Verfolgen > Zeigen ist auch möglich. Damit werden aber Änderungen im Seitenumbruch erzeugt.)
Verwende Kommentare, um Anmerkungen zu setzen
Eher Kommentare zu einem Absatz als Änderungen am Text? Bitte nicht direkt im Fließtext des Dokumentes. Stattdessen bitte die "Kommentar"-Funktion verwenden. Einfügen > Kommentar anwählen und den Kommentar in der Textbox hinterlegen. Die Initialen und ein Zeitstempel werden automatisch angefügt. Jeder Lektor kann nun auf die Kommentare antworten.
Trenne verschiedene Arten des Rezensierens
Versuche nicht, alles auf einmal zu korrigieren; es bremst Dich aus. Mach mehrere Durchgänge. Bei jedem Durchgang überprüfe etwas anderes: Inhalt, Logik, Sprache. Eine andere Möglichkeit wäre, in mehreren Durchgängen mehrere Aspekte zu kontrollieren. Z. Bsp. in einem Durchgang die Grammatik und in einem zweiten Durchgang die Zeichensetzung.
Einige überprüfen erst die einfachen Dinge (wie Zeichensetzung und Einsatz von Vorlagen) so dass diese Dinge nicht vom Eigentlichen ablenken. Andere machen erst das Wichtigste, so dass sie keine Ressourcen an Dinge verschwenden, die sie später sowieso löschen oder ändern. Wähle die Strategie, die am besten zu Dir passt.
Andere Tips
- Bearbeite in kleinen Dosen, mache viele Pausen. Teile die Aufgabe in machbare Teile. Bearbeite nicht mehr als eine Stunde ohne Pause.
- Versuche, den Inhalt nur einmal durchzulesen. Überfliege ihn nur, wenn Du andere Probleme in anderen Passagen bearbeitest.
- Halte Ausschau nach paarweisen Symbolen - Klammern und Anführungszeichen zum Beispiel. Schreiber vergessen oft das zweite Zeichen eines Paares.
- Lies den Text außerhalb des Zusammenhanges. Oder rückwärts. Rückwärts lesen hilft, ein Wort als Gruppe von Buchstaben zu sehen und nicht als Teil eines Satzes.
Tips für Autoren
Hier sind einige Vorschläge zum Erstellen von Dokumenten.
- Beginne mit dem leichtesten Teil. Du brauchst nicht mit dem Anfang zu starten und in einem Zug bis zum Ende durchzuschreiben.
- Mancher beginnt mit den Überschriften. Andere schreiben erst viel Text und organisieren ihn später. Schreibe, wie es für Dich am besten passt. Manchmal ist die eine oder andere Überschrift nicht schlecht. Sie hilft, an alles zu denken, was in das Dokument gehört.
- Heb Dir die Einleitung für den Schluß auf. Dann bist Du Dir sicher, was im Rest des Dokumentes steht.
- Wenn Englisch (oder Deutsch 😊) nicht Deine Muttersprache ist: macht nichts. Lektoren können Dir helfen, Formulierungen, Grammatik und Rechtschreibung (sowie alle anderen Aspekte) zu korrigieren. Das stimmt auch für Muttersprachler.
- Denke an den Durchschnittsuser. Was für Dich offensichtlich ist, muss nicht auch für jemanden mit weniger Erfahrung offensichtlich sein.