dokumentatsioonides

Dokumentatsioonide mõiste hõlmab kogu materjalide kogumit, mis kaasneb tootega, teenusega või protsessiga. Dokumentatsioon selgitab eesmärki, kasutamist, paigaldamist, konfiguratsiooni, toimimist ja hooldust ning aitab kaasa ohutule kasutamisele, vastavusele ja õppimisele.

Dokumentatsioonide tüübid hõlmavad tehnilist dokumentatsiooni (riistvara ja tarkvara), kasutusjuhendeid (manuaalid ja õpetused), API- ja arendajate dokumentatsiooni, paigaldusjuhendeid ning väljalaske- ja vastavusdokumente.

Koostamine toimub valdkonnaekspertide ja tehniliste kirjutajate koostöös. Protsess sisaldab tavaliselt sihtrühma analüüsi, kavandamist, koostamist, läbivaatust, toimetamist, lokaliseerimist ja avaldamist. Täpsus, järjepidevus ja ajakohasus on olulised.

Struktuur: kõige levinumad osad on ülevaade, eeltingimused, sammud, joonised või ekraanipildid, näited, sõnaraamat ning sisukord või indekss. Selge märgistamine ja viited parandavad kasutatavust.

Kvaliteedi ja standardite alused: hea dokumentatsioon on täpne, täielik, loetav, järjepidev ja kättesaadav. Standardsed stiilijuhised, metaandmed, versioonikontroll ja muudatuste logid aitavad säilitada usaldusväärsust.

Lokalisatsioon ja kättesaadavus: dokumentatsioon võib olla tõlgitud Eesti keelde ja teistesse keeltesse. Lokalisatsioon nõuab sõnavara ja kultuuriliste näidete standardiseerimist. Kättesaadavuse tagamiseks kasutatakse lihtsat keelt ja juurdepääsetavaid formaate.

Jaotamine ja elutsükkel: dokumentatsioon avaldatakse erinevates formaatides (HTML, PDF, abisüsteemid) ning ajakohastatakse koos tarkvara või riistvaraga. Tänapäevane praktika eelistab elavat dokumentatsiooni, mis areneb toote arendusega.