Wann sollte ein README ein Produktdemovideo nutzen?
Ein README-Produktdemovideo ist einem kurzen GIF vorzuziehen, wenn ein Repository-Leser eine vollständigere sichtbare Sequenz braucht, als eine kurze Schleife tragen kann. Die Entscheidung hängt von der technischen Frage des Lesers ab, von der zur Beantwortung nötigen Bewegung und vom Repository-Host, in dem das Asset gerendert wird. Es ist keine Aussage, dass Video immer besser ist, dass jedes README Bewegung braucht oder dass ein Format in jedem Repository funktioniert.
GogoScreen beginnt mit einer erreichbaren Web-App-URL und einem einzeiligen Hinweis und liefert dann einen geschnittenen MP4-Kandidaten. Es kann Voiceover passend zu Bildschirmereignissen, Untertitel, Klick-Zooms, Cursor-Glättung und Schnitte von toter Luft hinzufügen. Diese Ablauffakten machen einen MP4-Kandidaten zur Prüfung verfügbar. Sie legen nicht fest, dass ein Host ihn wie beabsichtigt einbettet oder dass ein bestimmter Kandidat für die Repository-Dokumentation geeignet ist.
Der README-Demo-GIF-Leitfaden behandelt bereits die kurze Darstellungswahl für einen scannenden Leser. Diese Seite beantwortet die andere Formatfrage: Wann braucht ein Leser Video, weil die sichtbare Aufgabe, das Detail oder eine optionale Erzählung mehr als eine kompakte Schleife erfordert?
| Repository-Bedarf | Video kann helfen, wenn | Ein kurzes GIF kann noch passen, wenn |
|---|---|---|
| Sequenz | Der Leser mehreren zusammenhängenden sichtbaren Momenten folgen muss | Eine Aktion und ein Ergebnis sofort klar sind |
| Detail | Der Interface-Kontext eine größere oder bewusstere Ansicht braucht | Die gerenderte Schleife lesbar bleibt |
| Audio | Optionale Erzählung genaue Orientierung hinzufügt | Ton für die Kernaussage unnötig ist |
| Dokumentation | Das Asset geschriebene Einrichtung und Grenzen unterstützt | Bewegung das Scannen unterbrechen würde |
