Delphi - Documentar

 
Vista:

Documentar

Publicado por Laura (35 intervenciones) el 16/12/2003 23:59:40
Necesito documentar mis aplicaciones, ¿alguien recomienda algún procedimiento en especial para documentarlas?
Valora esta pregunta
Me gusta: Está pregunta es útil y esta claraNo me gusta: Está pregunta no esta clara o no es útil
0
Responder

RE:Documentar

Publicado por mamcx (533 intervenciones) el 17/12/2003 01:45:31
Eso depende de que quieres documentar, si codigo, diseño, funcionalidad o varias cosas...

Para documentar codigo (o mas bien, para sacar la documentacion del codigo) puedes usar uno de tantos productos que hacen esto...

Documentar diseño es mas importante. Para ello, usa un modelador UML y aprende UML (el modelador viene con Delphi 7 Profesional y arriba, o se puede conseguir uno gratis...)

Para el resto, como documentar especificaciones e interface, una mezcla de word y/o visio esta bien.

Un prodcuto que recomiendan mucho es Help&Manual

El punto es: que quieres documentar? y asi te doy datos mas especificos :)
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar

RE:Documentar

Publicado por Laura (35 intervenciones) el 17/12/2003 17:02:15
Lo que quiero documentar son las especificaciones e interfase (objetivo del sistema, archivos de entrada/salida, bases de datos que usa, relación con otros sistemas, diagramas de flujo, etc.)
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar

RE:Documentar

Publicado por mamcx (533 intervenciones) el 18/12/2003 22:47:08
Ok:

Para "especificaciones/objetivo del sistema" sirve el word o cualquier editor de texto...

Para las BD, interface(grafica) una herramienta como Visio va bien.

Para la parte compleja, o sea la parte interna del sistema una herramienta como ModelMaker.

Procedimiento:

1-Leete la informacion que hay en http://www.agilealliance.com/home, luego Articles. Tambien http://www.extremeprogramming.org/. Porque? Lo mas tremendo de documentar es que es MUY facil dejar de hacerlo. En estas paginas aprendes tecnicas de ingenieria que ayudan a manejar proyectos y codigos de una mejor manera.

2- Documenta los objetivos principales: Es lo mas facil y MUY importante. Un ejemplo: http://spanish.joelonsoftware.com/Articles/PainlessFunctionalSpecifi-2.html (muy bueno, lee esto primero porque es mas facil de diregir)

3- Lee una introduccion a UML, una buena: http://community.borland.com/article/0,1410,31863,00.html

De todo eso, lo mas practico son los casos de usos y los diagramas de clase.

Por ultimo, documenta solo lo que se necesita, y de ello, aquello que realmente haya compromiso de actualizarse de acuerdo a los cambios. Una documentacion no actualizada es casi peor que ninguna!
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar

RE:Documentar... Gracias

Publicado por laura (35 intervenciones) el 20/12/2003 00:24:24
Gracias por tu ayuda
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar