Documentaci

n de software

"La documentacin de un proyecto de software es una

parte esencial de las actividades que se deben realizar para
el correcto desarrollo, implementacin y mantenimiento
del mismo."
Nosotros pensbamos que no necesitbamos documentar
nada, porque utilizbamos metodologas giles, pero el
sistema fue creciendo y hemos perdido el control (control se
acompaa de se fue un desarrollador y no sabemos como
hizo parte del sistema, o de tenemos parte del desarrollo
externalizado a una empresa y no sabemos que han hecho, por
lo que no podemos prescindir de ellos, o de integramos
nuestro software con el de otra empresa, y no sabemos donde
acaba un producto y empieza el otro, etc.)

Definicin
Son manuales tcnicos , manuales y otras
instrucciones
que
facilitan
el
uso
y
el
funcionamiento de un producto o servicios de
software constituyen la documentacin del
software . Esta documentacin puede incluir en su
caso, el cdigo fuente, los cdigos de error y sus
significados. La documentacin del software puede
existir tambin en formato electrnico, en formato
PDF , como un CD o un libro.

Documentacin en
cada fase

Tipos de
documentacin
Documentacin del usuario
La documentacin para el usuario constituye un elemento de
consulta para toda aquella persona que va a usar el programa
por primera vez o que trata de saber si el programa servir a
sus objetivos. Igualmente es til para usuarios que ya realizan
un manejo bsico y quieren profundizar hacia un conocimiento
avanzado. Una documentacin completa contendra:

 Portada con el nombre del programa, versin y autor o autores.

ndice.
Descripcin muy breve de las funciones y posibilidades del programa.
Descripcin breve del mtodo de clculo principal.
Explicacin breve de cmo debe usarse el programa y de los datos de entrada,
opciones y resultados.
Ejemplos paso a paso de uso del programa en nmero suficiente para
comprender las posibilidades que se brindan.
Diagrama de flujo del programa de carcter sinttico y descriptivo.
Especificacin detallada de todas las opciones contenidas en mens.
Especificacin detallada de todos los clculos, principales y secundarios.

Tipos de
documentacin
Documentacin para el mantenimiento
La documentacin para mantenimiento constituye el elemento
de referencia para el programador que haya de realizar cambios
o ampliaciones del programa en el futuro. La necesidad de
mantenimiento deriva de:
Defectos del programa no detectados y que es necesario
corregir.
Cambios externos de ndole poltica, tcnica, social, etc. que
afectan al programa: normativa, moneda, novedades de un
sistema operativo, etc.
Solicitudes de los clientes o usuarios.

El mantenimiento de un programa
puede darse en:
- Diseo bsico
- Funciones importantes pero
desligadas del ncleo del
programa
- Cuestiones meramente
estticas.
El mantenimiento debe
considerarse como programacin
en todos sus sentidos y es ideal
un mantenimiento que respete la
filosofa y el estilo del programa
que se mantiene, de modo que un
auditor no pudiera detectar qu
parte del programa corresponde
al cdigo original y qu parte a la
ampliacin o correccin.

Una documentacin de mantenimiento completa puede contener:

Portada, nmero de versin, autor.

ndice.
Objeto y aspectos principales del programa.
Diagrama de flujo modular.
Diagrama de flujo para cada mdulo, desarrollado y con enfoque a las
variables y procesos internos.
Cdigo completo del programa.
Explicacin de la gestin de errores del programa.
Esquema o ndice descendente del programa, actualizado.
Explicacin de variables, datos, archivos.
Recomendaciones para el mantenimiento futuro.
Cualquier informacin que se considere relevante para un programador
que haya de trabajar con el programa.

Las 5 claves para una

documentacin exitosa!

* Tomado de The keys to succesful software documentation, BlueMango Learning

systems

Comienza con el final

en mente!
Pensando como los
usuarios utilizaran
tu documentacin
antes de empezar a
escribir te dar una
mejor visin y
podrs estructurar
con mayor agilidad
tu contenido

Crea en pedazos
pequeos!
Cuando utilizas
este enfoque, el
nmero de
artculos de
ayuda crecer
mientras que el
tiempo para
crearlos
disminuir. sea
que crearas ms
contenido en

Muestra, no digas!

- Claridad
- Brevedad
- Velocidad

documentacin con
velcro y no con
cemento!

Usa procesos, no
proyectos
- Tiempo de
planeacin ms
corto
- Desarrollo rpido
- Actualizaciones
incrementales

Actividades
propuestas
1.Que
se
conoce
como
ingeniera del Software?
2. Investiga el estndar IEEE
1063 -2001

Actividades
propuestas
3. Investiga sobre calidad del software y en parejas
desarrolla lo siguiente:
-

Usted ha sido designado para negociar la venta y desarrollo

de una nueva aplicacin (crea un nombre para la nueva
aplicacin)para un cliente o empresa X, y se ha establecido
como estrategia, evidenciar el enfoque que usted y su
equipo tienen hacia la calidad del producto
Prepare una presentacin con orientacin al cliente donde
explique con claridad las ventajas que representan realizar
un desarrollo de software con enfoque hacia la calidad del
producto. Explique de los modelos existentes cual utilizar y
porque?
NOTA: agregue en su presentacin un anexo donde explique la
diferencia en el enfoque hacia al producto y hacia el proceso