Risposta migliore
Esistono così tanti tipi diversi di documenti tecnici che è quasi impossibile elencarli tutti qui.
Durante la mia lunga carriera come redattore tecnico, personalmente devo aver scritto oltre 15 diversi tipi di documenti tecnici, variando da un progetto allaltro.
Al livello più astratto, i documenti tecnici possono essere classificati in quelli scritti per gli utenti interni e utenti finali esterni .
Ad esempio, una Guida alla configurazione del sistema è un esempio di un documento “interno” mentre un Guida allinstallazione è un esempio di un documento “utente finale esterno”.
Una Guida API può essere sia per interni e utenti esterni. Daltra parte, una Guida rapida è quasi sempre destinata agli utenti finali esterni.
Ho scritto Guide per lutente , Guide per la risoluzione dei problemi , Fogli di riferimento , Note sulla versione , (modificato) Documenti sui requisiti di marketing (MRD), Architettura e documenti di ingegneria (A&E Doc), File della guida , Manuali sulle procedure operative standard (SOP) e altro ancora.
Ti invitiamo a visitare il Centro di comunicazione tecnica per maggiori informazioni gratuite su tutti questi diversi tipi di documenti tecnici.
Risposta
Esistono diversi modi per classificare i tipi di documentazione tecnica esistenti. Non pretendo di conoscerli tutti, ma le due principali categorie generali che puoi utilizzare per classificare qualsiasi documentazione tecnica sono lutente e il caso duso.
Per “utente”, intendo cosa tipo di utente utilizzerà il documento? È una guida dellamministratore, un tutorial o una guida dellutente? Questi livelli di conoscenza vengono presi in considerazione durante la progettazione di un documento. Una guida dellamministratore presume che la persona che legge il documento ne sappia un po di più rispetto al lettore del tutorial.
Con “caso duso”, intendo a cosa serve il documento? Questo può variare dalla documentazione militare su come lanciare un missile fino alla documentazione per sviluppatori su come utilizzare unAPI grafica per sviluppare un videogioco.
Se riesci a restringere la tua domanda, potrei essere in grado per darti di più di quello che stai cercando.