Dokumentation ist die andere Hälfte eines Tutorials
Manche schauen zu, manche überfliegen, und Suchmaschinen indexieren die Worte. Wer Video und schriftliche Anleitung getrennt produziert, schreibt denselben Walkthrough zweimal. Capture versteht Ihr Tutorial bereits gut genug, um sein Voiceover zu bereinigen – die schriftliche Version entsteht also aus derselben Arbeit.
So funktioniert Generate guide
- Bearbeiten Sie das Tutorial wie gewohnt. Schnitte und Kürzungen werden in die Anleitung übernommen.
- Klicken Sie im Editor auf Generate guide. Hat das Projekt noch kein Transkript, transkribiert Capture es zuerst.
- Capture schreibt die Anleitung aus dem Transkript, bevorzugt Ihr optimiertes Voiceover, und aus Ihren Klicks: ein Titel, eine Einleitung und nummerierte Schritte.
- Jeder Schritt erhält einen Screenshot aus der Aufnahme im Moment Ihres Klicks sowie einen Link, um im Video an diese Stelle zu springen.
Ändern Sie die Bearbeitung später, wird die Anleitung als veraltet markiert. Generieren Sie sie neu, um sie wieder anzugleichen.
Wie Sie Softwaredokumentation schreiben, wenn Sie lieber vorführen
Fragen Sie jemanden, der ein Help Center pflegt, was Dokumentation langsam macht – es ist nie das Tippen. Es ist die Entscheidung über die Reihenfolge der Schritte, das Erinnern an die Voraussetzung, die Sie automatisch überspringen, und das Beschreiben eines Bildschirms aus dem Gedächtnis, präzise genug, dass ein Fremder folgen kann.
Die Aufgabe vorzuführen löst alle drei Probleme. Sie führen die Schritte in der richtigen Reihenfolge aus, weil das Produkt Sie dazu zwingt; die Voraussetzung taucht auf, weil Sie sie tatsächlich erledigen; und der Bildschirm wird genau beschrieben, weil die Aufnahme der Bildschirm ist. Dann bearbeiten Sie einen Entwurf, statt vor einer leeren Seite zu sitzen.
Gute Dokumentation braucht weiterhin einen Menschen, der entscheidet, was wichtig ist. Sie braucht nur niemanden mehr, der seine eigenen Klicks abtippt.
Wo das in Braiv Capture hingehört
Anleitungen sind eine ergänzende Funktion von Braiv Capture, aufgebaut auf der Voiceover-Optimierung. Anleitungen werden in der Ausgangssprache des Tutorials geschrieben. Für schriftliche Anleitungen aus Videos, die bereits auf YouTube sind, siehe YouTube-Video zu Support-Artikel.
