Web BizarroWeb Bizarro

Suscríbete a nuestro Newsletter

X

Únete a nuestra lista de correos para recibir semanalmente actualizaciones de nuestro contenido.

Creando documentación súper fácil

Creando documentación súper fácil 28.OCT.14

Alvaro José Rios Ch
Fundador WebBizarro

La documentación es una parte esencial de todo desarrollo y más si piensas distribuirla o venderla ya que esta determinara la cantidad de personas que usen tus aplicaciones y herramientas. Generalmente cuando se crea una librería y se coloca en Github creamos un archivo Readme en el que colocamos la documentación y este crea un punto de partida para crear un sitio web llamativo con toda esta información.

 

DocumentUp

Esta librería JavaScript te permite crear la documentación de tu sitio desde archivos con MarkUP e incluso te permite obtener la información directamente del archivo Readme en tu repositorio de GitHub, lo que es una gran ventaja ya que te ahorra mucho trabajo ya que a la hora de actualizar solo debes hacerlo en un sitio.

Sitio web: http://documentup.com/

 

Docco

Esta librería utiliza el mismo concepto que la anterior para generar la documentación a partir de documentos con Markup, lo que la hace interesante es la forma en la que se encuentra desarrollada ya que usar CoffeeScript Literal, que permite desarrollar toda la librería como un archivo markup y luego el compilador toma el código y lo lleva a JavaScript dejando el resto como comentarios. Muy útil para ahorrar trabajo.

La librería usa highlightJS para resaltar el código y otras librerías para colaborar en la construcción de la documentación, es muy fácil de usar y el sitio generado tiene muy buena pinta.

Sitio Web: http://jashkenas.github.io/docco/

 

FlatDoc

Esta librería comparte las mejores cosas de las dos anteriores, fácil de usar, se conecta directamente a tu repositorio de GitHub. Además es fácil de personalizar y de manejar. Cuenta con distintos estilos predefinidos y puedes crear los tuyos. Una excelente opción para crear documentación, además si trabajas con CoffeeScript puedes usar el lenguaje Literal para ahorrarte mucho trabajo.

Sitio Web: http://ricostacruz.com/flatdoc/