Documentatie tehnica
Documentația din domeniul tehnic constă în acel complex de documente și materiale adecvate pentru a oferi suport și cunoștințe în anumite domenii.
Documentație IT
În special în domeniul IT , acesta include materiale utile pentru înțelegerea caracteristicilor și funcționalității unui anumit sistem, instrument sau procedură. Distribuit de obicei în format electronic sau pe hârtie, este împărțit în mai multe categorii: ghiduri, manuale , cum , FAQ , etc. Fiecare dintre ele are scopuri și caracteristici diferite, variind, de exemplu, specificul subiectului, structura acestuia și nivelul de detaliu. De exemplu, HowTo- urile vizează în mod special rezolvarea unei probleme specifice, în timp ce ghidurile sunt de obicei mai largi.
Documentarea a devenit din ce în ce mai importantă în lumea IT, dezvoltând nevoia de noi profesioniști capabili să ofere combinația corectă de cunoștințe aprofundate despre subiectul descris și abilități expresive adecvate. Deși documentația este adesea scrisă de dezvoltatorul sau proiectantul de sistem însuși, numărul documentarilor - profesioniști dedicați exclusiv documentației sistemului - este în creștere.
În plus față de documentația utilizatorului, există mai multe documentații tehnice, destinate în mod special dezvoltatorilor de software. Ele pot descrie, de exemplu, API - urile , structurile de date și algoritmii unei componente date. Comentariile introduse direct în codul sursă de către programatori constituie, de asemenea, documentație. În acest sens, a fost dezvoltat un software capabil să le extragă și să genereze automat documentație bine structurată și exportabilă în diverse formate.