Tehnička dokumentacija
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
[uredi | uredi izvor]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
[uredi | uredi izvor]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.[1] Tehnička dokumentacija proizvoda koja nije pokrivena kodom ICS 01.110 navedena je u sljedećem pododjeljku.
Specifično za disciplinu
[uredi | uredi izvor]Regulativa EU o medicinskim uređajima
[uredi | uredi izvor]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
[uredi | uredi izvor]- Darwin Information Typing Architecture (DITA)
- DocBook
- S1000D
- reStructuredText
Arhitektura i klasifikacija dokumentacije
[uredi | uredi izvor]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[8]) 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.[9] 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.[10]
Također pogledajte
[uredi | uredi izvor]Reference
[uredi | uredi izvor]- ↑ "01.110: Technical product documentation". Međunarodna organizacija za standardizaciju. Pristupljeno 10. 6. 2009.
- ↑ "ISO 15787:2001 Technical product documentation -- Heat-treated ferrous parts -- Presentation and indications". Međunarodna organizacija za standardizaciju. Pristupljeno 10. 6. 2009.
- ↑ "ISO 3098-0:1997 Technical product documentation -- Lettering -- Part 0: General requirements". Međunarodna organizacija za standardizaciju. Pristupljeno 10. 6. 2009.
- ↑ "ISO 10209-1:1992 Technical product documentation -- Vocabulary -- Part 1: Terms relating to technical drawings: general and types of drawings". Međunarodna organizacija za standardizaciju. Pristupljeno 10. 6. 2009.
- ↑ "ISO 2162-1:1993 Technical product documentation -- Springs -- Part 1: Simplified representation". Međunarodna organizacija za standardizaciju. Pristupljeno 10. 6. 2009.
- ↑ "ISO 5457:1999 Technical product documentation -- Sizes and layout of drawing sheets". Međunarodna organizacija za standardizaciju. Pristupljeno 10. 6. 2009.
- ↑ ISO6433 Technical product documentation. Part references, BSI British Standards, pristupljeno 16. 12. 2020
- ↑ "Partial list of Diátaxis documentation sets". Pristupljeno 10. 4. 2021.
- ↑ "Outline of Diátaxis documentation forms". Arhivirano s originala, 16. 4. 2021. Pristupljeno 10. 4. 2021.
- ↑ "RedHat Modular Documentation terms and definitions". Pristupljeno 11. 4. 2021.
