Antiguo BlogDocumentaciónLinuxProyectos

La documentación en GNU/Linux

La documentación de todo software es un tema muy preocupante. Las distintas distribuciones comerciales de GNU/Linux poseen documentación en formato impreso. Pero el mismo no cubre la totalidad de funcionalidades y programas del SO, sino solamente lo que corresponde a su implementación particular, quedando en manos de los usuarios el adquirir documentación más específica. Sin embargo, existe tanto en la misma distribución como en Internet infinidad de documentación que puede ser consultada.

El mayor problema al instalar un SO nuevo o un programa, es que los usuarios y administradores no se toman el tiempo necesario para leer la documentación y es por ello que la mayoría de las llamadas a servicio técnico se deben más a problemas que están en la documentación que a los inesperados. Si se tomara el tiempo necesario para leer la documentación, el costo de servicio técnico se reduciría notablemente y esto en una empresa se tiene que tener en cuenta tratando que los usuarios y administradores puedan tener el material necesario para informarse de todos los aspectos del sistema.

Desde sus inicios los desarrolladores se han preocupado por mantener todo lo que se hizo en este sistema operativo bien documentado. Por esto existen numerosos proyectos que sirven para documentar cada aspecto del sistema y sus aplicaciones. Uno de los proyectos más conocidos es el LDP (Proyecto de Documentación de Linux), que se alza como una entidad centralizadora de documentación. Esto es bueno para tener un solo lugar en donde buscar toda la información necesaria.

GNU/Linux cuenta con gran cantidad de documentación en varios formatos y uno de los desarrollados por el LDP son los HOWTO que están disponibles muchas veces con la misma distribución o a través de Internet. En muchos casos estos HOWTO fueron escritos por los mismos autores que los programas y en otros por personas que se han visto en un problema real en una empresa, universidad u otra institución. También existen lo que se denomina MINI-HOWTO, que son guías rápidas para la pronta implementación de un servicio o un programa, sin detenerse en aspectos que no se utilizarán o se utilizarán rara vez. Se pueden encontrar, tanto los HOWTO como los MINI-HOWTO, en distintos formatos como en ASCII, PDF, PS, HTML, DocBook, etc. En nuestro país existe un mirror de documentación del proyecto LUCAS (LinUx en CAStellano), en el cual se podrán encontrar la mayoría de ellos.

Uno de las formas de documentación más populares y simples de acceder es el uso de las man-pages. Estas páginas de manual vienen en todas las distribuciones y cubren con notable detalle el uso de comandos o programas. Además los programas nuevos que se instalen traerán en su mayoría man-pages que se podrán acceder de igual manera que a las propias del sistema.Se accede a ellas con el comando

shrek@pantano$ man <comando>

Existen varias opciones que se pueden utilizar y se pueden buscar tecleando

shrek@pantano$ man man

con lo que aparecerán las páginas de manual del comando man.

Muchas veces las páginas de manual indican un número luego del comando Ej. ls(1). Esto indica que la información del comando ls puede encontrarse en la sección 1. Esta forma se remonta a cuando las man-pages de los sistemas Un*x venían en libros impresos que se dividían en secciones donde se abordaba el tema de un comando de acuerdo a su aplicación. También se puede contar con las páginas de INFO de cada comando, utilizando el comando

shrek@pantano$ info <comando>

donde se encontrara información menos detallada que en las man-pages pero de pronta utilización.

Un lugar donde buscar cuando se instale un nuevo programa es los archivos README. Estos explican todo el proceso de instalación así como también los requerimientos necesarios. Además cada programa cuenta con documentación propia que se podrá encontrar en los directorios /usr/doc y /usr/share/doc, pudiendo haber otros según el programa y/o la distribución. Los fuentes del kernel también poseen una gran cantidad de información sobre aspectos generales del SO y su funcionamiento, siendo una muy buena fuente de información al momento de meter mano al sistema, abundando los comentarios técnicos y los jocosos, dirigidos por los distintos desarrolladores a sus pares. Existen además muchísimas guías que cubren aspectos muy importantes y de alta complejidad del SO y sus aplicaciones. Cabe destacar que mucha de esta información se encuentra en español pero existe un número mucho mayor que esta en inglés. Proyectos como LuCAS tratan de que se revierta esto, aportando con su trabajo un aporte invaluable para toda la comunidad hispanoparlante. Por todo lo expuesto hasta aquí, puede decirse que GNU/Linux es uno de los sistemas con mayor cantidad de documentación que existe, tanto libremente como en forma de libros impresos por editoriales de renombre en el campo técnico. No quedan excusas para no informarse.

Sección La documentación en GNU/Linux del
Curso de Introducción a GNU/Linux
Historia, Filosofía, Instalación y Conceptos Básicos
escrito por
Sebastián D. Criado
y
Emiliano Gavilán
bajo licencia GNU FDL

http://www.lugro.org.ar/biblioteca/cursos/curso_intro/documentacion.html

  • Si lo que preguntas es por qué este sitio no está traducido a otros idiomas la respuesta es porque se trata de un blog personal alojado en un servicio gratuito (wordpress.com) en el que no existe la posibilidad de gestionar traducciones a otros idiomas, y aunque la tuviera, tampoco creo que fuera posible puesto que no hablo otros idiomas como para traducir los artículos que escribo.

    No obstante en este caso concreto quisiera aclarar que el artículo no es mío y este se encuentra bajo una licencia FDL por lo que cualquier interesado podría traducirlo a su idioma si así lo desease.