[Jde] documentación de JDE en mediawiki, no os corteis, escribid

JoseMaria jmplaza en gsyc.es
Sab Oct 11 21:50:25 CEST 2008


Buenas,

se acerca el momento del primer paquete debian con todo jde y
completamente autotoolizado. Les vendrá muy bien a los alumnos de
Robotica-Master e Introducción-a-la-robótica que lo van a usar en sus
prácticas. Uno de los puntos mejorables es la documentación. "Mejorable"
por decir algo, la realidad es que esa documentación es casi inútil
porque no refleja los cambios desde la 4.2.1 (ni la 4.3) y está casi
casi obsoleta..., apenas sirve para transmitir la "idea general". 

Hasta hace unas semanas la documentación residía en el directorio docs,
con un documento latex que hacía de manual de JDE,  el manual de Progeo
y varios howtos para herramientas externas (gazebo, etc.). Para mejorar
la documentación hemos optado por olvidarnos de los documentos en latex
y que el mediawiki en la página del proyecto sea la fuente oficial de
información.

En concreto lo he articulado en dos entradas en la sección
"documentation":
 (1) un FAQ donde escribir, con preguntas y respuestas, información
sobre herramientas (svn,blog,...), software de terceros (gazebo, opengl,
player, stage...) y los buenos usos y costumbres.
(2) un Manual donde describir JDE para usuarios y desarrolladores.
Además del diseño y arquitectura se explica cada uno de los componentes
de jde incluidos en la distribución oficial: esquemas, drivers y
servicios.  

Usálos para consultar ahí tus dudas y escribe en ellos. Este manual es
para nosotros y lo construimos entre todos. Cuando aprendas alguna cosa
interesante, súbela al mediawiki. De momento está en mantillas, porque
está arrancando, pero distribuyendo la tarea conseguiremos tener un
manual actualizado en breve y podremos beneficiarnos de ello. He hablado
con varios de vosotros para que os encargueis de actualizar alguna
parte. También he creado varios tickets en el trac sobre ello. Toda
ayuda es bienvenida: lo que veas que falta, pónlo en el mediawiki, y si
ves que algo es erróneo, corrígelo sin miedo.

Ánimo,

JoseMaria
-- 
http://gsyc.es/jmplaza 
Universidad Rey Juan Carlos




More information about the Jde-developers mailing list