Sovint ple d'argot, sigles i adreces que requereixen un doctorat per comprendre, els manuals d'usuari del programari són de vegades escrits des del punt de vista d'un desenvolupador i no d'un usuari. Com a resultat, la guia pot fer suposicions sobre el nivell d'habilitat del lector que sovint són incorrectes. El primer pas per escriure un bon manual d'usuari és aconseguir el procés d'escriptura real tan lluny com sigui possible dels enginyers.
El desenvolupador de programari coneix més que ningú el que fa que el programari funcioni, però això no vol dir que el desenvolupador escriviu la guia. Al contrari, és un desavantatge diferent. Més important que una comprensió profunda del funcionament intern del programari és la comprensió de qui serà l'usuari final, quin és el seu nivell educatiu i com l'usuari final utilitzarà el programari. En la majoria dels casos, els usuaris finals no necessiten conèixer els punts més finals de la programació i les funcions de finalització del programari, només cal saber fer-lo servir per facilitar el treball.
Prova d'usuari
El manual d'usuari ha de ser en gran part orientat a tasques, en comptes de ser summament descriptiu. Com que el manual està escrit per ajudar els usuaris a entendre com executar tasques específiques, l'escriptor necessita comprendre també aquestes tasques i, per tant, passar per cada pas discret de cada funció és absolutament essencial. No és necessari que l'escriptor necessàriament sàpiga com es va crear el programa des del punt de vista del disseny o el desenvolupament, però és essencial tenir un coneixement sòlid de totes les seves funcions. Mentre executeu cada tasca, tingueu temps d'escriure tots els passos, inclosos els clics, els menús desplegables i altres accions.
El procés d'entrevista
Tot i que el desenvolupador no ha de ser el que escrigui el manual, encara serà un recurs valuós per a l'escriptor, i abans d'escriure, planifiqueu una reunió de contacte entre l'escriptor, el desenvolupador i els enginyers i els possibles usuaris finals per ajudar-vos a informar El treball de l'escriptor des del principi. S'haurien d'enregistrar entrevistes amb experts en temes i enginyers, amb transcripcions realitzades per a una referència posterior.
Imatges
Un manual d'usuari no ha de ser massa textós. Més aviat, incorpora l'ús liberal de gràfics i clips de pantalla. La descripció d'una acció és molt més clara amb les instruccions basades en text acompanyades d'un clip de pantalla que il·lustra clarament aquesta direcció. Incloeu visualitzacions abans i després, per mostrar el que sembla la pantalla abans de prendre cada acció i el que passa després de l'acció. Una senzilla utilitat de captura de pantalla com l'eina Snipping inclosa en Microsoft Windows funciona bé per capturar aquestes imatges. Assegureu-vos de numerar cada imatge i incloeu un títol que ho descrigui breument. Centreu-lo immediatament per sota del paràgraf que introdueix per primera vegada el concepte que es mostra a la imatge.
Formatació
Comunicar-se amb claredat en un document tècnic requereix planificació i observació acurada dels estàndards en tota la guia. Els estàndards tant en la presentació, el llenguatge i la nomenclatura ajuden a evitar la confusió. Les plantilles estan disponibles i poden ser un bon punt de partida per a la uniformitat, tot i que segurament es poden adaptar per adaptar-se a cada situació. L'ús d'un marge d'una polzada amb una única columna s'adapti millor a la necessitat d'afegir gràfics; una configuració de dues columnes pot semblar massa concorreguda, i pot fer confús la col·locació d'imatges.
Versió i seguiment
Més que cap altre tipus de document, és probable que una guia d'usuari del programari passi per múltiples iteracions abans que s'hagi completat, i és probable que passin per un procés de revisió per part de diversos grups d'interès. L'ús de la característica Canvis de seguiment a Microsoft Word és una forma fàcil de fer un seguiment dels comentaris i canvis de cada individu. La creació de diverses versions després de cada cicle de revisió, cadascuna amb un nom de fitxer diferent, també ajuda al procés i assegura que tots els grups d'interès estiguin satisfets amb el resultat final.
