Beste svaret
Det er så mange forskjellige typer tekniske dokumenter at det er nesten umulig å liste dem alle her.
I løpet av min lange karriere som teknisk forfatter må jeg personlig ha skrevet over 15 forskjellige typer tekniske dokumenter, varierende fra ett prosjekt til et annet.
På det mest abstrakte nivået kan tekniske dokumenter kategoriseres i de som er skrevet for interne brukere og eksterne sluttbrukere .
For eksempel er en Systemkonfigurasjonsveiledning et eksempel på et «internt» dokument, mens et Installasjonsveiledning er et eksempel på et “ekstern sluttbruker” -dokument.
En API-guide kan være både for intern og eksterne brukere. En Hurtigstartveiledning er derimot nesten alltid ment for eksterne sluttbrukere.
Jeg har skrevet Brukerveiledninger , Feilsøkingsveiledninger , Referanseark , Versjonsmerknader , (redigert) Dokumenter for markedsføringskrav (MRD), Arkitektur- og ingeniørdokumenter (A&E Doc), Hjelpefiler , Standardoperasjonsprosedyre (SOP) manualer og mer.
Du er velkommen til å besøke Technical Communication Center for mer og gratis informasjon om alle disse forskjellige typene tekniske dokumenter.
Svar
Det er forskjellige måter å kategorisere hvilke typer teknisk dokumentasjon som finnes. Jeg later ikke til å kjenne dem alle, men de to hovedkategoriene du kan bruke til å kategorisere teknisk dokumentasjon, er brukeren og brukssaken.
Med «brukeren» mener jeg det bruker bruker dokumentet? Er det en administratorveiledning, eller en veiledning eller en brukerveiledning? Disse kunnskapsnivåene tas i betraktning når du designer et dokument. En administratorhåndbok antar at personen som leser dokumentet vet litt mer enn leseren av opplæringen.
Med «use case» mener jeg hva brukes dokumentet til? Dette kan variere fra militærdokumentasjon om hvordan man starter en missle helt til utviklerdokumentasjon for hvordan man bruker et grafisk API til å utvikle et videospill.
Hvis du kan begrense spørsmålet ditt, kan jeg kanskje være i stand til for å gi deg mer av det du leter etter.