Hoe je een geweldige handleiding maakt

Gebruik deze richtlijnen om echt goede handleidingen te maken waarmee anderen hun spullen gemakkelijk kunnen repareren.

Eender welke handleiding is duizend keer beter dan helemaal geen handleiding. De tips hieronder zijn richtlijnen, geen regels. Ook wij vergeten ze soms allemaal toe te passen, of gaan terug en passen een handleiding nadien nog aan. We zijn allemaal mensen, en maken fouten. De handleidingen zullen beter worden na verloop van tijd, maak je dus geen zorgen als het niet onmiddellijk perfect is. Wees de pionier!

Sterke foto's zullen mensen aanzetten je handleiding te bekijken. Je hebt geen duur materiaal nodig om goede foto's te nemen. Neem een beetje tijd om onze handleiding over het nemen van foto's te lezen voor je aan je fotoshoot begint.

Foto's en tekst zouden elkaar moeten aanvullen. Extra afbeeldingen kunnen gebruikt worden om tekstuele uitleg te verduidelijken, en omgekeerd.

Vage woorden als "ding", "stuk", en "zaak" leiden tot onduidelijke handleidingen. Als je niet weet hoe je een onderdeel moet benoemen, probeer het dan te identificeren met hulp van Google of iemand die je kent. Gadgets kunnen allerlei ingewikkelde onderdelen hebben, een onderdeel omschrijven met "dit ding" helpt niemand vooruit.

De oriëntatie van het voorwerp zou zoveel mogelijk hetzelfde moeten blijven doorheen de handleiding. De lezer kan zo sneller de onderdelen van zijn eigen toestel terugvinden. Als je je toestel draait, voeg dan een verklaring toe als "Draai het toestel om" of "Draai het toestel 90 graden in wijzerzin" om de lezer aan te sporen hetzelfde te doen.

Een beetje achtergrondinformatie is goed: waarom je dit doet, voor wie de handleiding bedoeld is, en wat iemand nodig heeft om ze uit te voeren. Maar houd het daarbij! De meeste internetgebruikers hebben geen zin een boek te lezen voor ze aan de reparatie kunnen beginnen (wanneer heb jij laatst de gebruikershandleiding van je TV gelezen?).

Links zijn je vriend. Verwijs naar alle relevante bronnen die je kan vinden op de site.

Hoeveel we ook houden van verhalen over je overgrootmoeder die ijskreem in haar handtas stak (waargebeurd!), er is een gepast ogenblik voor zulke verhalen. Het midden van een reparatiehandleiding is dat niet.

Pertinente informatie toevoegen verleent je handleiding autoriteit.

Mensen zullen je handleiding niet gebruiken als ze niet verstaan waar je het over hebt.

Je kan veel verwarring veroorzaken door aanduidingstekens als waarschuwingen of herinneringen foutief te gebruiken. Lees de betekenis van elk teken voor je het gebruikt. Kies bij twijfel voor de gewone bullet!

Indien het toestel simpel genoeg is, is hulp om het weer in elkaar te zetten wellicht niet nodig. Maar het opnieuw samenstellen kan ook speciale instructies vergen. Bijvoorbeeld, het LCD scherm uit een Macbook halen is redelijk eenvoudig. Maar als je de bedrading niet juist legt bij het weer in elkaar zetten, zullen de draden niet tot aan hun verbindingspunten op het moederbord reiken. Lezers zullen je heel dankbaar zijn als je zulke kleine maar belangrijke tips geeft om hun toestel weer in elkaar te zetten.

In sommige gevallen volstaan foto's en tekst niet om alles te verduidelijken. Een of twee schema's toevoegen (door ze up te loaded als foto's) zal de lezer helpen met het uitdokteren van zijn reparatie.

Te veel markup toevoegen zal je foto onaantrekkelijk maken voor de lezer. Voeg enkel de markup toe die nodig is om de componenten die je bespreekt te identificeren, als markup überhaupt nodig is. Als je meer dan 4 of 5 stukjes markup moet toevoegen, kan je het misschien beter opdelen in verschillende stappen. In geval van twijfel, bekijk enkele andere iFixit handleidingen.

Beperk je gebruik van titels voor de stappen. Het juist gebruik van vooraf vereiste handleidingen zal automatisch een geschikte navigatiestructuur genereren, zodat titels voor stappen overbodig zijn in de meeste gevallen.

We zijn een team, en dat zou ook uit je handleiding moeten blijken. Je toon straalt meer verbinding en autoriteit uit, als je uitdrukkingen zoals "Ik heb dit gedaan" vermijdt in je handleidingen.

We zijn hier om elkaar te helpen met spullen repareren. Je politieke overtuigingen en andere meningen horen hier niet thuis.

Wees direct in je instructies naar de gebruiker. Trap niet in de "Het is" val, en gebruik actieve werkwoorden om je boodschap over te brengen.

Upload enkel foto's en tekst die jij gemaakt hebt of waarvan je de rechten bezit.

Met dank aan deze vertalers:

100%

Maarten Depypere helpt ons de wereld te herstellen! Wil je bijdragen?
Begin met vertalen ›

Weergavestatistieken:

Afgelopen 24 Uren: 7

Afgelopen 7 Dagen: 19

Afgelopen 30 Dagen: 102

Altijd: 41,450