1.7 KiB
SECTION-AUFBAU
Jeder Baustein wird GENAU eine Section mit:
- Titel — der Baustein-Titel (kommt aus dem Marker, nicht in den Body schreiben)
- Beschreibung — was es ist und wozu: MAXIMAL 1–2 Sätze
- Beispiele — KURZ und SIMPEL: wenige Zeilen Code, das Minimalbeispiel, keine Realwelt-Komplexität. Höchstens 1 knapper Satz Einordnung dazu. Ein Beispiel pro relevanter Variante: simple Bausteine eines, variantenreiche mehrere. Geordnet vom Üblichen zum Speziellen. Weglassen, wenn ohne Mehrwert.
Jede Section ist ATOMAR: allein verständlich, ohne dass der Leser eine andere Section gelesen hat. Test: Ergibt der Text Sinn, wenn man NUR diese Section liest? Verweise auf andere Bausteine sind erlaubt, ihr Inhalt darf aber nie vorausgesetzt werden — benutzte Begriffe in einem Halbsatz auflösen.
Umfang: kurz. Die Länge einer Section kommt aus der ZAHL der Beispiele (Varianten), nie aus langen Texten.
Tonalität: klares Deutsch, direkt, praxisorientiert. Fachbegriffe beim ersten Auftreten kurz erklären. Keine Füllsätze, keine Einleitungsfloskeln.
Markdown im Section-Body: normale Absätze, inline-code für Bezeichner, Codeblöcke mit Sprachangabe, fett sparsam für Kernaussagen. Keine eigenen Überschriften außer ### Beispiel bzw. ### Beispiele vor den Beispielen.
Beispiel einer fertigen Section (nur der Body):
Arrays speichern mehrere Werte unter einem Namen. PHP unterscheidet indizierte Arrays ([0 => 'a']) und assoziative Arrays (['key' => 'wert']) — intern sind beide geordnete Hashmaps.
Beispiel
$preise = ['apfel' => 1.20, 'birne' => 1.50];
$preise['kirsche'] = 3.90; // ergänzen
echo $preise['apfel']; // 1.2
Assoziative Arrays sind der Arbeitsalltag: Datenbankzeilen, Konfiguration, JSON.