Bedste svar
Der er så mange forskellige typer tekniske dokumenter, at det næsten er umuligt at liste dem alle her.
I løbet af min lange karriere som teknisk forfatter skal jeg personligt have skrevet over 15 forskellige typer tekniske dokumenter, der varierer fra et projekt til et andet.
På det mest abstrakte niveau kan tekniske dokumenter kategoriseres i dem, der er skrevet til interne brugere og eksterne slutbrugere .
For eksempel er en Systemkonfigurationsvejledning et eksempel på et “internt” dokument, mens et Installationsvejledning er et eksempel på et “ekstern slutbruger” -dokument.
En API-vejledning kan begge være til intern og eksterne brugere. En Quick Start Guide er derimod næsten altid beregnet til eksterne slutbrugere.
Jeg har skrevet Brugervejledninger , Fejlfindingsvejledninger , Referenceark , Udgivelsesnoter , (redigeret) Dokumenter til markedsføringskrav (MRD), Arkitektur- og ingeniørdokumenter (A&E Doc), Hjælpefiler , Standardoperationsprocedure (SOP) manualer og mere.
Du er velkommen til at besøge Teknisk kommunikationscenter for mere og gratis information om alle disse forskellige typer tekniske dokumenter.
Svar
Der er forskellige måder at kategorisere de typer teknisk dokumentation, der findes. Jeg foregiver ikke at kende dem alle, men de to hovedbrede kategorier, som du kan bruge til at kategorisere enhver teknisk dokumentation, er brugeren og use case.
Med “brugeren” mener jeg hvad brugertype bruger dokumentet? Er det en administratorvejledning eller en tutorial eller en brugervejledning? Disse niveauer af viden tages i betragtning, når man designer et dokument. En administratorvejledning antager, at den person, der læser dokumentet, ved lidt mere end læseren af selvstudiet.
Med “use case” mener jeg, hvad bruges dokumentet til? Dette kan variere fra militær dokumentation om, hvordan man starter en missle hele vejen til udviklerdokumentation for, hvordan man bruger et grafik-API til at udvikle et videospil.
Hvis du kan indsnævre dit spørgsmål, kan jeg muligvis for at give dig mere af det, du leder efter.