Manual tcnico 201

0
PROPUESTA DE MANUAL TCNICO ADSI
(A consideracin del instructor tcnico con respecto a cada tipo de
proyecto)
El manual tcnico tiene como finalidad servir tanto a programadores
como analistas de gua para el mantenimiento y crecimiento de la
funcionalidad del software.
El manual debe adoptar las normas ICONTEC para la presentacin
de trabajos escritos.
Su forma fsica puede variar de tamao carta completa
Puede presentarse en forma fsica o digital.
Contenido Mnimo
Preliminares

Sugerencias

Advertencias

Claves de interpretacin si se requiere

Tabla de contenido

Resea
histrica de la organizacin Preferible La Misma
Introduccin Del Manual De Usuario Porque Incluye Todo:
Metodologas, Objetivos, Entidad Cliente, Descripcin Del
Aplicativo E Intencin De Este Manual Tcnico.

Elicitacin de requisitos, por cualquiera de las tcnicas

usadas (se recomienda Documento de Visin.

Plataforma de desarrollo

Diagramas UML

Casos de Uso

Diagrama de Clases

Diagramas de secuencias

Otros diagramas

Documentacin de diagramas

1 Elaborado por: Diana Margot Lpez Herrera y Mara victoria

Sols ADSI

Manual tcnico 201

0
o

Modularizacin de la aplicacin

Modelo de Persistencia

Diccionario de datos

Diseo de la arquitectura (diseo de capas)

Diagrama de despliegue (diagrama de sitio)

Diseo del Front-end (toda la interfaz)

Consideraciones especiales

Log de auditoria (si es en carpeta en especial, ruta)

Migraciones

Bakcups

Seguridad

Tipos de mantenimiento que el usuario puede realizarle al

sistema. Ac ira el manejo de los errores graves que puede
presentar el sistema (depurar datos incoherentes, pe. Por virus,
por ingresos no permitidos, peridico por garanta)

En el manejo de la seguridad, incluir la recuperacin de claves

del addor al abrir la base de datos.

Finales: anexos si se requiere, glosario si se requiere, fuentes y

bibliografa, ndice analtico

2 Elaborado por: Diana Margot Lpez Herrera y Mara victoria

Sols ADSI