Documentació i guies d'usuari

De WikiCat IT
Dreceres ràpides: navegació, cerca

El pas final del procés d’instal·lació d’un sistema operatiu ha de ser la documentació del procés d’implementació que s’ha dut a terme amb vista a un manteniment millor del sistema instal·lat i la creació de manuals o guies d’usuari destinats a l’usuari final de l’equip.

El desenvolupament d’una bona documentació i la comprensió de les accions fetes durant la instal·lació d’un sistema operatiu és fonamental per assegurar que el procés s’ha dut a terme de manera correcta i que s’hi podran solucionar els problemes que es puguin presentar en un futur.

La documentació d’un procés es pot aconseguir mitjançant llistes de les tasques que han estat fetes, la informació recollida i els diagrames de flux.

La revisió d’aquests documents generats pot servir de base per al control del funcionament correcte i per a l’aplicació, si és necessari, de millores en el procés. Per tant, una bona documentació esdevé de vital importància en moltes accions informàtiques, ja que ben feta pot ajudar a controlar la posada a punt i els errors d’una manera molt més eficient. També serveix perquè qualsevol persona que no hagi intervingut directament en la implementació pugui conèixer els trets principals del sistema operatiu instal·lat i la seva configuració.

La documentació relacionada amb el sistema operatiu té un vessant relacionat amb els components i les configuracions amb què treballa el sistema i pot incloure també un manual per facilitar la utilització del sistema a l’usuari final. La documentació, així doncs, es pot dividir en documentació tècnica i documentació per a l’usuari final.

Documentació tècnica del sistema operatiu

En la documentació tècnica cal incloure totes les dades que el tècnic de manteniment del sistema necessita. En el moment de fer una reparació, el tècnic es troba habitualment el problema de no saber amb quins components s’enfronta. No té informació sobre si el sistema ha arribat premuntat i preinstal·lat de fàbrica, o l’ha muntat algun altre tècnic, o fins i tot no sap quines reparacions o problemes ha tingut anteriorment l’equip. Per això la documentació del procés d’instal·lació i dels resultats finals assolits és fonamental.

La documentació tècnica de la instal·lació inclou:

  • Documentació de les accions que han estat fetes durant la instal·lació.
  • Registres de la instal·lació que l’instal·lador ha generat.
  • Informes sobre el rendiment i la configuració del sistema, que es generen amb eines de programari específiques.

Documentació de les accions fetes

En el procés de muntatge d’un equip informàtic és molt important, amb vista al manteniment, tenir documentat el maquinari muntat i també el sistema operatiu que s’utilitza. Aquesta documentació ha d’incloure tota la informació fonamental que permeti conèixer la configuració de l’equip fins a l’últim detall, incloent-hi el tipus de processador, la memòria RAM, el disc dur, la connectivitat, etc.

La major part d’aquesta falta d’informació es pot solucionar mitjançant una bona documentació de la implementació de l’equip. Malgrat que pugui semblar una feina desagraïda (sobretot si només es fa per a un sol equip), s’ha de tenir en compte que un taller de muntatge farà sèries grans d’equips amb les mateixes característiques, i que en tot cas es tractarà d’una feina molt útil si es produeixen incidències amb l’equip.

Es pot considerar que la documentació d’implementació d’un equip és completa quan inclou:

  • El registre de maquinari: inclou tota la informació referent a la composició, la configuració i les dades necessàries sobre el maquinari.
  • L’informe de muntatge: inclou tota la informació essencial sobre el procés de disseny i muntatge d’un equip informàtic.
  • L’informe d’instal·lació: detalla tots els processos i les eleccions preses durant la fase d’implementació del sistema operatiu en un equip, i també les modificacions que s’hi hagin fet al llarg de la seva vida útil.

L’informe de muntatge pot incloure informació sobre el sistema operatiu, però és convenient desglossar aquesta informació en la que fa referència al maquinari (muntatge) i al programari (instal·lació).

Tota aquesta informació resulta fonamental per a la posada en funcionament i la reparació posterior de l’equip. L’informe d’instal·lació, per tant, haurà d’incloure aquests elements:

  • Les tasques efectuades i l’ordre en què han estat fetes en el decurs de la instal·lació del sistema operatiu i les aplicacions contingudes.
  • Les particions i el sistema d’arxius utilitzats en cada equip.
  • El gestor d’arrencada utilitzat i la seva configuració .
  • La indicació del sistema operatiu que hi ha instal·lat a cada ordinador. Es podria justificar, si s’escau, l’ús d’un sistema operatiu determinat.
  • La funció que fa dins de la xarxa: si és un equip de sobretaula, un equip client, un servidor de domini, un servidor web, un servidor FTP, etc.
  • El programari que utilitza.

A més dels programes d’ofimàtica, el programari utilitzat consta en general del següent:

  • El programari antivirus i antiespia que s’utilitza.
  • El programari de diagnòstic de la màquina. En cas que s’utilitzi, caldria mantenir una base de dades amb la informació recollida de cada equip.
  • El detall de la informació sobre les llicències del programari.
  • Les actualitzacions instal·lades del programari base o d’aplicació.

Registres generats per l'instal·lador

Qualsevol sistema operatiu disposa d’un programari instal·lador que s’encarrega de fer tots els processos que portaran a la implementació del sistema a l’equip que volem. Aquest instal·lador pot ser més o menys interactiu i funcionar en entorn de text o gràfic.

En tot cas, l’instal·lador ofereix al responsable de la instal·lació la possibilitat d’escollir entre diferents opcions a l’hora d’ajustar el funcionament i l’aparença del sistema operatiu resultant.

En el registre d’instal·lació queden recollides totes les eleccions de configuració i el resultat satisfactori, o no, dels processos d’instal·lació.

El registre es desa normalment en format d’arxius de text en algun directori designat pel sistema operatiu. El format del registre dependrà del sistema operatiu que s’està implementant.

Es poden exemplificar els diferents registres d’instal·lació dels sistemes operatius amb els que genera el Windows Vista de Microsoft, i els corresponents de Debian GNU/Linux.

Eines de verificació o diagnòstic

Les eines de verificació permeten analitzar un equip informàtic i extreure’n tot tipus d’informació sobre el maquinari i el programari. La major part d’aquestes eines tenen algun apartat destinat a l’avaluació de la configuració i el rendiment del sistema operatiu sobre el qual estan instal·lades, de manera que poden oferir una valuosa informació sobre el funcionament del sistema.

Els programes de diagnòstic són eines que permeten analitzar diferents aspectes de l’ordinador, tant del programari com del maquinari.

Així, per exemple, permeten veure amb detall la configuració de la placa base, del sistema operatiu, del programari instal·lat, etc.

Documentació per a l'usuari: La creació de manuals

La documentació per a l’usuari és aquella documentació destinada a la persona que utilitzarà el sistema. El grau de detall variarà segons el tipus d’usuaris que hagin d’utilitzar l’equip i del perfil que tinguin. Ha d’incloure un esquema de les connexions de maquinari, els controladors de dispositius i un disc d’instal·lació o restauració del sistema operatiu, i també un manual d’usuari d’aquest sistema operatiu.

Un manual d’usuari és essencialment un document que, amb les dimensions d’un llibre, conté instruccions sobre instal·lació, utilització i resolució de problemes en un producte de maquinari o programari.

Un manual d’usuari pot ser breu –de 10 a 20 pàgines– o pot tenir una llargada molt més extensa, fins a centenars de pàgines. Encara que es parla de manuals d’usuari relacionats amb la informàtica, aquesta classe de documents s’utilitza per a qualsevol tipus d’equips electrònics.

Com més complex sigui el document, més gran serà la seva extensió en pàgines, de manera que alguns elements del manual es poden separar en volums individuals (com ara Procediments d’instal·lació, Errors més comuns o una llista de les Instruccions d’ús del sistema).

Estil i formats en manuals d'usuari

L’escriptura d’un manual requereix un cert nombre d’habilitats que es combinen per aconseguir un document que sigui útil al lector. En primer lloc cal que l’escriptura tècnica sigui clara i entenedora. A continuació es detallen les diverses eines de format que s’han d’utilitzar:

  • Capçaleres. Permeten destacar continguts clau de la informació, de manera que el lector les pugui trobar ràpidament.
  • Llistes. Les llistes amb punts i numerades ajuden els usuaris a revisar la informació amb rapidesa i a estructurar-les correctament.
  • Avisos. Els avisos especials i notes d’alerta permeten emfasitzar determinades idees, remarcar algun problema o enviar l’usuari a altres fonts d’informació.
  • Disseny orientat a instruccions. El manual haurà de tenir capçaleres i seccions basades en les tasques per fer, mitjançant llistes que indiquin els passos per fer al lector.

Les instruccions, i, per tant, el manuals d’usuari, utilitzen de manera profusa els gràfics, les taules i el text destacat.

Components d'un manual d'usuari

Un manual d’usuari en general és un document en format de llibre, encara que també es poden trobar en format electrònic. Aquest tipus de documents, en conseqüència, consten d’una sèrie de components i característiques estàndard, formades pel següent:

  • Portada i contraportada
  • Notes de l’edició
  • Marques comercials
  • Descàrrec de responsabilitat
  • Garanties
  • Llicència del document
  • Avisos de seguretat
  • Pròleg
  • Apèndixs
  • Glossari
  • Índex
  • Formulari de comentaris dels lectors.

En cada manual trobareu una combinació diferent dels elements abans esmentats, ja que els pot incloure tots o diverses combinacions.

Els apartats que integren el contingut normalment inclòs en un manual són aquests:

  • Instruccions. Les més òbvies són indicacions pas per pas sobre la manera de muntar, operar o arreglar el producte. Les instruccions en un manual d’usuari han d’estar generalment orientades a la realització de tasques. Les instruccions similars o relacionades són agrupades en capítols.
  • Informació de precaució. Hi trobareu notes, advertències (warnings) i fins i tot avisos de perill, que marquen les preocupacions de seguretat que palesa el fabricant del producte.
  • Informació de referència. Hi trobareu molta informació de referència però només fins a cert punt. La informació de referència es presenta en taules: columnes de configuracions, descripcions, variables i paràmetres, entre d’altres.
  • Informació per a principiants. Alguns manuals d’usuari inclouen guies breus (Getting-started) per ajudar que els usuaris novells s’acostumin a fer servir el dispositiu.
  • Apartat “Quant a”. Els manuals inclouen alguna descripció del producte, una ressenya de les característiques que són noves o fonamentals. De vegades aquesta informació, si és molt extensa, també es pot presentar en un volum separat. Normalment el volum es presentarà com “Introducció al nou producte” o alguna cosa semblant. Per exemple en el manual d’un programa d’edició fotogràfica podeu trobar informació bàsica sobre els conceptes de brillantor, saturació o to, essencials per treballar amb aquests tipus de programes; són els technical backgrounds.
  • Antecedents tècnics. De vegades, els manuals poden incloure explicacions tècniques –Technical backgrounds– sobre el funcionament del producte, sobre quins principis són essencials perquè sigui operatiu…

Procés de redacció i documents interns per a manuals d'usuari

Una part molt important dels manuals d’usuari, i de fet, de tot tipus de documentació tècnica, és el procés per mitjà del qual són escrits.

En cada manual d’usuari cal especificar exactament quin dels possibles continguts i formats s’ha d’incloure i, si el text és generat per diversos autors, serà necessària una bona coordinació del treball.

En el procés d’edició d’un manual o de la documentació tècnica intervenen una colla d’elements que, atesa la seva importància, cal conèixer:

  • Planificació inicial. Els passos previs en la redacció de qualsevol documentació tècnica inclouen avaluació de les necessitats (quina documentació cal), anàlisi dels destinataris (què necessiten aquells que utilitzaran el manual), anàlisi de les tasques (per a quina finalitat faran servir el component els usuaris) i planificació de documents (quins altres fullets o documents caldrà generar a més del manual d’usuari), entre d’altres possibles.
  • Proposta de document. En alguns casos cal fer una proposta del manual abans que s’hagi assolit un compromís pel que fa a l’estructura del contingut i el format.
  • Planificació del document. Els manuals d’usuari necessiten una sèrie de documents de suport que especifiquin continguts, destinataris, disseny, formats, membres de l’equip de redacció, calendari de tasques i altres informacions sobre el projecte de documentació i els documents que caldrà entregar.
  • Prototipus i especificacions. Es tracta d’eines de planificació que també s’utilitzaran com a eina de referència al llarg de la realització del manual. Inclou el prototipus del manual d’usuari i les seves especificacions.
  • Plantilles i manual d’estil. El manual d’estil i les seves plantilles són imprescindibles per aconseguir unificar l’estil del document. Una plantilla és un document electrònic que defineix aspectes del manual, com ara la mida de la pàgina, les capçaleres i els peus de pàgina, l’estil de numeració de pàgina i altres detalls d’aquest tipus. Un manual d’estil defineix el format dels elements de text que es troben en el document, com les mides i els tipus de lletra, els estils de paràgraf, taules, i altres.
  • Diverses revisions i esborranys. La redacció d’un manual d’usuari no és una feina individual, sinó que hi participa un equip més ampli, en el qual s’inclouen editors, experts, tècnics i lectors de prova, entre d’altres. La retroalimentació que ofereix aquest equip quedarà reflectida en el document final.

Un cop l’esborrany sigui aprovat per totes les parts es podrà passar a la “producció”, de manera que es podran generar les còpies impreses finals.

Eines de l'usuari
Espais de noms

Variants
Navegació
Eines