Teknika redakto

Teknika redakto aŭ teĥnika redakto estas profesia fako, en kiu oni preparas la helpan dokumentaron por uzantoj de maŝino, de komputa programo kaj de similaj malsimplaj objektoj. Pli flate oni povas nomi ĝin teknika verkado. Ĝi najbaras al scienca aŭ teknika ĵurnalismo.

Principoj

Teknika dokumento estas mezaĵo inter teknikistoj, kiuj konstruas maŝinojn, kaj uzantoj. Teknika redaktisto devas esti aŭ fakulo kun klariga talento, aŭ bona verkanto kun kompreno pri fakaĵoj.

Teknikaj klarigoj devas adaptiĝi al la celata publiko. Se la publiko estas jam kompetentaj profesiuloj, la tekstoj povas uzi fakan ĵargonon kaj konvenciajn skemojn. Male se la publiko estas el ordinaruloj, oni devas prezenti la aferojn simple, iom detale, aŭ klarigi la bazajn nociojn unue.

Redaktisto devas gramatike kaj vortprovize bone regi la lingvon, plani dokumentojn, prezenti aferojn laŭ logika ordo. Iuj el la kutimaj rekomendoj por teknika redaktado estas:

• Ĉiam mencii la saman aferon per la sama nomo
• Uzi mallongajn frazojn
• Uzi limigitan vortprovizon
• Prezenti proceduron laŭtempe, sen retroiroj
• Konsekvence uzi titolojn, indeksojn kaj similajn
• ...

Dokumentspecoj

La specoj de teknikaj dokumentoj estas tre multaj. Tipaj kaj ofte uzataj specoj estas ekzemple:

• Manlibro de instalo - por munto, instalo, unuafoja funkciigo
• Instrulibro - kun gvidaj ekzemploj de uzado
• Manlibro de administro - por perioda purigo, flego, riparo ktp.
• Manlibro de uzo - por ordinara uzo
• Referenca manlibro - kun listoj de ĉiuj komandoj, erarokazoj, ktp
• Ekrana helpo - ene de komputikaj programaroj

Helpoj

Kelkaj kompanioj proponas formalajn metodojn de teknika redakto.