Documentos de diseño y planificación

[hugoruscitti]

Saludos, para llevar adelante el proyecto me parece una
buena idea escribir algo de planificación sencilla para
que podamos comenzar a escribir algo de código.

La idea general de documentar de manera sencilla es asentar
ideas, definir metas y crear listas de tareas para que nos
resulte mas sencillo y efectivo a la hora de ponernos a
codificar. Es algo práctico digamos, lo hacemos porque nos
conviene...

Ahora lo específico: Toda la documentación se almacena en
el mismo repositorio donde está el código, la idea de hacer
esto así es para que nos resulte sencillo corregir detalles
de documentación a medida que escribimos código.

La planificación está formada por archivos de texto
sencillo (algo como un wiki), por lo que nos resultará muy
sencillo consultar y hacer cambios. De hecho, es fácil incluso
convertir todo eso a HTML o PDF porque usamos el sistema de
documentación "sphinx" (el mismo que usa el proyecto 'python').


Para acceder a la documentación tienen dos formas:

1 - entrar en el directorio 'doc' de repositorio (generalmente indicado
solo para programadores del proyecto).

2 - entrar directamente a la versión web que tiene imágenes
y se puede ver desde el navegador (versión ideal para
seres humanos):

Pueden ver esta versión accediendo a:

http://asadetris.googlecode.com/hg/doc/ ... index.html

(PD: luego tendríamos que hacer mas visible este link en otro post)


A grandes rasgos, la metodología para documentar es editar
archivos de texto plano en el repositorio; y luego de hacer un
cambio significativo se puede ejecutar un comando para generar
todo el sitio web que cité antes.

A mi entender, es una buena herramienta porque no agrega mucho
trabajo adicionar, es simple y produce un valor significativo
para el proyecto.

¿Que les parece a ustedes?

[Juanxo]

He visto la página de la documentación y me ha gustado, principalmente porque queda todo más claro, pero sin que ello requiera de un esfuerzo tremendo para mantenerlo y ampliarlo.

En cuanto a lo que he leido, solo tengo que añadir una tontería de nada. En los controles pones que durante el juego se utiliza el teclado. Especifica las teclas a usar, pero no habla de la manera en que el usuario pueda abandonar el juego. Las dos formas que yo veo serían o bien pulsando un botón de exit, o bien pulsando la tecla ESCAPE

También hay que dejar bien claro los que vamos a participar para ver un poco con todos los recursos que contamos(incluyendo los recursos humanos).

Un saludo

[hugoruscitti]

En cuanto a lo que he leido, solo tengo que añadir una tontería de nada. En los controles pones que durante el juego se utiliza el teclado. Especifica las teclas a usar, pero no habla de la manera en que el usuario pueda abandonar el juego. Las dos formas que yo veo serían o bien pulsando un botón de exit, o bien pulsando la tecla ESCAPE

También hay que dejar bien claro los que vamos a participar para ver un poco con todos los recursos que contamos(incluyendo los recursos humanos).

Si, tienes razón. Olvidé esos dos temas.

Recién edité los archivos del repositorio y notifiqué esos dos
faltantes. Agregué información sobre como salir del juego
y también generé un archivo llamado AUTHORS con el
nombre de todos los que confirmamos participar.

Actualicen sus copias del repositorio para ver los cambios...

Saludos.

[Dokan]

Quisiera comentar que he estado echando un vistazo al proyecto que comentó nuestra compañera Postit que está siendo desarrollado en grupo en el foro de callosenlosdedos.org, el proyecto se llama Street Fighter SDL, seguro que ya lo conocíais.
En el foro de su proyecto podemos encontrar algunas cosas interesantes que deberíamos tener en cuenta.
En este mensaje se enlazan varias cosas que me han parecido interesantes; el diagrama UML de su proyecto y un artículo sobre modularidad y reutilización.
Me ha parecido que es una buena forma de comenzar cualquier proyecto, y aunque no sé ni cómo se hace, creo que deberíamos empezar por crear también el diagrama UML de Asadetris para dejar claro los caminos a seguir y repartir el trabajo de una forma más sencilla.
¿Qué opinais?
Otra cosa que me ha llamado la atención y de la que podemos aprender también, es que el último mensaje del proyecto SF SDL es del 17/05/2009, por lo que parece que está parado. Supongo que por exámenes. Espero y deseo que nosotros lleguemos hasta el final.
Por mi parte voy a buscar información sobre diagramas UML para ver si puedo aportar algo en este sentido.

[hugoruscitti]

Quisiera comentar que he estado echando un vistazo al proyecto que comentó nuestra compañera Postit que está siendo desarrollado en grupo en el foro de callosenlosdedos.org, el proyecto se llama Street Fighter SDL, seguro que ya lo conocíais.
En el foro de su proyecto podemos encontrar algunas cosas interesantes que deberíamos tener en cuenta.
En este mensaje se enlazan varias cosas que me han parecido interesantes; el diagrama UML de su proyecto y un artículo sobre modularidad y reutilización.
Me ha parecido que es una buena forma de comenzar cualquier proyecto, y aunque no sé ni cómo se hace, creo que deberíamos empezar por crear también el diagrama UML de Asadetris para dejar claro los caminos a seguir y repartir el trabajo de una forma más sencilla.
¿Qué opinais?
Otra cosa que me ha llamado la atención y de la que podemos aprender también, es que el último mensaje del proyecto SF SDL es del 17/05/2009, por lo que parece que está parado. Supongo que por exámenes. Espero y deseo que nosotros lleguemos hasta el final.
Por mi parte voy a buscar información sobre diagramas UML para ver si puedo aportar algo en este sentido.

Me parece una muy buena idea, incluso si tienes contacto
con ellos seria interesante avisarles, tal vez quieran compartir
con nosotros parte de su experiencia.

Con respecto a los diagramas, recién para la etapa 2 (ver
archivo "doc/etapas.otl") comenzaríamos a utilizar el
concepto de objetos y clases. Así que hasta entonces no
usaríamos diagramas, eso sí, a partir de ahí vamos a usar
los diagramas, cómo se tienen que llamar las funciones y
que tendrían que hacer... es muy buena tu recomendación,
la vamos a seguir.

Saludos.

[Dokan]

Sólo añadir que los compañeros de callosenlosdedos.org utilizaban la plataforma web www.gliffy.com para hacer los diagramas, también me la ha recomendado Juanxo por mensaje privado, hay que registrarse pero es gratuito.
Estoy siguiendo el hilo del SF SDL que trata sobre UML para ver el proceso que han seguido para desarrollar el diagrama (a ver si aprendo algo...).

Edito para añadir que he enviado un mensaje a través de callosenlosdedos.org a uno de los colaboradores del proyecto SF SDL invitandole a participar y a contarnos su experiencia en dicho proyecto. Espero que lo reciba.