update
This commit is contained in:
@@ -3,13 +3,13 @@ SECTION-AUFBAU
|
||||
Jeder Baustein wird GENAU eine Section mit:
|
||||
1. Titel — der Baustein-Titel (kommt aus dem Marker, nicht in den Body schreiben)
|
||||
2. Beschreibung — was es ist, wozu es dient, worauf man achten muss
|
||||
3. Beispiel — kurzes, realistisches Code-/Anwendungsbeispiel mit 1 Satz Einordnung. Weglassen, wenn ein Beispiel für diesen Baustein keinen Mehrwert hat.
|
||||
3. Beispiele — kurze, realistische Code-/Anwendungsbeispiele mit je 1 Satz Einordnung. Ein Beispiel pro relevanter Variante des Bausteins: simple Bausteine haben eines, variantenreiche mehrere. Geordnet vom Üblichen zum Speziellen — Nischenfälle zuletzt. Weglassen, wenn ohne Mehrwert.
|
||||
|
||||
Umfang: so kurz wie möglich, so lang wie nötig — das entscheidet der Baustein, nicht eine Vorgabe. Ein simples Konzept = 2–3 Sätze, ein komplexes darf länger sein.
|
||||
|
||||
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` direkt vor dem Beispiel.
|
||||
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):
|
||||
|
||||
|
||||
Reference in New Issue
Block a user