Handboeken, online cursussen, handleidingen en gidsen van de on line help zijn gemeenschappelijke voorbeelden van technische opleiding documentatie. Het doel van dergelijke documentatie is om uit te leggen van de concepten van een software, een product of een systeem aan de eindgebruiker. Hoogwaardige technische opleiding documentatie is gemakkelijk te begrijpen, maar tegelijkertijd geeft de gebruiker een compleet begrip van systeemprocessen en functionaliteit.
Weet de eindgebruiker
De eindgebruiker is het publiek voor wie u de technische documentatie maakt. Het is essentieel om te begrijpen van het publiek goed voordat u erop schrijven gaat. Overwegen zijn behoeften en vaardigheidsniveau, vermogen om te begrijpen van de punten die u zal richten. Alle technische documentatie die dekt niet de vereiste informatie of is te moeilijk te begrijpen is ontoereikend.
Grondig onderzoek
Voordat u begint met schrijven, moet u het product of hulpmiddel die u zal schrijven over begrijpen. Het onderzoeksproces betreft meestal het interviewen van vakexperts die diepgaande kennis over het product hebben. De deskundige onderwerp zou een ingenieur of ontwikkelaar die deel uitmaakte van het team dat het product ontwikkeld. U kunt ook proberen het product of de software zelf.
Notities maken
Het is belangrijk om aantekeningen te maken van elke relevante stukje informatie, met name zeer technische gegevens die moeilijk wellicht te onthouden op een later tijdstip. Regelen van de informatie en het maken van een inhoudsopgave. Controleer of de inhoudsopgave met een deskundige onderwerp en op het eerste ontwerp aan de slag.
Informatieve inhoud maken
Als u stuk samen de gegevens, moet u de vereiste schrijfwijzer ook volgen. Gebruik van actieve stem en Vermijd geen onnodige jargon. Technische opleiding documentatie moet duidelijk en to the point. Het toevoegen van beelden, quizzen en tips met regelmatige tussenpozen. Dit zal de lezer bezet houden en ook het vereenvoudigen van het proces van leren. Als de documentatie how-to procedures of stappen bevat, moet u de procedures zelf uitvoeren en schermopnamen of afbeeldingen opnemen indien nodig. Procedures bijgewerkt elke keer dat de software of het product wordt gewijzigd.
Werken met het Team
Op een regelmatige basis, een ontmoeting met de deskundige onderwerp en uw redacteur (als je die hebt). Hebben ze de inhoud of de hoofdstukken die u hebt gemaakt. Nemen hun feedback en ook in het oog houden voor de inhoud die je bezig bent. Dit proces zal sterk verminderen de werklast aan het einde van het project.
Het eerste ontwerp
Nadat u een voorontwerp van hebt gemaakt, kunt u het naar uw manager, editor, onderwerp deskundigen en ook sommige ontwikkelaars die u meer feedback geven kunnen presenteren. Ieders mening krijgen en nemen de vereiste veranderingen. Houd een kopie van elk concept zodat u kunt teruggaan en ophalen van verwijderde gegevens, indien nodig. Zet jezelf in de schoenen van de lezer en gaan door de documentatie en de volgende vragen: begrijpt u de kernbegrippen? Is de informatie op een logische manier vooruitgang? Is het belang van de inhoud en onderwijzen u? Als het antwoord op deze vragen ja is, u bent erin geslaagd uw doel.
