[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