Kasutusjuhendid

Kasutusjuhendid on tootega või süsteemiga kaasas käiv dokumentatsioon, mille eesmärk on aidata lõppkasutajal toodet turvaliselt ja tõhusalt kasutada. Need hõlmavad paigaldust, operatsiooni, hooldust, tõrkeotsingut ja ohutusjuhiseid ning neid kirjutatakse nii, et kasutajad saaksid soovitud tulemusi saavutada ja vähendada kasutusvigu ja riske.

Sisu ja struktuur võib varieeruda, kuid tavapärased osad on eesmärk ja ulatus, ohutushoiatused, paigaldus või seadistamine, põhilised ning lisafunktsioonide juhised, hooldus ja puhastus, tõrkeotsing, tehnilised andmed ning teenindus- või garantiiinfo. Juhend kasutab samm-sammulisi juhiseid, kontrollnimekirju, diagrammid ja illustraatsioonid. Mõnikord on juhised üles ehitatud tegevustasemel või funktsioonikeskse lähenemisena.

Vorming ja ligipääsetavus: Kasutusjuhendid on tavaliselt saadaval trükitud vormis, PDF-ina, veebipõhise abisüsteemina ning videodel või interaktiivsetena. Lokaliseerimine eesti keelde ja teistes keeltes on levinud. Selgus, lihtne keel, järjepidev terminoloogia ning näited parandavad kasutatavust. Ligipääsetavus tähendab alt-tekstide kasutamist piltidel, lihtsat paigutust, loetavaid fontse ja ekraanilugeri ühilduvust.

Koostamine ja haldus: Tavaliselt töötab koostamisel tehniline kirjanik koos inseneride, tootearendajate ja kvaliteedikontrolliga. Uuendused lisatakse toote elutsüklisse tarkvara või riistvara uuendustega. Eesmärk on tagada ohutus, õige kasutamine ja hooldus ning dokumentatsiooni ajakohasus.