26/04/2011, 01:00
|
| | | Fecha de Ingreso: noviembre-2002 Ubicación: DF
Mensajes: 1.056
Antigüedad: 22 años 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. |