Doku: docs/episode-format.md — Format-Referenz für Mediengestalter #34

New issue

Closed

opened 2026-05-31 23:12:26 +02:00 by holm · 0 comments

holm commented

2026-05-31 23:12:26 +02:00

Owner

Dimension	Bewertung	Einschätzung
Aufwand	`██░░░░░░░░`	Niedrig — eine Markdown-Datei mit Format-Spec + Beispielen
Nutzen	`████████░░`	Hoch — Mediengestalter brauchen Referenz, sonst Format-Drift
Bruchhäufigkeit	`█░░░░░░░░░`	Sehr niedrig
Nachhaltigkeit	`█████████░`	Sehr hoch — Spec ist load-bearing für Generator + Tools
Dringlichkeit	`██████░░░░`	Mittel-hoch — bevor Issue #4 (minijinja) startet, sollten Templates klare Schnittstelle haben

Ziel

Die Konvention für episode.md (aus #5 implementiert) menschenlesbar dokumentieren. Zielgruppe: Mediengestalter, die Episoden befüllen, ohne den Bash-Code lesen zu müssen.

Inhalt der Doku

Verzeichnisstruktur einer Episode (episodes/<slug>/{episode.md, episode.cache.json, audio/, gimmicks/})
Frontmatter-Felder (Pflicht + optional, Typ, Beispiele)
Body-Konvention: Lead-Markdown + ##### HH:MM:SS Titel-Kapitel
Pandoc-Heading-Attribute pro Kapitel: {image="..." url="..."}
Optionaler Markdown-Freitext pro Kapitel (für Beschreibung in podcast:chapters + Podlove)
Speaker-Referenzen + speaker/<id>/speaker.toml-Format
Lifecycle: episode.cache.json (was steht drin, wer schreibt es)
Convenience-Rendering der #####-Marker (Click-to-Play via Media Fragments)
Beispiel: vollständige episode.md einer Mini-Folge

Akzeptanz

Mediengestalter mit Markdown-Erfahrung kann nach Lesen eine Episode anlegen ohne Source-Code-Blick
Spec referenziert von #5 als Konvention-Quelle

| Dimension | Bewertung | Einschätzung | |---|---|---| | Aufwand | `██░░░░░░░░` | Niedrig — eine Markdown-Datei mit Format-Spec + Beispielen | | Nutzen | `████████░░` | Hoch — Mediengestalter brauchen Referenz, sonst Format-Drift | | Bruchhäufigkeit | `█░░░░░░░░░` | Sehr niedrig | | Nachhaltigkeit | `█████████░` | Sehr hoch — Spec ist load-bearing für Generator + Tools | | Dringlichkeit | `██████░░░░` | Mittel-hoch — bevor Issue #4 (minijinja) startet, sollten Templates klare Schnittstelle haben | ## Ziel Die Konvention für `episode.md` (aus #5 implementiert) menschenlesbar dokumentieren. Zielgruppe: Mediengestalter, die Episoden befüllen, ohne den Bash-Code lesen zu müssen. ## Inhalt der Doku - Verzeichnisstruktur einer Episode (`episodes/<slug>/{episode.md, episode.cache.json, audio/, gimmicks/}`) - Frontmatter-Felder (Pflicht + optional, Typ, Beispiele) - Body-Konvention: Lead-Markdown + `##### HH:MM:SS Titel`-Kapitel - Pandoc-Heading-Attribute pro Kapitel: `{image="..." url="..."}` - Optionaler Markdown-Freitext pro Kapitel (für Beschreibung in podcast:chapters + Podlove) - Speaker-Referenzen + `speaker/<id>/speaker.toml`-Format - Lifecycle: `episode.cache.json` (was steht drin, wer schreibt es) - Convenience-Rendering der `#####`-Marker (Click-to-Play via Media Fragments) - Beispiel: vollständige `episode.md` einer Mini-Folge ## Akzeptanz - Mediengestalter mit Markdown-Erfahrung kann nach Lesen eine Episode anlegen ohne Source-Code-Blick - Spec referenziert von #5 als Konvention-Quelle

holm

2026-05-31 23:12:27 +02:00