Documentatie is de andere helft van een tutorial
Sommige mensen kijken, sommige scannen, en zoekmachines indexeren de woorden. Als je een video en een geschreven handleiding los van elkaar maakt, schrijf je dezelfde walkthrough twee keer. Capture begrijpt je tutorial al goed genoeg om de voice-over op te schonen, dus de geschreven versie komt voort uit hetzelfde werk.
Zo werkt Generate guide
- Bewerk de tutorial zoals altijd. Knippen en inkortingen werken door in de handleiding.
- Klik op Generate guide in de editor. Heeft het project nog geen transcript, dan maakt Capture dat eerst.
- Capture schrijft de handleiding op basis van het transcript, bij voorkeur van je geoptimaliseerde voice-over, en je klikken: een titel, een inleiding en genummerde stappen.
- Elke stap krijgt een screenshot uit de opname op het moment dat je klikte, plus een link om naar dat moment in de video te springen.
Pas je de bewerking later aan, dan wordt de handleiding gemarkeerd als verouderd. Genereer hem opnieuw om hem weer gelijk te trekken.
Softwaredocumentatie schrijven als je het liever voordoet
Vraag iemand die een helpcentrum beheert wat documentatie traag maakt, en het antwoord is nooit het typen. Het gaat om de volgorde van de stappen bepalen, de voorwaarde onthouden die je automatisch overslaat, en een scherm uit je geheugen zo precies beschrijven dat een vreemde het kan volgen.
De taak voordoen lost alle drie op. Je voert de stappen in de juiste volgorde uit omdat het product je daartoe dwingt, de voorwaarde verschijnt omdat je hem echt uitvoert, en het scherm wordt nauwkeurig beschreven omdat de opname het scherm is. Daarna bewerk je een concept in plaats van naar een lege pagina te staren.
Goede documentatie heeft nog steeds iemand nodig die bepaalt wat belangrijk is. Alleen hoeft die persoon niet meer zijn eigen klikken uit te typen.
Waar dit past in Braiv Capture
Handleidingen zijn een long-tail-functie van Braiv Capture, gebouwd op voice-overoptimalisatie. Handleidingen worden geschreven in de brontaal van de tutorial. Wil je geschreven handleidingen maken van video’s die al op YouTube staan? Bekijk dan YouTube-video naar supportartikel.
