Diferencia entre revisiones de «Documentación de programas en Software libre»

De wiki EOI de documentación docente
Saltar a: navegación, buscar
(Página creada con «{{Sección |Título=Documentación de programas |Libro=Software libre |Capítulo=Licencias |Número sección=5 |Introducción=La documentación que viene con un programa es...»)
 
 
Línea 12: Línea 12:
 
Sin embargo muchas veces se hace documentación sobre programas por parte de terceros que no han intervenido en el desarrollo. A veces es documentación de carácter didáctico que facilita la instalación y uso de un programa concreto (HOWTOs, COMOs o recetarios), a veces es documentación más amplia, abarcando varios programas y su integración, comparando soluciones, etc., ya sea en forma de tutorial o de referencia. A veces es una mera recopilación de preguntas frecuentes con sus respuestas (FAQs o PUFs). Ejemplo notable es el Proyecto de Documentación Linux [tldp]. En esta categoría podemos también incluir otros documentos técnicos, no necesariamente sobre programas, ya sean las instrucciones para cablear una red local, construir una cocina solar, reparar un motor o seleccionar un proveedor de tornillos.
 
Sin embargo muchas veces se hace documentación sobre programas por parte de terceros que no han intervenido en el desarrollo. A veces es documentación de carácter didáctico que facilita la instalación y uso de un programa concreto (HOWTOs, COMOs o recetarios), a veces es documentación más amplia, abarcando varios programas y su integración, comparando soluciones, etc., ya sea en forma de tutorial o de referencia. A veces es una mera recopilación de preguntas frecuentes con sus respuestas (FAQs o PUFs). Ejemplo notable es el Proyecto de Documentación Linux [tldp]. En esta categoría podemos también incluir otros documentos técnicos, no necesariamente sobre programas, ya sean las instrucciones para cablear una red local, construir una cocina solar, reparar un motor o seleccionar un proveedor de tornillos.
  
Estos documentos son algo intermedio entre la mera documentación de programas y los artículos o libros muy técnicos y prácticos. Sin menoscabo de la libertad de lectura, copia, modificación y redistribución, el autor puede querer verter opiniones que no desea que se tergiversen, o al menos que esas tergiversaciones no se le atribuyan. O puede querer que se conserven párrafos, como agradecimientos. O que necesariamente se modifiquen otros, como el título. Aunque estas inquietudes pueden también manifestarse con los programas en sí mismos, no se han manifestado con tanta fuerza en el mundo del software libre como en el de la documentación libre.  
+
Estos documentos son algo intermedio entre la mera documentación de programas y los artículos o libros muy técnicos y prácticos. Sin menoscabo de la libertad de lectura, copia, modificación y redistribución, el autor puede querer verter opiniones que no desea que se tergiversen, o al menos que esas tergiversaciones no se le atribuyan. O puede querer que se conserven párrafos, como agradecimientos. O que necesariamente se modifiquen otros, como el título. Aunque estas inquietudes pueden también manifestarse con los programas en sí mismos, no se han manifestado con tanta fuerza en el mundo del software libre como en el de la documentación libre.
 
|Apartados=
 
|Apartados=
|Estado=esbozo
+
|Estado=completo
 
}}
 
}}
 
{{Prueba
 
{{Prueba
|Prueba=f
+
|Prueba=No
 
}}
 
}}

Revisión actual del 17:27 23 may 2012


Estado de desarrollo de la sección: completo completo

Wikilibro: Software libre > Capítulo 3: Licencias

Sección 5

Documentación de programas
La documentación que viene con un programa es parte integrante del mismo, igual que los comentarios del código fuente, como reconoce, por ejemplo en España, la Ley de Propiedad Intelectual. Dado este nivel de integración, parece lógico que se le apliquen las mismas libertades y evolucione de la misma manera que el programa: toda modificación que se haga de un programa requiere un cambio simultáneo y consistente en su documentación.

La mayor parte de esta documentación suele estar codificada como ficheros de texto sin formato, ya que se pretende que sea universalmente accesible con un entorno de herramientas mínimo, y (en el caso de los programas libres) suele incluir una pequeña introducción al programa (README o LEEME), instrucciones de instalación (INSTALL), alguna historia sobre la evolución pasada y futura del programa (changelog y TODO), autoría y condiciones de copia (AUTHORS y copyright o COPYING), así como las instrucciones de uso. Todas ellas, menos la autoría y las condiciones de copia, deberían ser libremente modificables según el programa evoluciona. A la autoría sólo se le deberían añadir nombres y créditos, pero sin borrar nada, y las condiciones de copia sólo deberían modificarse si estas mismas lo permiten.

Las instrucciones de uso suelen estar codificadas en formatos más complejos, ya que suelen ser documentos más largos y ricos. El software libre exige que esta documentación pueda ser modificada fácilmente, lo que a su vez obliga a usar formatos denominados transparentes, de especificación conocida y procesables por herramientas libres, como son, además del texto puro y limpio, el formato de páginas de manual de Unix, TexInfo, LaTeX o DocBook, sin perjuicio de distribuir también el resultado de transformar esos documentos fuente en formatos más aptos para visualizar o imprimir, como HTML, PDF o RTF (formatos en general más opacos).

Sin embargo muchas veces se hace documentación sobre programas por parte de terceros que no han intervenido en el desarrollo. A veces es documentación de carácter didáctico que facilita la instalación y uso de un programa concreto (HOWTOs, COMOs o recetarios), a veces es documentación más amplia, abarcando varios programas y su integración, comparando soluciones, etc., ya sea en forma de tutorial o de referencia. A veces es una mera recopilación de preguntas frecuentes con sus respuestas (FAQs o PUFs). Ejemplo notable es el Proyecto de Documentación Linux [tldp]. En esta categoría podemos también incluir otros documentos técnicos, no necesariamente sobre programas, ya sean las instrucciones para cablear una red local, construir una cocina solar, reparar un motor o seleccionar un proveedor de tornillos.

Estos documentos son algo intermedio entre la mera documentación de programas y los artículos o libros muy técnicos y prácticos. Sin menoscabo de la libertad de lectura, copia, modificación y redistribución, el autor puede querer verter opiniones que no desea que se tergiversen, o al menos que esas tergiversaciones no se le atribuyan. O puede querer que se conserven párrafos, como agradecimientos. O que necesariamente se modifiquen otros, como el título. Aunque estas inquietudes pueden también manifestarse con los programas en sí mismos, no se han manifestado con tanta fuerza en el mundo del software libre como en el de la documentación libre.

< Sección anterior
Distribución bajo varias licencias