miércoles, 25 de septiembre de 2013

Resumen Asciidoctor para mejorar tu documentación

Hola devs !!


El pasado 18 de Septiembre tuvimos la oportunidad de asistir a una fantástica presentación de AsciiDoctor a cargo de Alex Soto (@alexsotob) .


Alex nos introdujo al mundo de los distintos formatos de documentación y entre ellos AsciiDoctor como una opción muy ligera y con bajo índice de rastro en los documentos que nos permite tener la documentación del proyecto integrada con nuestro Sistema de Control de Versiones favorito para permitir la Colaboración y la trazabilidad de cambios.

Pudimos ver desde los caracteres de control más sencillos para crear títulos, negritas, listas ... hasta formas de crear fórmulas matemáticas. También comprobamos cómo se puede integrar perfectamente con tu IDE preferido y algunos consejos sobre dónde colocar los distintos ficheros de documentación para que sea más cómoda su gestión y trazabilidad (ej: requerimientos, decisiones de diseño, etc).

Entre los asistentes, surgieron algunas dudas a nivel de renderizado de la documentación y de los plugins disponibles a los que Alex dió respuesta y nos anunció que sin lugar a dudas, ya están trabajando en un editor WYSIWYG que no sólo sirva a equipos de desarrollo, sino a otras personas menos acostumbradas a trabajar con ficheros de texto en lugar de editores de documentos clásicos (Word, OpenOffice, etc).

Por cierto, la presentación -no podía ser menos- está realizada con AsciiDoctor ;-)


Aquí os adjuntamos el link al vídeo de la charla y la presentación. 


Ya sabes, si quieres tratar tu documentación como tu código fuente, no lo dudes, y prueba Asciidoctor, seguro que no te decepcionará.

Un saludo,

No hay comentarios:

Publicar un comentario