Het schrijven van een technische handleiding is een eenvoudige taak waarbij stappen worden georganiseerd en duidelijke, beknopte bewoordingen worden geformuleerd. Het doel van een technische handleiding is om informatie te geven over hoe u een bewerking kunt uitvoeren in de minste hoeveelheid stappen en op de meest duidelijke manier. Technische handleidingen omvatten vaak de medewerking van veel mensen, waaronder materiedeskundigen, redacteuren en technische schrijvers. Omdat technische handleidingen ook voortdurend kunnen worden herzien en bijgewerkt, is communicatie tussen de betrokken partijen van cruciaal belang voor de ontwikkeling van een handleiding.
Bepaal de stijl van de technische handleiding door een vereenvoudigde stijlgids te maken of door een bestaande stijlgids te volgen, zoals de Microsoft Style Guide voor technische handleidingen. Een stijlgids helpt het skelet van de handleiding te maken en zorgt voor consistentie.
Schrijf de stappen voor de procedure die begint met een werkwoord. Als overleg nodig is om de stappen, het interview en de vragen van de materiedeskundigen te schrijven. Dit zal de geldigheid van procedures waarborgen; anders zijn stappen misschien niet logisch en / of niet in de juiste volgorde. Stappen moeten logisch worden geordend en gescheiden in logische hoofdstukken of divisies.
Voeg afbeeldingen en illustraties toe aan stappen die deze vereisen. Vergeet niet om nummering en titels toe te voegen aan elke afbeelding / illustratie.
Maak een inhoudsopgave en een index voor eenvoudige naslag.
Voeg een wijzigingslog of bijwerkblad toe dat elke wijziging registreert en update naar de handleiding voor toekomstige herzieningen en releases. Technische handleidingen moeten altijd worden bewerkt door iemand anders dan de technisch schrijver, bij voorkeur door een professionele redacteur.
