previous |
start |
next
Política editorial: clasificación por 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.
previous |
start |
next