Dokumentacija

S Wikipedije, slobodne enciklopedije
Idi na navigaciju Idi na pretragu

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[uredi | uredi izvor]

  1. ^ "Documentation definition by The Linux Information Project". www.linfo.org. Pristupljeno 9 August 2020.
  2. ^ N/A (2003). "Guide to Documentation" (PDF). Arhivirano s originala (PDF), 29 July 2007.
  3. ^ CGRP. "A Guide to Documentation Styles" (PDF). Pristupljeno 12 June 2009.
  4. ^ N/A. "A guide to MLA documentation" (PDF). Arhivirano s originala (PDF), 2 September 2006. Pristupljeno 12 June 2009.
  5. ^ Berger, David. "Procedures and Documentation" (PDF). Arhivirano s originala (PDF), 27 July 2011. Pristupljeno 15 June 2009.
  6. ^ Cropper, Mark; Tony Dibbens (2002). "GAIA-RVS Documentation Procedures" (PDF). Arhivirano s originala (PDF), 2 November 2005. Pristupljeno 15 June 2009.
  7. ^ N/A. "GLNPO's Quality System Documentation Review Procedures and Tracking" (PDF). Arhivirano s originala (PDF), 4 December 2008. Pristupljeno 15 June 2009.
  8. ^ UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). Arhivirano s originala (PDF), 13 June 2010. Pristupljeno 15 June 2009.