ago 5

Documentando las aplicaciones

Posted in aplicaciones

Tan importante como el desarrollo de una aplicación, y las pruebas de la misma para conseguir que el número de bugs que lleguen al usuario final sea practicamente nulo, es una buena documentación, y esta documentación puede ser destinada a dos tipos de personas principalmente: a otros desarrolladores y a usuarios finales.

Dependiendo de a quien va dirigida, la documentación es muy diferente, ya que si documentamos la aplicación de cara al desarrollo, bien para otras personas, y tambien para no olvidar conceptos que pueden ser importantes en futuras actualizaciones, en este caso, la documentación suele ser mas técnica y debe centrarse mas en la realización de acciones concretas en cada uno de los modulos de la aplicación.

Si la documentación va dirigida al usuario final, esta debe ser muy diferente,

  • debe ser sencilla y clara, pensando en usuarios sin apenas conocimientos de informatica, evitando en lo posible los tecnicismos,
  • también debe ser amena y directa, explicando especialmente aquellos conceptos que puedan crear confusión al usuario, e inluir tantas imagenes e ilustraciones como sea necesario,
  • también debe breve, porque lo bueno si breve, es dos veces bueno, y porque solo asi conseguiremos que el usuario decida dedicar un poco de su tiempo a la lectura del manual. Piensa que si ya es dificil conseguir esto, leer un manual con cientos de paginas, no lo leera nadie.
  • debe estar bien organizada, para que cualquier duda que pueda tener el usuario, pueda ser localizada facilmente, y solo asi evitaras que el cliente decida que es mas facil llamarte por telefono que buscar el mismo la solución
  • debe tener ejemplos que simulen la realidad del cliente y situaciones que el usuario pueda comprender
  • y porque no, tambien tiene que tener una parte tecnica, donde se indiquen los requerimientos del sistema y las limitaciones del mismo,

A la hora de realizar la documentación, en A.S.C. hemos tenido en cuenta lo anteriormente descrito, porque pensamos que nuestro cliente no tiene porque saber de todo, porque nos basta con que conozca su propio negocio y queremos facilitarle la labor cuando trabaja con nuestras aplicaciones.

Y es que, en esta ocasión han cambiado muchas cosas, y una de ellas es, que la documentación técnica de la aplicación ha sido realizada previa al desarrollo de la aplicación (aunque se han adaptado los detalles de forma simultanea) y porque de la misma forma, durante la fase de pruebas de la aplicación se han escrito los manuales de usuario para que en el momento de la salida al mercado, este todo listo y los usuarios sean capaces de empezar con el minimo esfuerzo.

En breve empezaremos a publicar esa documentación en la web, para que sea facilmente accesible.

PDF Download    Enviar artculo en formato PDF   
comments: Closed

Comments are closed.