Dokumentacija je svaki prenosivi materijal koji se koristi za opisivanje, objašnjenje ili upute u vezi sa nekim atributima objekta, sistema ili postupka, kao što su njegovi dijelovi, montaža, instalacija, održavanje i upotreba. [1] Dokumentacija se može dostaviti na papiru, na mreži ili na digitalnim ili analognim medijima, kao što su audio trake ili CD-ovi. Primjeri su korisnički vodiči, bijele knjige, pomoć na mreži i brzi vodiči. Papirna ili štampana dokumentacija postala je manje uobičajena. Dokumentacija se često distribuira putem web stranica, softverskih proizvoda i drugih onlajn aplikacija.
Dokumentaciju kao skup nastavnog materijala ne treba miješati sa naukom o dokumentaciji, proučavanjem snimanja i pronalaženja informacija.
Iako povezani ISO standardi nisu lako dostupni javnosti, vodič iz drugih izvora za ovu temu može poslužiti svrsi.[2], [3], [4],[5]
Razvoj dokumentacije može uključivati izradu nacrta, formatiranje, podnošenje, pregled, odobravanje, distribuciju, ponovno objavljivanje i praćenje, itd., a sazivaju ga povezani SOP u regulatornoj industriji. To također može uključivati stvaranje sadržaja od nule. Dokumentacija treba da bude lahka za čitanje i razumijevanje. Ako je predugačak i preopterećen, može biti pogrešno shvaćen ili zanemaren. Trebalo bi koristiti jasne, sažete riječi, a rečenice ograničiti na najviše 15 riječi. Dokumentacija namijenjena široj publici treba izbjegavati rodno specifične termine i kulturološke predrasude. U nizu procedura, koraci treba da budu jasno numerisani.[6], [7], [8]
Reference
