Formato estructurado para los documentos

La elección es clara. Es preciso optar por formatos completamente estructurados basados en las tecnologías SGML/XML.

Se presentan por riguroso orden de preferencia.

docbook

Hoy día es el formato estándar de documentación técnica libre. Cubre todas las necesidades de la mayor parte de los casos de documentación informática, técnica y puede ser usada perfectamente en otros muchos casos.

Está disponible en versiones SGML y XML.

Sufre carencias como la de no poder trabajar con fórmulas pero esto es algo que en el futuro podría solucionarse mediante el uso de tecnologías XML como «namespaces» y «schemas».

Al ser una herramienta desarrollada desde hace varios años ya están disponibles filtros y sistemas de impresión libres y comerciales con formatos de salida populares.

linuxdoc-sgml

Este formato ha sido muy importante porque supuso el primer paso en la estructuración de la documentación libre. Sin embargo sufre de muchas carencias en el etiquetado que docbook soluciona.

Existen algunos filtros para transformar desde linuxdoc-sgml a docbook, pero si no se mejoran precisan de asistencia y revisión.

A falta de pan buenas son las tortas pero en cualquier otro caso recomendamos encarecidamente usar docbook.

html

HTML es de todos estos formatos el más conocido con diferencia. Sin embargo sus pobres características para estructurar documentos lo hacen completamente desaconsejable excepto para casos de emergencia, y aún así también debería estar prohibido.

Su uso como formato de representación no entra dentro de esta sección (que está dedicada al código fuente) sino en otra parte del documento.

Sólo se podría admitir su uso para documentos extremadamente sencillos y siempre que se use la norma estrictamente, pero sigue siendo igualmente desaconsejable al estar disponible la tecnología DocBook.