Tehnička dokumentacija jest opšti termin za vrste informacija kreirane s ciljem da opišu (tehničkim jezikom) korištenje, funkcionalnost ili arhitekturu proizvoda, sistema ili usluge.
Vrste tehničke dokumentacije Vrste tehničke dokumentacije mogu uključivati:
patente specifikacije proizvoda ili komponenti/materijala tehničke listove proizvoda ili komponenti/materijala metode testiranja standarde proizvodnje sistemske zahtjeve arhitekturu sistema dokumente i podatke o dizajnu sistema, uključujući one potrebne za razvoj, testiranje, proizvodnju, rad i održavanje sistema
Standardizacija tehničke dokumentacije Historijski, većina vrsta tehničke dokumentacije nije imala univerzalnu usklađenost (standarde) u pogledu formata, sadržaja i strukture. Standardi se razvijaju kako bi se to ispravilo putem tijela poput Međunarodne organizacije za standardizaciju (ISO), koja je objavila standarde u vezi s pravilima za pripremu korisničkih vodiča, priručnika, specifikacija proizvoda itd., za tehničku dokumentaciju proizvoda. Ovi standardi su obuhvaćeni ICS kodom 01.110. Tehnička dokumentacija proizvoda koja nije pokrivena kodom ICS 01.110 navedena je u sljedećem pododjeljku.
Specifično za disciplinu ISO 15787 ISO 3090 ISO 10209 ISO 2162 ISO 5457 ISO 6433ISO6433
Regulativa EU o medicinskim uređajima Tehnička dokumentacija je takođe potrebna za medicinske uređaje prema regulativi EU o medicinskim uređajima. Aneks II, Tehnička dokumentacija, i Aneks III, Tehnička dokumentacija o nadzoru nakon stavljanja na tržište, propisuju sadržaj tehničke dokumentacije za medicinski uređaj. Ovo uključuje, na primjer, informacije o specifikacijama uređaja, označavanju i uputstvima, dizajnu i proizvodnji, zahtjevima za sigurnost i performanse, upravljanju rizikom te validaciji i verifikaciji uređaja, uključujući kliničku evaluaciju; kao i informacije iz postmarketinškog nadzora.
Formati za izvorne podatke Darwin Information Typing Architecture (DITA) DocBook S1000D reStructuredText
Arhitektura i klasifikacija dokumentacije Neki sistemi dokumentacije bave se ukupnim tipovima ili oblicima dokumentacije, a koji čine set dokumentacije, kao i (ili radije nego) načinom na koji se dokumentacija proizvodi, objavljuje ili formatira.
Na primjer, Diátaxis okvir (koji se uglavnom koristi u oblasti softverske dokumentacije) predlaže četiri različita oblika dokumentacije, koji odgovaraju četiri različite korisničke potrebe: tutorijali, vodiči za rad, referentna dokumentacija i objašnjenja. Suprotno tome, DITA definiše pet različitih "tipova tema": Zadatak, Koncept, Referenca, Unos u rječnik i Rješavanje problema, dok RedHatov Modularni sistem dokumentacije koristi tri "modula": Koncept, Procedura i Referenca.
Također pogledajte Sistem upravljanja dokumentima Inženjering metoda Mrežna dokumentacija Tehnička komunikacija Tehničko uređivanje Tehnički fajl Tehnički standard
Reference
Kategorija:Dokumenti