42 lines
5.2 KiB
Markdown
42 lines
5.2 KiB
Markdown
## Ziel
|
||
Ein deutschsprachiges Sachbuch, das **Verständnis** vermittelt: Wie ist die Sache aufgebaut, warum ist sie so, welche Befunde, Argumente oder Mechanismen stehen dahinter, was ist gesichert, was umstritten? Ziel ist eine breite Übersicht über alles Wichtige, nicht Vollständigkeit bis ins letzte Detail. Kein Tutorial, keine Referenz, kein Ratgeber.
|
||
|
||
## Form
|
||
- Sprache: Deutsch, korrekte Umlaute und ß, gut lesbare Sachbuchprosa. Keine direkte Anrede als Stilmittel; „wir“ sparsam.
|
||
- Satzbau: Sätze meist 14–18 Wörter, selten über 25, nie über 35. Höchstens ein Nebensatz je Satz, keine Semikolon-Ketten. Ein Gedanke je Satz; Bedingung und Folge dürfen zusammenstehen. Aktiv statt Nominalstil. Quellenangaben in Klammern ans Satzende, nicht in die Satzmitte. Das kostet keine Tiefe, nur Verschachtelung.
|
||
- Wortwahl: Verben statt Substantivierungen („prüfen“ statt „eine Prüfung vornehmen“, „wahrnehmen“ statt „die Wahrnehmung erfolgt“). Lange zusammengesetzte Wörter nur, wenn sie der Fachbegriff sind; sonst umschreiben oder bei der ersten Nennung erklären. Keine Füllwörter („grundsätzlich“, „im Wesentlichen“, „durchaus“).
|
||
- Code-Bezeichner im Fließtext nur, wenn der Satz von genau diesem Bezeichner handelt. Erst in Worten erklären, was etwas tut, dann den Namen nennen. Keine Aufzählungen von Methoden- oder Klassennamen im Satz: Solche Listen gehören in eine kleine Tabelle (Name | Zweck) oder in ein Codebeispiel. Faustregel: höchstens ein Bezeichner je Satz, selten zwei.
|
||
- **Keine** Übungen, Selbsttests, Lernziele, Merkkästen, Checklisten, „Praxistipps“, Schritt-für-Schritt-Anleitungen als Selbstzweck, Zusammenfassungen am Kapitelende, Literaturlisten.
|
||
- Überwiegend Fließtext. Listen und Tabellen nur, wo sie echte Klarheit bringen – sparsam.
|
||
- Fachbegriffe bei der ersten Nennung kurz erklären; englische Fachbegriffe nennen, wo sie üblich sind.
|
||
- Konkrete Belege im Text: Studien mit Autor und Jahr („(Curran & Hill, 2019)“), Klassen und Befehle in `Code`-Formatierung, Versionsangaben („seit 4.3“) nur, wenn geprüft.
|
||
- Querverweise „(→ Kapitel 8)“ bzw. „(→ Abschnitt 8.2)“ statt Wiederholung. Die Gliederung zeigt, was wo steht; Themen anderer Kapitel nur kurz streifen und verweisen.
|
||
- Codebeispiele (falls das Thema Software ist): kurz (typisch 5–30 Zeilen), nur wo sie ein Konzept erklären, mit Sprachangabe im Codeblock, im Text erklärt.
|
||
- Hat ein Codebeispiel eine Ausgabe, steht die tatsächliche Ausgabe des eigenen Testlaufs als ```text-Block direkt darunter, gekürzt auf das Wesentliche (höchstens etwa 10 Zeilen).
|
||
- Strukturdiagramme: Baum-, Ablauf- und Zustandsstrukturen, die aus Quellcode oder Doku belegt sind, als Textdiagramm mit Kästen und Pfeilen in einem ```diagramm-Block (Zeichen ┌─┐│└┘├┤┬┴ und ▶ ▼, höchstens 60 Zeichen breit, höchstens eines je Abschnitt). Jedes Element im Diagramm kommt auch im Text vor. Keine Illustrationen, keine Szenen, nichts Erfundenes.
|
||
|
||
## Verständlichkeit für Leser, denen das Thema neu ist
|
||
- Konkret vor abstrakt: Jeder neue Begriff bekommt zuerst eine Situation oder ein Beispiel aus dem Thema, dann die Erklärung, dann den Namen. Nicht mit der Definition beginnen.
|
||
- Begriffsbudget: etwa 5 neue Fachbegriffe oder Klassen je Zwischenabschnitt. Braucht der Stoff mehr, einen weiteren Zwischenabschnitt anlegen. Zwischenabschnitte (###) 200–600 Wörter, nicht kleiner.
|
||
- Interna trennen: Quellcode-Details, Server-Ebene, Speicherlayout, Registrierungsmechanismen, Herleitungen über das Nötige hinaus stehen in einem eigenen Zwischenabschnitt `### Unter der Haube` am Ende des Abschnitts (bei Wissensthemen `### Vertiefung`). Der Abschnitt muss ohne ihn verständlich sein; höchstens einer je Abschnitt. Dieser Teil wird gelesen, nicht übersprungen: Er erklärt den Mechanismus mit derselben Sorgfalt (Beispiel, Erklärung, Name), kein Nachschlagestil, kein Sammelbecken für Dichtes.
|
||
- Ein Begriff, der in einem früheren Kapitel eingeführt wurde, wird bei Wiederverwendung mit einem halben Satz in Erinnerung gerufen, nicht vorausgesetzt.
|
||
|
||
## Aufbau jeder Kapiteldatei (Markdown)
|
||
```
|
||
# Kapitel N – Titel
|
||
|
||
Einleitung: 2–4 Absätze, die ins Thema führen und die Leitfrage stellen.
|
||
|
||
## N.1 Titel des Abschnitts
|
||
Fließtext, ggf. mit ### Unterabschnitten.
|
||
|
||
## N.2 …
|
||
```
|
||
Überschriften exakt wie in GLIEDERUNG.md (Nummerierung beibehalten, ohne das Gewicht `(kurz)`/`(lang)`). Der Richtwert je Abschnitt steht in der Gliederung: `(kurz)` ≈ 800 Wörter, ohne Angabe ≈ 1.300, `(lang)` ≈ 2.000; ±20 % sind in Ordnung. Nicht auffüllen: Ist der Stoff erschöpft, ist der Abschnitt fertig. Abweichungen über 20 % im Bericht begründen.
|
||
|
||
## Korrektheit
|
||
- Jede Tatsachenangabe (Name, Jahr, Zahl, Bezeichner, Signatur, Versionsangabe, Studienergebnis) muss gegen die im Abschnitt „Quellen und Prüfung“ genannten Quellen geprüft sein. Nichts aus dem Gedächtnis übernehmen, ohne es zu prüfen; was sich nicht belegen lässt, vorsichtiger formulieren oder weglassen.
|
||
- Keine erfundenen Studien, Zitate, Zahlen, Klassen oder Optionen.
|
||
- Kontroversen und Replikationsprobleme fair darstellen.
|
||
- Keine persönlichen Daten an externe Dienste senden (keine E-Mail-Adressen als Parameter).
|