jueves, 2 de junio de 2011

Documentation usando herramientas libres

Una conferencia dictada por Jared Smith (Lider del proyecto Fedora).

En esta conferencia Jared nos habló sobre como crear documentación usando DocBook, un sistema para escribir documentos estructurados usando XML, el cual es excelente para escribir libros y artículos acerca de cualquier tema. Es un formato amplio y robusto y debido a su estructura refleja muy bien la nocion de lo que constituye un libro, DocBook ha sido adoptado por una larga y creciente comunidad de autores.

Entre sus principales características y ventajas tenemos:
  • usa XML
  • permite una separación del contenido y la presentación
  • se puede convertir fácilmente en otros formatos como LaTex, HTML, pdf entre otros.
  • un autor solo precisa escribir su libro una vez y usando la capacidad de conversión del XML con DocBook se pueden generar prácticamente de inmediato muchos libros en distintos formatos (epub, HTML, LaTex, pdf, etc)
  • existe soporte en varios editores
  • existe la posibilidad de dividir un libro en varias partes más pequeñas usando Xincludes
  • es posible hacer algunas versiones para objetivos específicos.
  • soporta la creación de entidades que pueden ser usadas para evitar repeter ciertos textos una y otra vez.

¿ejemplos y tags soportados?
La documentación de DocBook es muy completa y extensa por lo que recomiendo leerla y también mirar algunos ejemplos.

¿Herramientas recomendadas?

Publican es un sistema de publicación para DocBook, además de una herramienta de procesamiento. Además de validar que nuestro XML (DocBook) es válido, publica, se asegura de que cumple con los estandares de un documento "publicable"

Publican permite crear documentos en formato DocBook así como convertirlos en muchos otros formatos de forma muy simple.

Aunque admito que tengo que leer un poco más sobre publican, en su presentación Jared demostró que es muy simple crear documentos y convertir los a otros formatos usando esta herramienta.

Saludos.