Manual técnico 202

PROPUESTA DE MANUAL TÉCNICO ADSI

(A consideración del instructor técnico con respecto a cada tipo de proyecto)

El manual técnico tiene como finalidad servir tanto a programadores como analistas de
guía para el mantenimiento y crecimiento de la funcionalidad del software.

 El manual debe adoptar las normas APA para la presentación de trabajos

escritos.

 Su forma física puede variar de tamaño carta completa

 Puede presentarse en forma física o digital.

 Contenido mínimo

 Preliminares

 Sugerencias

 Advertencias

 Claves de interpretación si se requiere

 Tabla de contenido

 Introducción

 Objetivos

 Objetivo general

 Objetivos específicos

 Planteamiento del problema

 Problema que resolver

 Justificación

 Elicitación de requisitos, por cualquiera de las técnicas usadas (se

recomienda documento de la IEEE 830.

 Plataforma de desarrollo

 Diagramas UML

 Casos de uso

 Diagrama de clases

 Diagramas de secuencias
Versión 1, elaborado por: Diana Margot López Herrera y María victoria Solís ADSI. Modificado y
1 actualizado por: Angélica Triana
 Manual técnico 202
2
 Diagrama de colaboración o comunicación

 Diagrama de componentes

 Documentación de diagramas

 Modularización de la aplicación

 Modelo Relacional

 Diccionario de datos

 Diseño de la arquitectura (diseño de capas…)

 Diagrama de despliegue

 Diseño del Front-end (toda la interfaz)

 Consideraciones especiales

 Seguridad

 Manejo de errores

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

bibliografía, índice analítico

Versión 1, elaborado por: Diana Margot López Herrera y María victoria Solís ADSI. Modificado y
2 actualizado por: Angélica Triana