Libertonia
Portada · Todo · Software Libre · Desarrolladores · Comunidad · Internet · Tecnología · Meta · Diarios
Documentacion? Que documentacion?

Comunidad
Por sinner
departamento programas-sin-doc-actaulizada , Sección Desarrolladores
Puesto a las Wed Jul 28th, 2004 at 11:12:34 PM CET

Se acerca el SysAdmin Day a pasos agigantados, tal como nos lo recuerda pbenavent en su entrada del diario. Y voy y me encuentro este oraculo cuando no me he tomado ni el cafe:

"Dear open source developers: We sysadmins are tired of the crap you've been throwing at us. It seems you've been assuming all these years that we sysadmins are coders, and thus, "the code is the documentation." In reality, we are not coders. We are systems administrators, which is precisely why the word "coder" does not appear on anything which also has our name on it -- and thus, your mantra is no longer cute".

 


El parrafo en cuestion viene a decir tal que asi:

"Estimados desarrolladores de Open Source: Nosotros, los sysadmins (administradores de sistemas) estamos cansados de toda la porqueria que nos habeis estado lanzando. Parece como si todos estos anyos hubieseis estado pensando que nosotros, los sysadmins, somos desarrolladores. Y por consiguiente "el codigo es la documentacion". En el mundo real, no somos desarrolladores. Somos administradores de sistemas, y por eso es por lo que la palabra "desarrollador" no aparece en nada que tenga nuestro nombre -- por consiguiente, vuestro mantra no hace puta gracia".

Con esta provocadora introduccion, Brian Jones, en el articulo "!Es la docuemntacion, Estupido!", de la columna SysAdmin to SysAdmin se queja y enumera las razones porque los SysAdmins no usamos todo ese codigo "guays" que con tanta pasion y devocion generan tantos desarrolladores de productos OpenSource.

Y yo me he quedado pensando. ?Tiene razon Brian? ?O se trata acaso de otra excusa-BOFH?

Pues, la verdad, tiene razon. Un numero considerable de productos que he probado porque, al parecer, me iban a solucionar unos problemas, han resultado ser un autentico lio debido a la falta de documentacion, o la falta de documentacion clara o a la falta de documentacion actualizada.

No me sirve que me digan RTFM, si el Puto Manual no esta al dia. Si en cada producto tengo que probar, en orden, man foobar, pinfo foobar, foobar --help, foobar -h, foobar /?, less foobar.c .... que quereis que os diga, no me hace punyetera gracia. Y si el programa ya es en ocaml o en FORTRAN-orientado-a-objetos o cualquier otra aberracion de esas, el less foobar.$ solo me servira para perder el tiempo al leer los comentarios graciosos del codigo.

La versionitis esta muy bien... para el escritorio, la transparencia en el cursor y la ovejita que trisca por la pantalla. Pero para un programa de administracion de sistemas en imprescindible saber que hace, como lo hace, si tiene algun fallo conocido y como reportar problemas.

No me extranya que existen tantas paginas de "recetas", "HOWTOs" (algunos bastante desfasados) y similares en internet. Todas estas paginas existen, son tan famosas y son tan utiles porque la documentacion oficial es inutil. Si fuera util, ?para que re-escribir la docuemantacion?

Si eres un desarrollador de productos Open Source ten a tus usuarios en cuenta: escribe algo de documentacion. O pidele a un colega que la escriba por ti a cambio de un par de cervezas. El Open Source no necesita unicamente de desarrolladores: los escritores de documentacion son igualmente precisos y, si son Rubias, preciosas.

Si eres SysAdmin, ?has encontrado programas OpenSource que, aunque interesantes, hayas dejado estar por falta de buena documentacion? ?Sera por eso que siempre estamos creando nuestros scripts, porque nadie proporciona documentacion adecuaday tenemos que acabar reinventando la rueda porque al menos nuestra rueda conocemos como funciona?

Si no eres ni SysAdmin ni desarrollador, ?que opinas?

Salut,
Sinner

< El canon. Objetivo: el Tribunal Constitucional (7 comments) | Debian y sus problemas con la MPL (10 comments) >
Enlaces Relacionados
· escomposlinux.org
· pbenavent
· diario
· !Es la docuemntacion, Estupido!
· SysAdmin to SysAdmin
· excusa-BOFH
· More on Comunidad
· Also by sinner

Encuesta
La documentacion...
· es el codigo fuente 21%
· esta desfasada 24%
· esta incompleta 39%
· esta perfecta 3%
· me remito a los HOWTOs 3%
· la escribo yo 9%

Votos: 33
Resultados | Otras Encuestas

Menu
· crear cuenta
· FAQ
· búsqueda
· Fuentes de Noticias

Login
Nueva cuenta
Usuario:
Contraseña:

Ver: Modo: Orden:
Documentacion? Que documentacion? | 12 comentarios (12 temáticos, editoriales, 0 ocultos)
No sólo sysadmins (none / 0) (#1)
por jorginius ("jorginius" en Google Mail) a las Wed Jul 28th, 2004 at 03:24:54 PM CET
(Información Usuario) http://www.rodriguezmoreno.com

No sólo los sysadmins no tienen buena documentación, tampoco los desarrolladores la tienen, muchas bibliotecas y frameworks están sólo parcialmente documentados o no lo están en absoluto.

Desde el punto de vista del picateclas esto es lo que yo veo casi siempre:

Por un lado tienes un framework libre, gratis, sin royalties pero al que le tienes que echar un montón de tus horas para suplir la documentación. Como no tienes referencias se puede dar el caso de que descubras al final que no sirve para lo que quieres hacer, aunque la buena noticia es que al tener el código a lo mejor puedes adaptarlo (más horas).

Por otro tienes un framework propietario caro y con una buena documentación (o no), con información más precisa de lo que puedes o no puedes hacer con él y con menos posibilidades de ver que no te sirve después de estar dos meses lidiando con él o, en este último caso, con un servicio de atención detrás que haga las adaptaciones por ti incluido en el precio (o no).

En fin, es cuestión de la prisa que tengas, de lo que cuesta tu tiempo y de valorar si te merece la pena. Lo que está claro es que la documentación del software libre ni es buena ni es fácil de encontrar ni está actualizada, en general... E irse a mirar al código fuente es ya lo último: el código es la peor documentación posible a la que recurres cuando no te queda más remedio, y no te digo ya si no eres programador.



Qt Qt Qt (none / 0) (#3)
por TSDgeos a las Thu Jul 29th, 2004 at 12:16:33 AM CET
(Información Usuario)

Pues eso que Qt tiene una documentación cojonuda y es libre (solo para linux eso si)

http://doc.trolltech.com/

[ Padre ]


Puntualizacion (4.00 / 1) (#6)
por ridiculum a las Thu Jul 29th, 2004 at 12:24:31 AM CET
(Información Usuario)

Solo para X11 y Mac OS X. La version embedded no se que licencia tiene. En win32 existe una version gratuita para uso no comercial o algo asi que se quedo en Qt 2.x.

[ Padre ]


Puntualizacion de la puntualizacion :D (4.00 / 1) (#7)
por TSDgeos a las Thu Jul 29th, 2004 at 12:33:30 AM CET
(Información Usuario)

También hay versión gratuita para uso no comercial de Qt 3.2 que solo se puede obtener comprando el libro "C++ GUI Programming with Qt 3" http://dot.kde.org/1076068778/

La versión no comercial para windows que se puede descargar desde la web de trolltech es la 2.3 http://www.trolltech.com/download/qt/download_noncomm.html

[ Padre ]


 
Puntualizacion (none / 0) (#4)
por ridiculum a las Thu Jul 29th, 2004 at 12:23:03 AM CET
(Información Usuario)

Solo para X11 y Mac OS X. La version embedded no se que licencia tiene.

[ Padre ]


 
Abuelo Cebolleta cascarrabias =) (none / 0) (#2)
por jcantero (jcantero@agujero-negro.escomposlinux.org) a las Wed Jul 28th, 2004 at 04:10:41 PM CET
(Información Usuario) http://www.escomposlinux.org/jcantero/

<voice person="abuelo Simpson">

El tal Brian Jones es un nenaza. En mis tiempos, programábamos/cortocircuitábamos el micro con un clip Nº4. ¡Y no nos quejábamos tanto, leñe! :-P

Estos sysadmnis de hoy se han hecho unos blandurrios.
</voice>

--
"Papá, ¡Internet es más que una red pornográfica global!" -- Lisa Simpson


 
Y tu que haces por el software libre? (none / 0) (#5)
por TSDgeos a las Thu Jul 29th, 2004 at 12:23:18 AM CET
(Información Usuario)

Vale ya se que parezco alguien de barrapunto :D pero voy a explicar que pasa (IMHO):
- El programador no necesita manual de su programa, con lo cual no siente motivación especial para escribirlo
- El programador es un mal escritor de documentación para su programa ya que suele dar por obvias bastantes cosas
- Si pones a un programador entre el dilema de añadir features, corregir bugs o escribir el manual, nunca pensará que escribir un manual sea tan importante como hacer su programa aun más bueno.

Por lo tanto se necesita gente externa que ayude a escribir documentación.



¿Eso no pasa ya? (none / 0) (#8)
por algarcia a las Thu Jul 29th, 2004 at 01:47:12 AM CET
(Información Usuario)

Yo en las aplicaciones suelo ver Escrito por, Documentado por, Traducido por. Y los nombres de los que documentan no son los mismos de los que escriben...

¿O se está hablando de aplicaciones muy específicas donde nadie documenta? :-?

--
No me pregunto lo que yo puedo hacer por el S.L., si no lo que todos vosotros podéis hacer por mí. :-P
[ Padre ]


 
Deja vu: Gonzo, Sinner, Pere y el rubio (none / 0) (#9)
por pbenavent a las Thu Jul 29th, 2004 at 07:54:41 AM CET
(Información Usuario) http://www.benavent.org

Deja vu es una expresión jcantero TradeMark (que os la explique él) y no seais cochinos, que el título no es una de esas orgias entre todos los que apareceremos en el título...

Gonzo compartía sus preocupaciones acerca de programar -que casualidad que hablé de comentar el código-, Sinner recoje mi entrada -gracias, yo también sufro en silencio- y el rubio es mi hermano que me tiene liado haciendole una página web, a mi, que no soy diseñador ...

La cosa es que ahora va el c*br*n y me pide que le haga un programita para llevar su empresa, -la contabilidad creo que la llevará con el contapus- y esto me pone en la situación un poco de Gonzo, Sinner y yo mismo conmigo.

Hazle algo a tu hermano, que el quiere verlo en Hasefroch XP, que uno sabe hacerlo en el sanex ese del pingüinito ... y te acuerdas de todos los Luser del mundo por ser uno de ellos...

¿Como hacer una aplicación en Linux que mi hermano pueda utilizar en Hasefroch? Documentada, por favor, que luego no habrá quien le meta mano.

Es un poco un cruce de las entradas de Sinner y Gonzo. He visto IDE's y aplicaciones ya hechas... había pensado en enchufarle un Apache2.X al Hasefroch, una PostgreSQL y hacerlo en PHP...

No soy desarrollador y necesito como todos no, más, la documentación para dentro de dos meses saber qué hacia una función y no romperme las meninges relendo código o comentarios en el código. Creo que un IDE bien acabado debe posibilitar que se documente como una parte más del proceso: ¿Sugerencias?

--
"El hombre es la medida de todas las cosas"
Protágoras


¿quien necesita limitarse a un ide? (none / 0) (#10)
por jluis a las Thu Jul 29th, 2004 at 08:44:58 AM CET
(Información Usuario)

No soy desarrollador y necesito como todos no, más, la documentación para dentro de dos meses saber...

... un IDE bien acabado debe posibilitar que se documente como una parte más del proceso: ¿Sugerencias?


Yo normalmente uso perl con los comentarios en POD reservando los comentarios puros y duros para algun "dirty hack". Sin necesidad de ides y con independencia del editor te permite mantener la documentacion y el codigo simultaneamente y disponer de la documentacion por separado.

Me parece recordar que tambien se puede utilzar TEX para este proposito pues fueron estas necesidades las que iniciaron este desarrollo.

[ Padre ]


 
Prueba Galopin (none / 0) (#11)
por melenas a las Fri Jul 30th, 2004 at 12:31:48 AM CET
(Información Usuario)

¿Como hacer una aplicación en Linux que mi hermano pueda utilizar en Hasefroch? Documentada, por favor, que luego no habrá quien le meta mano.¿Sugerencias?

Pues tenemos a Galopin que tiene la ventaja de ejecutarse sobre un navegador al usar LAMP, aunque si está escaso de máquinas supongo que se podría usar también WAMP ;-)

Pero de manuales, si exceptuamos el de instalación, pues va bastante escaso.

Yo por mi parte ahora mismo estoy probando Facturalux Lite, aunque también probaré Galopín y Bulmages para ver cual integro en un proyecto que tengo en mente, ya os contaré.


FDO. ER_MELENAS No te preguntes sólo que puede hacer el S.L. por ti sino también que puedes hacer tú por él.
[ Padre ]


Tennos informados (none / 0) (#12)
por pbenavent a las Fri Jul 30th, 2004 at 08:12:37 AM CET
(Información Usuario) http://www.benavent.org

Me resulta muy interesante lo que comentas. Primero, sé que cosas como FacturLinux, Bulmages ... otros, pero a mi hermano, de momento no puedo ponerle Linux por una aplicación del negocio que le venden y que solo va con Hasefroch. Lo que nos deja con cosas como Galopin.

De Galopin había leído que no es un ejemplo su manejo de variables globales, no es un problema si se ejecuta todo en el equipo local. De hecho pensé en cojerlo para hacer mi propio fork:
  • ver si encaja en lo que quiere el rubio
  • cambiarle el aspecto a lo que el quiere
    necesita un seguimiento de qué le ha comprado el cliente X y que le aparezca en cuanto le aparece el cliente, para preguntarle, que tal te fue el último tinte que te vendí y quedar bien o ver porque cambia sus habitos.
  • en cuanto a core de la cosa me gustan las aplicaciones LAMP que vienen preparadas para conectarse a PostgreSQL -casi todas trabajan con Mysql a pesar de los últimos cambios de licencia de Mysql que opinais?, prefiero un fichero de configuración en el que elijes DB y esta todo resuelto para una o la otra...
  • retocar el código para evitar uso de variables globales es una tarea para largo me lo fiais que decía el Tenorio


--
"El hombre es la medida de todas las cosas"
Protágoras
[ Padre ]


 
Documentacion? Que documentacion? | 12 comentarios (12 temáticos, editoriales, 0 ocultos)
Ver: Modo: Orden:

ecol Logo Powered by Scoop
Todas las Marcas Registradas y copyrights de esta página son propiedad de sus respectivos dueños.
Los comentarios son propiedad del que los escribe.
Los iconos de las noticias y el logotipo son propiedad de Javier Malonda.
El Resto © 2002 Escomposlinux.org y aledaños.

Puedes sindicar los contenidos de libertonia en formato RSS 1.0 y RDF 0.9. También se puede sindicar la cola de envíos pendientes de moderación.

El proyecto escomposlinux.org está dedicado a la memoria de tas

crear cuenta | faq | búsqueda