Per molt enginyós que pugui ser un inventor, programador o racionalitzador, de vegades les seves creacions simplement no es poden utilitzar per al propòsit previst. El motiu d’això és el manual d’instruccions redactat incorrectament o la seva absència completa. Però fins i tot inventors enginyosos de vegades escriuen instruccions que, a part d’estrets especialistes, ningú no pot llegir aquests articles. Llavors, com elaborar adequadament un document tan necessari?
És necessari
- - Coneixement al cent per cent del dispositiu o producte de programari per al qual s’escriu el manual;
- - coneixement en el camp de la lingüística;
- - habilitats d'escriptura.
Instruccions
Pas 1
Un manual d'usuari o, en altres paraules, un manual d'operacions és un document dissenyat per proporcionar ajuda a l'ús d'un determinat sistema als seus usuaris. Per compilar un manual d’usuari, heu de conèixer el sistema descrit al cent per cent, però mireu-lo amb els ulls d’un estudiant ignorant. Suposem que s’escriu un manual d’usuari per a una utilitat de programari que encara no té anàlegs. Imagineu que és la primera vegada que utilitzeu aquest programa. Per on comenceu? Què és el primer que cal saber? Organitzeu aquest coneixement en categories d’importància.
Pas 2
En dividir tota la informació relativa a la vostra creació en grups, heu elaborat un pla per escriure un manual d'usuari. Comenceu a descriure el treball del vostre programa des de zero, deixant per darrere els detalls més difícils, com ara reprogramar funcions o fer front a errors crítics. En aquesta etapa, hauríeu de tenir a punt el contingut del manual de l'usuari: una de les parts necessàries d'aquest document.
Pas 3
Si el manual que creeu està pensat per utilitzar-lo en una gran empresa, hauríeu de prestar atenció als estàndards corporatius que s’hi adopten. Per exemple, en moltes empreses russes no s’accepten manuals d’usuari sense suport il·lustratiu, és a dir, imatges que expliquin el que està escrit. A més del contingut, el manual de l'usuari hauria de contenir altres parts obligatòries: - Anotació, és a dir, una explicació dels objectius generals del manual i del producte descrit; - una introducció, que descriu els documents relacionats amb el manual de l'usuari i com fer servir el manual; - seccions que expliquen l’ús del producte en diferents fases del seu ús, per exemple, primers passos, reparació o manteniment; - secció de preguntes més freqüents i respostes; - glossari o índex de matèries.
Pas 4
Normalment, un escriptor tècnic participa en la creació d’un manual d’usuari, una persona que té tots els coneixements necessaris tant en l’idioma com en el producte que es descriu. Com a escriptor tècnic sense formació, cal tenir en compte algunes regles. En primer lloc, no heu d’abusar de termes especials que un usuari normal no entengui. En segon lloc, s’ha de detallar i explicar cada terme utilitzat. En tercer lloc, cal escriure de la manera més clara i concisa possible. Finalment, un escriptor tècnic ha de poder mirar el seu propi text a través dels ulls d’un usuari normal per veure les deficiències del seu propi text.
Pas 5
És bo provar el text acabat del manual de l'usuari a la pràctica oferint-lo a una persona que no tenia res a veure amb el producte descrit. Mitjançant esforços conjunts, és possible eliminar totes les deficiències i les trampes del document.
