Beste antwoord
Er zijn zoveel verschillende soorten technische documenten dat het bijna onmogelijk is ze hier allemaal op te noemen.
Tijdens mijn lange carrière als technisch schrijver, heb ik persoonlijk meer dan 15 verschillende soorten technische documenten geschreven, variërend van het ene project tot het andere.
Op het meest abstracte niveau kunnen technische documenten gecategoriseerd worden in degenen die zijn geschreven voor de interne gebruikers en externe eindgebruikers .
Een Systeemconfiguratiehandleiding is bijvoorbeeld een voorbeeld van een “intern” document, terwijl een Installatiehandleiding is een voorbeeld van een “externe eindgebruiker” -document.
Een API-gids kan zowel voor interne en externe gebruikers. Een Snelstartgids is daarentegen bijna altijd bedoeld voor externe eindgebruikers.
Ik heb Gebruikershandleidingen , Handleidingen voor probleemoplossing , Referentiebladen , Release-opmerkingen , (bewerkt) Documenten met marketingvereisten (MRD), Architectuur- en technische documenten (A&E Doc), Help-bestanden , Standard Operation Procedure (SOP) handleidingen en meer.
U bent van harte welkom om Technical Communication Center voor meer en gratis informatie over al deze verschillende soorten technische documenten.
Antwoord
Er zijn verschillende manieren om de soorten technische documentatie die er bestaan te categoriseren. Ik pretendeer ze niet allemaal te kennen, maar de twee algemene categorieën die u kunt gebruiken om technische documentatie te categoriseren, zijn de gebruiker en het gebruiksscenario.
Met de gebruiker bedoel ik wat type gebruiker zal het document gebruiken? Is het een beheerdershandleiding, of een zelfstudie, of een gebruikershandleiding? Met deze kennisniveaus wordt rekening gehouden bij het ontwerpen van een document. Een beheerdershandleiding gaat ervan uit dat de persoon die het document leest iets meer weet dan de lezer van de tutorial.
Met “use case” bedoel ik waarvoor het document wordt gebruikt? Dit kan variëren van militaire documentatie over het lanceren van een raket tot documentatie voor ontwikkelaars over het gebruik van een grafische API om een videogame te ontwikkelen.
Als je je vraag kunt beperken, kan ik misschien om u meer te geven van wat u zoekt.