El último post de esta miniserie. La documentación de nuestro proyectos, aquí veremos qué debe contener la documentación y un pequeño bonus track
Siendo sinceros, este fue el post que más me costó escribir, y es curioso por que la respuesta, una vez encontrada hace este post uno de los más simples de toda la serie.
La tan esperada respuesta es….
preguntale a tus usuarios
Así de simple, cada proyecto tiene su enfoque, su «público objetivo», sus metas, la problemática que busca solucionar. Son los usuarios a quienes queremos informarles algo, si bien tenemos unas bases como hemos visto a lo largo de la serie, fuera de eso depende en gran medida de como se vaya desenvolviendo sus usuarios, utilicen el FAQ como se converso en la P[arte] XXXXXXXXXXXXXXX, muestrenle como pueden reportar bug, aportar, pedir nuevas características, básicamente una vía de contacto con los desarrolladores como lo vimos en la P[arte] XXXXXXXXXXXXXXX. Recuerden también que la documentación se crea para hacer software más prolijo por lo que ese concepto nos puede ayudar a ir enriqueciendo la documentación
Pero fuera de eso, los mismos usuarios les pueden dar la brújula para encausar su documentación.
Ahora esto nos trae un pequeño problema, que pasa si no conocemos a nuestros usuarios, pues
Piensa como un usuario
Por más que nos creamos dioses por ser los creadores de un código, debemos recordar que nunca dejaremos de ser usuarios, usamos determinado editor de texto, determinado lenguaje de programación, determinado sistema operativo, en todos esos escenarios somos un usuario. quizás no tengamos tantas dudas como alguien que no conoce el mundo digital pero intentando colocarnos en esos zapatos de seguro irán surgiendo ideas para la documentación.
Ya para terminar esta miniserie, una página web que descubrí hace poco y ayuda bastante con el proceso de crear nuestra documentación es https://readme.so.
Y con este post, como comenté al inicio, damos por finalizada esta serie.
Espero haya sido de su agrado y los conceptos aquí tratados se tomen en cuenta para empezar a tomar en cuenta esta labor tan importante en todos los niveles.