Please enable JavaScript.
Coggle requires JavaScript to display documents.
Documentació de les incidències en el procés d'implantació - Coggle…
Documentació de les incidències en el procés d'implantació
Processos bàsics:
Instal·lació amb totes les opcions que pugui demanar l’instal·lador.
Adequació de l’entorn per adequar-se a les necessitats dels usuaris.
Manteniment de les actualitzacions, canvis en les necessitats dels clients, etc.
Desinstal·lació si es decideix canviar de programari.
Les claus per elaborar una bona documentació:
No donar mai res per sabut. El que és lògic per a vosaltres potser no ho és per a la persona que ha de llegir la documentació. Sigueu exhaustius.
Captures de pantalla. Molts cops, una captura de pantalla (on es poden afegir fletxes o indicacions) pot ajudar més que tres paràgrafs d’explicacions. Sense abusar d’aquest recurs, ja que si no la documentació esdevindria massa densa, hauríeu d’incloure algunes captures per ajudar a entendre millor els passos. Com més baix és el nivell de l’usuari, més captures són necessàries.
Utilitzar un vocabulari correcte mantenir-lo. Cal utilitzar els termes adequats a cada acció, i utilitzar sempre el mateix verb per a una mateixa acció. Molt sovint es confonen instruccions perquè s’utilitzen sinònims, i l’usuari pensa que es tracta d’accions diferents.
Ser clars en les instruccions. No heu de fer literatura. Cal donar les instruccions de manera clara, utilitzant seqüències d’ordres. Si feu servir connectors i no diferencieu prou bé els passos, es pot saltar alguna cosa.
Les opcions s’han d’explicar. En cas que hi hagi diferents opcions i que l’usuari tingui llibertat per escollir, expliqueu què fa cada una i les seves conseqüències. No és mala idea recomanar-ne alguna, si és que penseu que s’ha de fer.
Saber a qui va dirigida la documentació. No és el mateix elaborar una documentació per a tècnics que per a qualsevol usuari.
Estructura:
Procés a seguir en cas d’error.
Requisits tècnics.
Annexos.
Procés d’instal·lació, configuració i posada en marxa.
Presentació, en què trobem una introducció a l’aplicació.
Portada amb el títol.
Índex.
Guia d’utilització del manual.
Conceptes generals de l’aplicació.
Tipus de manuals:
Manual per a l’usuari expert. Es dirigeix a usuaris avançats que coneixen a fons l’aplicació informàtica i que tenen coneixements del sistema. Acostumen a fer les tasques de suport a la resta d’usuaris.
Manual per a l’usuari informàtic. Aquest manual va dirigit al tècnic que coneix el sistema informàtic, i l’emmagatzemament de dades i bases de dades, i té informació de com funciona el sistema informàtic de l’empresa. És el que prepara la documentació d’instal·lació i configuració de cada nova aplicació i modifica les que ja hi ha.
Manual per a l’usuari final. Aquest manual ensenya a moure’s per l’aplicació. Seleccionant les tasques que vol fer, el funcionament del sistema li és transparent.