Buenas practicas para facilitar el uso
Integrantes
Estudiantes: Victoria Díaz y Luis Costela
Maestras: Laura Gómez y Tania Salina (escuela n° 114)
Objetivo
El objetivo de este proyecto es lograr obtener, trabajando junto con las maestras, un conjunto de "buenas prácticas de programación" para luego facilitarles el uso a ellas. Esto es muy importante porque ellas van a ser las principales usuarias del programa y la idea es que la tarea de configuración y adaptación de la aplicación para cada alumno no sea una traba para que este trabajo llegue realmente a los alumnos.
Proyecto
Este proyecto surgió dado que nuestras maestras no trabajan con niños con discapacidades motrices, sino que trabajan en escuelas comunes como se les llama. Esto nos llevó a cambiar el enfoque y en vez de centrarnos en los alumnos como lo hacen los otros proyectos, nos centramos en las maestras que van a ser las principales usuarias de XEvents. Nosotros decidimos trabajar sobre la aplicación de barrido básico que está como ejemplo del programa y lograr adaptarlo de tal manera de cumplir el objetivo.
El primer paso a realizar fue lograr adaptar el barrido a algo que fuese más modular, que la maestra no tenga necesidad de ver código que no le interesa y que lo que si le interesa esté a la vista y fácil de acceder. También se agregaron comentarios indicando cuales eran las acciones que se pueden realizar sobre cada bloque y que hacen los mismos. A continuación se muestra la solución propuesta.
imagen 1
imagen 2
Como se puede observar en la imagen 1, se puso todo lo que era configuración dentro de un bloque, el cual es contraible pero para fácil visualización lo dejamos expandido. Cada configuración posible tiene una descripción con cuales son sus valores posibles o como acceder a la paleta que modifica cierto valor, información relevante para la variable. También, se le agregó una descripción a cada una de las funciones que podían ser ejecutadas por la maestra, indicando específicamente que debía hacer click sobre ella y cuál era la acción que se iba a ejecutar (en nuestro caso las funciones eran "start" y "reiniciar"). Por otro lado, como se puede observar en la imagen 2, se modularizó el código de tal manera que en el "start" fuese fácil de visualizar cómo trabajaba el programa. Esto no solo es útil por si una maestra un poco curiosa le interesa ver sino también para el mantenimiento del código.
Una vez que teníamos esto procedimos a enviárselo a las maestras para que lo intentaran usar y nos dieran un feedback de cómo les resultó. En esta ocasión decidimos no mandar ningún tipo de manual extra para poder evaluar realmente si era necesario o no hacerlo y qué era importante incluir en él en caso de serlo.
El resultado fue que las maestras no pudieron cargar el archivo y fuimos a ayudarlas y vimos, que como todos estamos acostumbrados, hacían doble click sobre él y en la xo no tenían ningún programa asignado para abrir un .tb por defecto. Esto no lo habíamos tenido en cuenta desde un principio que podía pasar ya que estábamos acostumbrados a abrir primero el programa y luego cargar el archivo. En base a esto fue que decidimos hacer un manual de usuario básico, el cual fue realizado en cooperación con las maestras, en donde se incluyeron 3 secciones, cada una con instrucciones simples y con imágenes de referencia.
Estas secciones son:
- Carga de archivo - explica paso a paso como cargar un archivo .tb
- Descripción del programa - Explica un poco las acciones importantes que se pueden realizar y las configuraciones a modificar
- Ejecución del programa - Explica cómo iniciar la aplicación y cómo finalizarla
A continuación se puede observar el manual que armamos: Archivo:Manual de usuario.pdf Editable del manual: Archivo:Manual de usuario.odt
En cuanto a la propuesta del código les pareció que era correcta y no tuvieron ninguna dificultad al intentar cambiar valores de las variables y ejecutar el programa.
Tips para programar el .tb:
- Modularizar todo lo que sea posible el código con el fin que sea más fácil de comprender no solo para la maestra sino para los que vayan a hacer el mantenimiento del mismo.
- Contraer todas las funciones.
- Las funciones que vayan a ser ejecutadas por la maestra dejarlas arriba y con un comentario por arriba del bloque contraible, que indique que se puede hacer click sobre el bloque y que acción se va a ejecutar.
- Las funciones que no vayan a ser ejecutadas por la maestra, dejarlas hacia abajo y sin comentario para no entreverar. En caso de querer poner un comentario de programación, realizarlo dentro del bloque contraible.
- Crear una acción que contenga toda la configuración posible. Para las variables, usar los box específicos para crear variables, poniendo nombres descriptivos y en español. Antes de cada box de una variable, agregar un comentario con una pequeña descripción de la misma. Esta descripción puede ser el rango de valores sobre el cual se trabaja, un valor por defecto para que la maestra tenga como referencia o cómo hacer para cambiar esa variable (por ejemplo en el caso del color).
- El programa principal, el "start", dejarlo lo más simple posible para poder entender rápidamente que es lo que hace el programa y en lo posible las acciones ponerles nombres en español.
Tips para crear el manual:
- Mantener al mínimo la cantidad de texto, pero siempre logrando que sea algo que se entienda. Indicaciones claras y concisas.
- Usar imágenes siempre que haya que indicar cómo hacer algo, poniendo indicadores en las imágenes (por ejemplo números) y luego haciendo referencia a los minimos para facilitar a la maestra a la hora de tener que buscar las cosas en el programa.
- Esto último también es aplicable a cuando hay que hacer una serie de pasos, indicar paso a paso en las imágenes también.
- Nos parece importante el tratar de que las imágenes y las indicaciones que hacen referencia a las mismas queden en la misma hoja para facilitar la lectura.
- Dividir en secciones el manual. De ser necesario, principalmente en la parte de descripción del programa, se pueden generar subsecciones para organizar mejor la información.
