Foros del Web » Programación para mayores de 30 ;) » Programación General »

Estructura para realizar la Documentación Técnica?

Estas en el tema de Estructura para realizar la Documentación Técnica? en el foro de Programación General en Foros del Web. Buenos días amigos de la Comunidad, verán hemos finalizado el desarrollo de un Sistema y ahora necesitamos documentar el código fuente, podrían darme sugerencias sobre ...
  #1 (permalink)  
Antiguo 18/04/2011, 09:17
 
Fecha de Ingreso: junio-2008
Mensajes: 51
Antigüedad: 15 años, 9 meses
Puntos: 0
Estructura para realizar la Documentación Técnica?

Buenos días amigos de la Comunidad, verán hemos finalizado el desarrollo de un Sistema y ahora necesitamos documentar el código fuente, podrían darme sugerencias sobre la estructura a seguir y si existen estandarés para realizarlo, tambien sobre que software es el adeacuado para ello.
El Sistema esta hecho en Vb.NET

De antemano muchas gracias

Saludos
  #2 (permalink)  
Antiguo 26/04/2011, 01:00
 
Fecha de Ingreso: noviembre-2002
Ubicación: DF
Mensajes: 1.056
Antigüedad: 21 años, 4 meses
Puntos: 37
Respuesta: Estructura para realizar la Documentación Técnica?

Procura que tu codigo fuente tenga muchos comentarios que expliquen lo que hace cada seccion, que sean comentarios razonables y que se refieran a la logica de negocio.

Tu manual tecnico debiera contener al menos creo:
- Entidad relacion de las tablas (si maneja base de datos) asi como estructura de las tablas.
- relacion de programas (o clases si es orientado a objetos) y la funcion de cada uno
- diagrama de los modulos
- diagrama de navegacion (sobre todo si es una app para web)
- puedes documentarte sobre UML y ver que diagramas puedan aplicar tambien para tu aplicacion e incorporar esos diagramas en tu documentacion.

Etiquetas: estructura, realizar
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta




La zona horaria es GMT -6. Ahora son las 11:10.