Cel mai bun răspuns
Există atât de multe tipuri diferite de documente tehnice încât este aproape imposibil să le enumerați pe toate aici.
În lunga mea carieră de scriitor tehnic, personal trebuie să am scris peste 15 tipuri diferite de documente tehnice, variind de la un proiect la altul.
La cel mai abstract nivel, documentele tehnice pot să fie clasificate în cele scrise pentru utilizatori interni și utilizatori finali externi .
De exemplu, un Ghid de configurare a sistemului este un exemplu de document „intern” în timp ce un Ghidul de instalare este un exemplu de document „utilizator final extern”.
Un Ghid API poate fi atât pentru intern și utilizatori externi. Un Ghid de pornire rapidă , pe de altă parte, este aproape întotdeauna destinat utilizatorilor finali externi.
Am scris Ghiduri de utilizare , Ghiduri de depanare , Foi de referință , Note de versiune , (editat) Documente privind cerințele de marketing (MRD), Documente de arhitectură și inginerie (A&E Doc), Fișiere de ajutor , Proceduri de operare standard (SOP) manuale și multe altele.
Sunteți binevenit (ă) să vizitați Centrul de comunicare tehnică pentru mai multe informații gratuite despre toate aceste tipuri diferite de documente tehnice.
Răspuns
Există diferite moduri de a clasifica tipurile de documentație tehnică care există. Nu pretind să le cunosc pe toate, dar cele două mari categorii principale pe care le puteți folosi pentru a clasifica orice documentație tehnică sunt utilizatorul și cazul de utilizare.
Prin „utilizator”, vreau să spun ce tipul de utilizator va folosi documentul? Este un ghid de administrator, un tutorial sau un ghid de utilizare? Aceste niveluri de cunoștințe sunt luate în considerare la proiectarea unui document. Un ghid de administrator presupune că persoana care citește documentul știe puțin mai mult decât cititorul tutorialului.
Prin „caz de utilizare”, vreau să spun la ce folosește documentul? Aceasta poate varia de la documentația militară cu privire la modul de lansare a unei rachete până la documentația pentru dezvoltatori pentru utilizarea modului în care se utilizează un API grafic pentru a dezvolta un joc video. pentru a vă oferi mai mult din ceea ce căutați.