Documentación y mantenimiento.

octubre 13, 2007 at 10:36 pm (General)

Documentación

La documentación de un producto software debe servir para enseñar a los usuarios a utilizarlo y ayudar a los programadores a desarrollarlo y mantenerlo y se debe realizar utilizando técnicas estructuradas como diagramas de flujo, algoritmos, diagramas nassi-schneiderman y seudocódigo. Se divide en dos:

Manual de usuario:

Es el que va a decir al usuario la manera de usar el software y qué hacer si se tienen problemas con éste. Debe contar con cuatro secciones:

1. Descripción funcional

- breve descripción de los servicios que proporciona el sistema

2. Instalación

- pasos a seguir para poner el sistema en operación

3. Utilización básica (tutorial)

- cómo comenzar a trabajar con el programa

- funciones más utilizadas y errores comunes

4. Manual de referencia

- descripción detallada de todas las funciones del sistema

- listado de todas las condiciones de error con sus posibles causas y procedimientos de recuperación

Documentación para los programadores:

Servirá a los programadores para el desarrollo y mantenimiento del sistema, por lo tanto debe facilitar la tarea de comprender qué es lo que hace el programa y por qué lo hace, y su buena realización es fundamental a la hora de extender o reparar el programa, ya que todos los programas contienen errores y sufren modificaciones a lo largo de su vida.

Esta documentación se compone de:

• Documentación interna (incluida en el código del programa)

- Comentarios en el código del programa, que expliquen cada elemento del código

- Estructura y estilo del código: facilita su lectura y comprensión (tabulación, separación entre secciones de código, identificadores auto explicativos, etc.).

• Documentación externa (no incluida en el código)

- Especificación: qué hace el programa y cómo lo hace

- Estructura: diagrama de clases, interfaces de las clases

- Descripción de la interfaz con el usuario

- Listado completo y actualizado del programa

- Historial de cambios (en ocasiones se incluye como documentación interna), incluye todo el historial de cambios realizados en el sistema para justificarlos y no realizar los mismos errores, cada cambio debe incluir fecha, razón del cambio, método afectado, y descripción del cambio.

- Formato de los ficheros utilizados para intercambio de información (en el caso de que les haya)

Mantenimiento

El mantenimiento de un producto de software es efectuado rutinariamente a lo largo de su vida para reparar defectos (mantenimiento correctivo), adaptarlo a los cambios en su entorno operativo o extender y/o modificar su funcionalidad.

Mantenimiento correctivo:

Comienza tras la detección de un error y su corrección podría requerir revisar todas las fases del desarrollo de software, pero si el proceso se realizó correctamente, la corrección sólo se realizará en la fase de codificación., Entonces se tendría que pasar al proceso de depuración del código, que consiste en reproducir el error, diagnosticar la causa, corregir el error y verificar la corrección y, una vez que se ha realizado el cambio, actualizar la documentación externa.

About these ads

3 comentarios

  1. maria guadalupe said,

    es importante saber sobre la documentaciòn asi como el mantenimiento para que aprendamos mejor de los programas.

  2. elviratx said,

    Hola, que fue primero, la gallina o el huevo!? lo digo porque no se si este articulo viene de esta direccion o es al reves, o es que ese ppt lo escribio alguien de este blog?

    http://www.ctr.unican.es/asignaturas/programacion2/04_docymant_3en1.pdf

    Un saludo

  3. Jose Silva said,

    MUY BUEN APORTE- ojala podamos Integrarnos con nuestros Blog—–

Deja un comentario

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

Seguir

Recibe cada nueva publicación en tu buzón de correo electrónico.

%d personas les gusta esto: