ddofer/schreiben-für-leser

Schreiben für Leser

Dein Leser war nicht dabei. Er kennt das Fachgebiet, nicht dein Projekt, und er überfliegt. Für die Wortwahl verwende plain-words.

• Überarbeitung, Korrektur oder Aufräumen eines bestehenden Papers, Berichts oder einer Seite: Befolge references/editing-pass.md mit den untenstehenden Regeln als Checkliste.
• Schreiben oder Überarbeiten eines Papers: Lies auch references/paper.md.

Reihenfolge

• Beginne mit dem Ergebnis: Was passiert ist, und wie groß es ist. Überschreibe die neue Idee oder Fähigkeit; ein Vergleich führt nur dann, wenn er der Beitrag ist. Öffne mit dem Problem nur, wenn eine Einleitung nötig ist; niemals mit einer generischen. Erzähle keine Projektgeschichte oder ein Protokoll dessen, was ausgeführt wurde.
• Überschriften formulieren die Behauptung in einem Bericht („Günstigere Tarife verkaufen mehr“, nicht „Preisanalyse“); ein langer Bericht beginnt mit einer nummerierten Liste der Ergebnisse.
• Zusammenfassungen und Tl;drs bleiben auf hohem Niveau: Ergebnisse in Worten, die Zahl, die ein Leser zitieren würde, Nullen in Worten, warum jedes wichtig ist. Passe die Länge an die Anforderung an. Ende mit einer einfachen Behauptung, an die sich der Leser erinnern wird.
• E-Mails und Übergaben sind eine kurze Entscheidungsliste: Was zu tun ist, wie schwierig jede Reparatur ist, welche Option am wenigsten manuelle Arbeit erfordert.
• Der Haupttext steht für sich allein. Definiere jeden Begriff und jeden Vergleich dort, wo er zum ersten Mal auftritt, niemals zuerst im Anhang. Ein langer Bericht endet mit einem kurzen Glossar.

Inhalt

• Gib jeder Zahl etwas zum Vergleichen: „25,6 % Genauigkeit (Zufallswahrscheinlichkeit 10 %)“.
• Sage, wie groß ein Ergebnis ist, selbst wenn es klein ist.
• Zeige ein echtes Beispiel pro Ergebnis. Behalte Fallstudien, Überraschungen und geprüfte negative Ergebnisse bei.
• Erkläre eine Methode einmal, dort, wo sie zuerst auftaucht: Ein Satz dazu, wie; warum nur, wo der Leser sonst fragen oder irregeführt werden würde. Lege Ausschlüsse offen, die die Population oder den Nenner definieren; verteidige keine Routineentscheidungen.
• Keine Inhaltswarnungen oder Hinweise auf den eigenen Prozess, es sei denn, das Format oder der Nutzer verlangt danach. Wenn ein Schwellenwert oder eine Teilmenge nach dem Betrachten der Ergebnisse ausgewählt wurde, formuliere die Regel einmal klar.
• Nenne eine Grenze einmal, neben der Behauptung, die sie einschränkt, und nur, wenn sie ändert, was der Leser glauben sollte. Behalte Bedingungen bei, die das Ergebnis definieren („nur 2024“). Ein einzelner knapper Fehlschlag unter einer Robustheitsprüfung macht keine Schlagzeile zunichte; eine Umkehrung schon.
• Schränke eine Überbeanspruchung ein, anstatt sie abzuschwächen: Behalte den festen Teil, lasse den wackeligen Teil weg.
• Sabotiere das Ergebnis nicht. Gib nichts über das hinaus zu, was die Daten zeigen. Füge keinen Kontrast hinzu, nach dem niemand gefragt hat, es sei denn, er ändert, was der Leser glauben sollte. Wenn eine Prüfung eine Geschichte schwächt, schlage vor, die Analyse zu korrigieren oder zu erweitern, bevor du sie abschwächst oder verwirfst; ändere die Analyse nicht selbst.
• Keine dichten Blöcke. Ein Absatz macht einen Punkt und kann einmal, in einem Zug gelesen werden. Teile einen Absatz, der Ergebnisse oder Bedingungen stapelt; eine Reihe von Zahlen kommt in eine Tabelle oder eine Liste. Aufzählungspunkte sind in Ordnung, wenn die Elemente parallel sind.
• Eine Geschichte. Lasse Nebengeschichten weg. Nebenprüfungen und Ausnahmen bekommen einen Satz im Haupttext; ihre Details kommen in einen Anhang.
• Vergleiche Gleiches mit Gleichem. Zahlen aus verschiedenen Datensätzen oder von verschiedenen Personen bekommen einen eigenen Satz oder eine eigene Tabelle. Setze sie niemals nebeneinander, als ob das eine das andere verursacht hätte.
• Alles muss sich selbst rechtfertigen. Jedes Wort, jeder Satz, jeder Absatz, jedes Listenelement, jeder Abschnitt, jede Tabellenspalte, jede Abbildungstafel und jede Beschriftungsklausel muss ändern, was der Leser glaubt oder wie er etwas liest. Frage bei jedem: Was würde der Leser ohne es verlieren? Wenn nichts, schneide es; komprimiere es nicht.
• Sage jede Sache einmal. Eine Zahl lebt in einer Tabelle oder im Text, nicht in beiden; im Haupttext oder im Anhang, nicht in beiden. Ein Ergebnis wird einmal vollständig formuliert; die Zusammenfassung, die Einleitung und der Rest wiederholen nur seine Schlüsselzahl.
• Füge nichts hinzu, was nicht in den Quellen steht. Erfinde niemals ein Zitat oder ein Ergebnis; hinterlasse einen markierten Platzhalter für den Autor.

Abbildungen und Tabellen

• Jede Tafel macht einen Punkt, den der Text nicht so gut machen kann. Mache die Metrik, die bessere Richtung und die Ausgangswerte offensichtlich.
• Echte Namen, keine Codes; das einfachste Diagramm; beschriftete Achsen; ein einheitliches Beschriftungsschema, das mit Beschriftung und Text übereinstimmt. Setze eine direkte Beschriftung neben die Reihe, die sie benennt.
• Zeige alle Teilmengen oder formuliere die Regel, die sie ausgewählt hat.
• In einem Bericht sagt der Abbildungstitel, was gezeigt wird. Die Beschriftung sagt, wie man sie liest, und wiederholt nicht die Methoden.

Bevor du es übergibst

Lies es als Leser. Für jeden Satz: Würde er ihn vermissen? Sagt jede Zahl „im Vergleich zu was“? Führe dann plain-words aus. Ändere keine Zahl. Wenn etwas fehlt oder zwei Zahlen nicht übereinstimmen, informiere den Autor, anstatt die Lücke zu füllen.