Diatriba contra man e info

(Esquema basado en un hilo de discusión en la lista Lucas-desarrollo el 3 de diciembre de 2003)

© Ismael Olea, 2003/12/04

Sería un placer ver desaparecer ambos formatos (entre otros obsoletos) de la faz de la tierra.

Qué es qué

Por lo pronto hay que saber en propiedad de qué estamos hablando, porque al referirnos a estas tecnologías es frecuente confundir o mezclar alguno de los siguientes aspectos, que unidos constituyen un sistema de información completo:

Herramienta de acceso (interfaz):

Obviamente es la herramienta necesaria para acceder al tipo de documento en cuestión y se contemplan básicamente tres tipos:

Se considera aparte el navegador por ser una herramienta de convergencia para la búsqueda y recuperación de la información y porque pueden encontrarse versiones GUI y consola con todas las prestaciones mínimas que se esperaría de las mismas.

En el caso de man e info, ambas son básicamente herramientas de consola atadas a sus propios formatos, organización documental y política editorial. Osea, no se integran en ningún otro sistema que no sea el suyo. Ambas existen en gran parte por la tradición histórica Unix. Además, en general las herramientas de consola siempre son más complicadas de encontrar, usar y comprender por el usuario menos avanzado, acostumbrado al GUI, que es mayoría entre los usarios de informática. Esto significa que usando exclusivamente la consola, toda esta información probablemente sea inexistente para todos los usuarios por debajo de la media de conocimientos técnicos.

Además el interfaz de man no es hipertextual, así que comparado con las tendencias en hipertexto y multimedia es completamente obsoleto. Algunos esfuerzos como pinfo sirven para aprovechar las mínimas posibilidades hipertextuales de estos documentos. Pero ni siquiera ha podido sustituir a la venerable aplicación man.

pinfo además sirve para hacer mucho más manejables los documentos info, al utilizar combinaciones de teclas más cómodas, copiadas del navegador HTML lynx. Uno de los motivos por lo que la documentación info está tan desaprovechada es por las extrañas combinaciones de tecla de su interfaz de usurario.

En cuanto al GUI, hay algunas alternativas, también específicas, pero menos conocidas y que, en cualquier caso, están quedándose fuera del tremendo esfuerzo de convergencia que realizan los proyectos de software para el escritorio (principalmente GNOME y KDE)

Precisamente dentro de ese esfuerzo existen algunas iniciativas, al menos dentro de GNOME, de ofrecer un interfaz común para estos sistemas de información. Así primero fue nautilus en las versiones 1.* y a partir de la 2.0, yelp.

Ambas herramientas se han basado en el registro de metadatos que se mantiene a través de ScrollKeeper.

Estructura y esquemas de la organización documental

Partiendo de que la estructura de la organización de la información es cómo se guardan los datos en el sistema y el esquema cómo se maneja la misma en su organización lógica y presentación podemos comprobar que los casos de man e info ambas coinciden, lo que significa un aprovechamiento muy pobre de la información y la pérdida de casi todas las posibilidades para organizar el acceso de los usuarios de la forma más cómoda y eficaz.

Si al menos se utilizara una gestión de metadatos (por ejemplo usando scrollkeeper), podrían crearse esquemas de organización independientes de los «legacy systems».

Formato (fuente y de reproducción)

Tanto man como info están íntimamente ligados a sistemas automáticos de composición de textos, osea, a sistemas de representación de documentos. Troff/groff en el primero y TeX en el segundo. Afortunadamente para su código fuente ambos usan unas macros de más alto nivel (macros man en un caso y texinfo-LaTeX en el otro) con lo cual se puede decir que alcanzan cierto grado de estructuración.

Por otro lado no están disponibles herramientas libres, o que al menos gratuitas que corran en Linux que permitan alinear los textos y poder hacer una gestión de traducciones. Esto, y el desconocimiento en nuestro mundillo de las técnicas y métodos de traducción resulta en una cantidad de traducciones insufientes que en la mayoría de los casos quedan obsoletas durante tiempo indefinido.

En cualquier caso son tecnologías obsoletas dentro del marco de la Web en general y de la Web Semántica en particular, que son las tendencias actuales y de futuro más importantes. Esto es, no hacen uso de la norma XML, complicando la posibilidad de integrar los documentos actuales en sistemas basados en esta tecnología y otras relacionadas.

Política editorial

La política editorial de un proyecto es el esquema o las indicaciones de publicación que definen el marco de trabajo y el desarrollo del mismo. Como esa puede ser un área muy extensa aquí nos centraremos un poco en la clasificación de contenidos por su tipo. Con todo, estudiar esa clasificación según los usos más comunes y cómo racionalizarlos exigiría un trabajo aparte que tal vez presentemos en el futuro.

Por lo pronto se observan los siguientes usos:

documentos de ayuda
en docbook-xml o en HTML generados a partir de éste, asociados a aplicaciones GUI, orientados a usuarios finales.
info
principalmente usado en el proyecto GNU, con fuentes texinfo, suelen ser manuales de referencia de aplicaciones completas bastante exhaustivos, pero desde luego no suelen estar al alcance de los usuarios normales.
man
es la documentación tradicional de unix, basada en las macros man de troff; suelen ser documentos de referencia del uso de partes concretas del sistema, con documentos de tamaño mediano o pequeño, aunque con casos como la página man de bash, que pesa más de 200kb.
jerarquía /usr/share/doc
este es un cajón de sastre donde se recomienda que se guarde la documentación de las aplicaciones y prácticamente aquí puede encontrarse de todo (como los formatos que es explicaron más arriba) sin ningún orden o concierto particular.
--help
la propia ayuda de las aplicaciones accesible desde la línea de órdenes, que se le presupone a todas y que pretende ser una guía muy rápida que debe complementarse con el resto de la documentación.

Con esta variedad y la falta de una recomendación para racionalizar la documentación se producen documentos escasos, mal acabados y, casi peor, algunas veces duplicados.

Propuestas alternativas

parciales:

total:

Bibliografía: