Skip to content

Handbuch des Testdaten-Generators neu geschrieben (Beta, 31.10.2026) - #317

Merged
Jaegerfeld merged 1 commit into
beta/ux-redesignfrom
beta/manual-rewrite
Oct 31, 2026
Merged

Jaegerfeld merged 1 commit into
beta/ux-redesignfrom
beta/manual-rewrite

Conversation

@Jaegerfeld

Copy link
Copy Markdown
Owner

Was

Das Benutzerhandbuch des Testdaten-Generators ist in allen fünf Sprachen neu geschrieben. Es beschreibt jetzt zuerst den Datenraum in drei Schritten (Fenster und Browser-Seite) und erst danach den klassischen Einzel-ART-Generator.

Anlass (Robert, 31.10.): „die manuals sind noch die alten, wir sollten diese auch gleich neu machen."

Befund vorher

  • Das Handbuch stammte aus dem Mai (Einzel-ART: Workflow-Datei, Parameter, Flow-Muster, ART_A) und hängte die gesamte Beta — Struktur, Stände, Quellen, Geschichten, KI-Entwürfe, Browser, Fenster, Sprachen — als einen Absatz an Kapitel 5b.
  • Fünf Sprachen hießen fünf Kopien des ganzen Aufbaus (rund 1 700 Zeilen); jede Änderung fünfmal.
  • Das Tester-Paket enthielt keine Handbuch-PDFs; der „Handbuch“-Link der Browser-Seite zeigt auf die Site von main, die den Datenraum nicht kennt.
  • <b> in Absätzen wurde nicht fett gesetzt: die Font-Konfiguration registriert keine Familie.

Wie

  • Ein Aufbau, fünf Kataloge: build_content(st, lang) baut jedes Kapitel einmal, die Wörter kommen aus _M[lang] (rund 300 Schlüssel je Sprache). Fehlende Schlüssel fallen im neuen Test auf, nicht erst beim PDF-Bau.
  • Gliederung: 1 Was ist der Generator (zwei Wege) · 2 Start (vier Startdateien des Pakets, Quellcode, Fenster oder Browser, Sprachen) · 3 Der Datenraum in drei Schritten (Szenario, Umfang & Quellen, Erzeugen; neues Bildschirmfoto des Fensters) · 4 Was im Ordner liegt · 5 Die Geschichte verstehen (Rollen, Hinweise der Rollenbindung, E1–E10, Stand-Fenster) · 6 Der Datenraum auf der Kommandozeile · 7 Fortschreiben · 8 Ein einzelner ART (klassischer Generator, verdichtet) · 9 Häufige Fragen · 10 Glossar.
  • Tester-Paket: dev-build.yml legt die Handbuch- und Tutorial-PDFs unter docs/ ins Bündel; TESTER.md nennt sie und erklärt den Link der Browser-Seite.
  • mkdocs: docs/modules/testdata_generator(.de).md zeigt unter „Oberfläche“ zuerst das Datenraum-Fenster.
  • registerFontFamily im Handbuch-Skript, damit <b> fett setzt.

Entscheidungen, die Robert sehen sollte

  • Die Font-Familie gehört eigentlich in docs/_font_config.setup(); dann würden alle Handbücher fett setzen, wo <b> steht, und alle PDFs müssten neu gebaut werden. Hier bewusst nur lokal — Robert entscheidet, ob wir das für alle nachziehen.
  • Der Handbuch-Link der Browser-Seite bleibt auf der veröffentlichten Site; er wird mit dem Merge der Beta nach main richtig. Bis dahin steht das Handbuch im Paket unter docs/.
  • RO/PT/FR sind wie die UI-Texte Entwürfe zur Prüfung durch Muttersprachler.

Geprüft

  • ruff check ., mypy: grün. tests/docs + tests/release: 25 bestanden (darunter der neue Katalog-Test, 7 Fälle).
  • Fünf PDFs neu gebaut (DE 21, EN 20, RO 20, PT 21, FR 21 Seiten), per pypdf-Textsuche geprüft (Kapitelüberschriften je Sprache vorhanden, kein Platzhalter, kein „Workshop“), Seiten gerendert und angesehen: Stern „★“ fehlte im Font → „(empfohlen)“; CLI-Tabelle brach --story …|recovery im Wort → Umbruch am Pipe; Fettdruck jetzt sichtbar.
  • Das Tester-Zip wurde für diesen PR nicht neu gebaut; nach dem Merge ein neuer Dev-Build-Lauf.

Doku

CHANGELOG ([Unreleased], Beta-Block), Archiv Ideen/Archiv/Handbuch-Generator-Neuschnitt_2026-10-31/ (lokal).

Merge nur auf Roberts Wort.

🤖 Generated with Claude Code

Robert (31.10.): „die manuals sind noch die alten, wir sollten diese
auch gleich neu machen". Das Handbuch beschrieb den Einzel-ART-Generator
und hängte die ganze Beta als einen Absatz an Kapitel 5b.

docs/generate_testdata_generator_manual.py: ein Aufbau build_content()
aus fünf Textkatalogen _M[de|en|ro|pt|fr] statt fünf Kopien.
Gliederung: 1 Was ist der Generator (zwei Wege), 2 Start (vier
Startdateien, Fenster oder Browser, Sprachen), 3 Der Datenraum in drei
Schritten (Szenario, Umfang & Quellen, Erzeugen), 4 Was im Ordner
liegt, 5 Die Geschichte verstehen (Rollen, Hinweise, E1–E10,
Stand-Fenster), 6 Kommandozeile, 7 Fortschreiben, 8 Ein einzelner ART
(klassischer Generator), 9 Häufige Fragen, 10 Glossar.

- docs/assets/Datenraum-Fenster.png: Bildschirmfoto Schritt 1 (de)
- registerFontFamily, damit <b> in Absätzen fett setzt
- fünf PDFs neu gebaut (20–21 Seiten), per pypdf und gerendert geprüft
- tests/docs/test_testdata_manual_catalogue.py: gleiche Schlüsselmenge,
  keine leeren Texte, jeder Aufbau baut in jeder Sprache
- dev-build.yml: Handbuch- und Tutorial-PDFs ins Tester-Bündel (docs/)
- TESTER.md: Handbuch im Paket; Link der Browser-Seite zeigt auf main
- mkdocs testdata_generator(.de).md: Datenraum-Fenster als erstes Bild
- CHANGELOG [Unreleased], Beta-Block

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@Jaegerfeld
Jaegerfeld merged commit ab5df70 into beta/ux-redesign Oct 31, 2026
1 check passed
@Jaegerfeld
Jaegerfeld deleted the beta/manual-rewrite branch October 31, 2026 15:44
Jaegerfeld added a commit that referenced this pull request Oct 31, 2026
Aus dem Tester-Paket (gebuendeltes Python, Windows-Konsole cp1252) brach
`python -m testdata_generator --scenario portfolio --lang ro` mit
UnicodeEncodeError an "Spatiu de date" ab; kein Datenraum entstand.
Betroffen sind alle Sprachen mit Zeichen ausserhalb von cp1252 (RO, PT, FR).

__main__.py stellt stdout und stderr vor dem Start auf UTF-8
(ensure_utf8_console, errors="replace"); Streams ohne reconfigure bleiben
unberuehrt. Tests: Streamwechsel, UTF-8/StringIO unveraendert, Ende-zu-Ende
mit PYTHONIOENCODING=cp1252. CHANGELOG unter Unreleased/Fixed.

Befund beim Rauchtest des Pakets vom 31.10.2026; im Paket vom 30.10.
bereits vorhanden (keine Folge von #317).

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant