Ciclo de Trabajo de Codice Software V - Documentación
En los capítulos anteriores hemos hablado de herramientas, procesos de test... y hoy voy a enseñaros donde se guarda toda la sabiduría de este proceso.
Doc Snippets
El equipo de Plastic SCM quería salvaguardar todo el trabajo realizado por cada tarea. pero en formato texto (Texto, sí, has leido bien. Esto aumenta los puntos dentro del programa de hackers!).Desde hace 8 meses, crean un fichero donde puedes encontrar:
- Qué hace cada tarea
- Por qué es importante esa tarea
- Enlaces con otras tareas
- Imágenes de la funcionalidad añadida
Items en el repositorio de TaskDocumentation
Hubo un planteamiento de adjuntarlo todo en el issue tracker, pero les daba rabia no meterlo en un repositorio de Plastic SCM.
El idioma oficial dentro de Plastic SCM es el inglés así que excepto las tareas primitivas, todo lo que te vas a encontrar está escrito en inglés.
¿Cuál es el sentido de los doc snippets?
Cuando alguien del equipo está realizando una tarea, escribir un pequeño texto de no más de 10 líneas no lleva mucho tiempo, unos minutos.Gracias a ese pequeño esfuerzo estás generando material muy valioso para:
- Blog posts: con el texto que cuenta la explicación de la tarea, el por qué, capturas de pantalla, tienes el inicio para poder escribir un post.
- Actualización de manuales: ayudamos a la "technical writer" de Estados Unidos, para que no tenga que buscar las mil y una diferencias entre versiones ella sola. Dejar la documentación coherente, sin faltas ortográficas, es su trabajo... pero explicar el sentido de la nueva característica, o la mejora en el rendimiento es labor de cada miembro del equipo.
|
|
Imagenes de una tarea en el TaskDocumentation
0 comentarios:
Publicar un comentario