Retomando el tema de la programación, os quiero contar una de las cosas que aprendí trabajando en este mundillo: la importancia de hacer manuales de usuario. Para mí mucho más relevantes que los tests, aunque según quién lea esto me mate un poco. Os cuento porque pienso así 👇
Cuando eres aprendiz normalmente te toca hacer las tareas más tediosas que de normal no gustan a la gente, es así. En mi caso me tocó redactar documentación, sobre todo manuales de usuario, y hacer limpieza de código. Bueno, pues ahí va el final inesperado: me encanta redactar y es gracias a tener blogs de hace años (realmente limpiar código también, se aprende mucho). Así que esas tareas que no gustaban a nadie yo las disfrutaba un montón, rara avis me llaman 👽.
Además, me encanta cambiar: no podría estar haciendo el mismo tipo de trabajo todo el tiempo. Esto quizás suena un poco ambiguo, así que lo concreto: 4 días programando a tope y luego otros 4 días haciendo manual de usuario. Que realmente no es así ni mucho menos, ahora os cuento el porqué me parece algo magnífico el manual frente a los tests unitarios.
Para mí, son la mejor manera de descubrir errores en la aplicación y de comprobar si es lo que el cliente necesita de verdad. Hasta ahora incluso Alca me miraba en plan friki de los manuales de usuario, pero la semana pasada se animó a hacerlo por no estar con otra aplicación. Otro final inesperado: le encantó hacerlo y me dio la razón, le salieron muchos errores con los que no contaba.
Lo que os decía antes de que no es verdad estar 4 días programando y 4 días con el manual, es porque a la que estás un día haciendo el manual ya te has anotado varios errores que tienes que ir modificando. Y cuando hay cambios, tienes que volver a comprobar y pueden salir otras cosas que estaban ahí esperando a ser despertadas o que han surgido a raíz de ellos.
Os cuento así un poco de forma básica cómo explicaba las pantallas. No sé si es la más correcta ya que quizás hacía una mezcla entre manual de usuario y manual más técnico (también el lugar de trabajo lo requería en parte 💻), pero ese era mi método.
He cogido una captura de RMI, aplicación que continuaré el año que viene (que ganas💪), para hacerlo más práctico:
*Obviaremos el menú para hacer una explicación básica de la pantalla*
A grandes rasgos sería algo así, detallar todas las posibles acciones y consecuencias que se pueden dar lugar en una pantalla. Al tener que pensar en todos los caminos posibles a la fuerza para hacer el manual de usuario es como mejor se examina la aplicación. Aparecen errores y además al redactarlo es posible que surjan dudas para preguntar al cliente, cosas que de primeras no se han tenido en cuenta pero que pueden ser interesantes.
Para mí hacer el manual de usuario son todo ventajas: te sirve como testeo, análisis más profundo de la aplicación y como manual propiamente para explicar cómo se usa la aplicación a terceros 📋.
La pregunta queda en el aire: ¿os gusta hacer manuales? ¿Os ha picado el gusanillo tras leer la entrada de verlos ahora con otros ojos? Contadme 😎
Además, me encanta cambiar: no podría estar haciendo el mismo tipo de trabajo todo el tiempo. Esto quizás suena un poco ambiguo, así que lo concreto: 4 días programando a tope y luego otros 4 días haciendo manual de usuario. Que realmente no es así ni mucho menos, ahora os cuento el porqué me parece algo magnífico el manual frente a los tests unitarios.
Para mí, son la mejor manera de descubrir errores en la aplicación y de comprobar si es lo que el cliente necesita de verdad. Hasta ahora incluso Alca me miraba en plan friki de los manuales de usuario, pero la semana pasada se animó a hacerlo por no estar con otra aplicación. Otro final inesperado: le encantó hacerlo y me dio la razón, le salieron muchos errores con los que no contaba.
Lo que os decía antes de que no es verdad estar 4 días programando y 4 días con el manual, es porque a la que estás un día haciendo el manual ya te has anotado varios errores que tienes que ir modificando. Y cuando hay cambios, tienes que volver a comprobar y pueden salir otras cosas que estaban ahí esperando a ser despertadas o que han surgido a raíz de ellos.
Os cuento así un poco de forma básica cómo explicaba las pantallas. No sé si es la más correcta ya que quizás hacía una mezcla entre manual de usuario y manual más técnico (también el lugar de trabajo lo requería en parte 💻), pero ese era mi método.
He cogido una captura de RMI, aplicación que continuaré el año que viene (que ganas💪), para hacerlo más práctico:
Para crear una nueva lista se necesitan dos valores inicialmente: título y paleta de colores. El título es obligatorio y si no se rellena aparece un mensaje de error. La paleta de colores tiene el valor Default por defecto, pero abriendo el desplegable se puede elegir otro.
En la parte derecha de la pantalla está la vista previa de los colores elegidos. Al seleccionar otro valor, automáticamente, se modifica el estilo de la lista de muestra. De igual modo, el título que se escribe aparecerá también a la derecha.
Si al pulsar el botón Crear todo es correcto se mostrarán todas las listas del usuario, la página inicial, para poder añadir elementos en la recién creada. En caso de producirse un error se muestra un mensaje en la pantalla y no se produce la redirección.
A grandes rasgos sería algo así, detallar todas las posibles acciones y consecuencias que se pueden dar lugar en una pantalla. Al tener que pensar en todos los caminos posibles a la fuerza para hacer el manual de usuario es como mejor se examina la aplicación. Aparecen errores y además al redactarlo es posible que surjan dudas para preguntar al cliente, cosas que de primeras no se han tenido en cuenta pero que pueden ser interesantes.
Para mí hacer el manual de usuario son todo ventajas: te sirve como testeo, análisis más profundo de la aplicación y como manual propiamente para explicar cómo se usa la aplicación a terceros 📋.
⚞---------------------------⚟
La pregunta queda en el aire: ¿os gusta hacer manuales? ¿Os ha picado el gusanillo tras leer la entrada de verlos ahora con otros ojos? Contadme 😎
No hay comentarios:
Publicar un comentario
Escribe tu comentario