MANUAL TECNICO EN EL

DESARROLLO DE SOFTWARE
Contenido
1. Introduccin ............................................................................................... 2
2. Confeccin ................................................................................................. 2
2.2 Versin del Sistema: .............................................................................. 2
2.3 Tipo de Manual: ..................................................................................... 2
2.4 Poner una Imagen: ................................................................................ 2
2.5 Fecha de Elaboracin: ........................................................................... 2
2.6 rea donde fue elaborado: ................................................................... 3
2.7 ndice del Contenido del Manual: ......................................................... 3
2.7.1. Introduccin ................................................................................... 3
2.7.2. Objetivos Generales y Especficos del Sistema ............................ 3
2.7.3. Normas, Polticas y Procedimientos ............................................... 3
2.7.4. Definicin de las Reglas del Negocio Implementadas .................... 3
2.7.5. Fundamentacin de la Tecnologa Utilizada ................................... 3
2.7.6. Descripcin de los Actores del Sistema ......................................... 4
2.7.7. Especificacin de Requisitos .......................................................... 4
2.7.8. Vista Funcional ............................................................................... 5
2.7.9 Vista Lgica ..................................................................................... 6
2.7.10. Modelo Lgico de Datos ............................................................... 8
2.7.11. Modelo Fsico de Datos ................................................................ 8
2.7.12. Descripcin Detallada de los Algoritmos ..................................... 9
2.7.13. Diseo de Pantallas y Reportes ..................................................... 9
2.7.14. Descripcin de Campos Requeridos por Pantalla Incluir
imgenes de las pantallas. ....................................................................... 9
2.7.15. Vista de Implementacin .............................................................. 9
2.7.16. Vista de Despliegue ..................................................................... 9
2.7.17. Diagrama de Navegacin del Sistema ........................................ 10
2.7.18. Controles de Auditora Implementados en el Sistema ................ 10
2.7.19. Glosario de Trminos ................................................................. 10
3. Estndares de Elaboracin del Manual .................................................... 11
1. Introduccin
El Manual Tcnico, como su nombre lo indica, contiene las especificaciones
tcnicas ms importantes del sistema desarrollado. Constituye una gua
especializada para la realizacin de las operaciones de mantenimiento de la
aplicacin. Se encuentra dirigido fundamentalmente a la direccin de
Tecnologas de la Informacin, al administrador del sistema, a otros
desarrolladores, as como al departamento de calidad y auditora de sistemas.

2. Confeccin
Para la elaboracin de un manual de tcnico se deben de considerar los
siguientes apartados normativos.
Nota: Los acpites que aparecen en color rojo y con descripcin en letra
cursiva son de carcter opcional.

2.2 Versin del Sistema:

La versin del sistema en el manual nos permitir mantener un control sobre
las modificaciones que han afectado al sistema original.

2.3 Tipo de Manual:

Se especifica el tipo de manual al que se hace referencia, permitiendo tener
un control en nuestros manuales, adems de una fcil identificacin.

2.4 Poner una Imagen:

Es recomendable ilustrar el manual con una imagen representativa del
sistema.

2.5 Fecha de Elaboracin:

Resulta importante el incluir la fecha de elaboracin, pues representa un
punto de referencia y control.
2.6 rea donde fue elaborado:
Incluir el nombre del rea en donde fue elaborado el manual.

2.7 ndice del Contenido del Manual:

Deber contar con un ndice y/o contenido del manual para facilitar su manejo
e identificacin de los puntos importantes, pues si slo se busca un punto en
especfico con el ndice es fcil identificarlo.

2.7.1. Introduccin
Breve descripcin del sistema desarrollado, que contemple el mbito
abarcado, cul es su funcin principal y un detalle de las funciones macros o
partes que lo componen. Adems se debe incluir una pequea descripcin
del negocio en el cual se enmarca la aplicacin.

2.7.2. Objetivos Generales y Especficos del Sistema

Breve descripcin de los objetivos generales y especficos que se cumplieron
con el desarrollo del sistema.

2.7.3. Normas, Polticas y Procedimientos

Explicacin de las normas, polticas y procedimientos de la organizacin en
las que se basa el sistema para su implementacin.

Ejemplo:
El Sistema de Gestin de Recursos Humanos (GREHU) se basa en normas
como la NC 3002: 2007. Sistema de Gestin Integrada de Capital
HumanoImplementacin. El desarrollo del mismo sigue la estrategia
establecida por la industria de software cubana de realizar aplicaciones
informticas haciendo uso de las tecnologas de software libre.

2.7.4. Definicin de las Reglas del Negocio Implementadas

Definir los lineamientos que se contemplaron durante el desarrollo de la
aplicacin. Descripcin detallada de las reglas de negocio que debe seguir
el sistema para garantizar las restricciones que existen en el negocio.

2.7.5. Fundamentacin de la Tecnologa Utilizada

Realizar una breve descripcin, con sus correspondientes referencias
bibliogrficas, acerca de las tendencias y tecnologas actuales sobre las que
se apoya la propuesta, adems de incluir la justificacin de las seleccionadas
para el desarrollo de la aplicacin.

2.7.6. Descripcin de los Actores del Sistema

Tabla1.Definicin Resumida de los Actores del Sistema

2.7.7. Especificacin de Requisitos

I. Descripcin de los Requisitos Funcionales.
Funcionalidades que el sistema debe poseer.
II. Descripcin de los Requisitos No Funcionales.

Propiedades o cualidades que el producto debe tener para un mejor

rendimiento de la aplicacin y satisfaccin del usuario. Son las caractersticas
que hacen al sistema atractivo, usable, rpido y confiable.
Ejemplos:
- Apariencia o interfaz externa.
- Usabilidad.
- Rendimiento.
- Soporte.
- Portabilidad.
- Seguridad.
Si es proporcionada por un sistema externo se debe realizar una revisin
bibliogrfica del tema y la justificacin de su seleccin. Adems se ha de
especificar para el sistema la propuesta de: controles de seguridad,
privacidad y administrativos, seguridad fsica y requerimientos funcionales
que genera. En caso de que la empresa objeto de estudio cuente con polticas
de seguridad bien establecidas y/o sistemas informticos de seguridad,
especificar cmo encaja en ellos el sistema propuesto.
- Requisitos de implementacin.
- Requisitos de interface con otros sistemas.
- Requisitos de software y hardware.
- Restricciones en el Diseo y la Implementacin.
- Legales.
- Confiabilidad.
- Ayuda y documentacin en lnea.

2.7.8. Vista Funcional

Diagrama de los casos de uso del sistema estructurado que comprometen la
arquitectura, incluyendo los de mayor importancia para el usuario. Identificar
relaciones de inclusin, extensin o generalizacin entre los casos de uso en
caso de existir, as como, generalizacin entre actores si est presente.

Tabla2. Descripcin de Bajo Nivel de los Casos de Uso

Nombre del caso de uso Nombre descriptivo de la

funcionalidad que se realiza a travs
del caso de uso.
Actores Nombre de los actores, indicando
cul inicia el caso de uso.
Resumen Descripcin del flujo de trabajo. Se
debe indicar:
- Cmo se inicia el proceso?
-Qu ocurre internamente?
-Cmo intervienen los actores en el
proceso?
-Cmo termina el proceso?
En la descripcin han de quedar
especificadas las excepciones que
se tienen en cuenta y la relacin con
otros casos de uso, si corresponde.
 Precondiciones Estado inicial. Condiciones que
deben ser ciertas antes de
ejecutarse el caso de uso. Se refiere
adems al estado de la informacin
almacenada.
Poscondiciones Estado final. Condiciones que se
generan una vez ejecutado el CU. Se
refiere al estado en que queda la
informacin despus de ejecutarse
el proceso.
Requisitos especiales Especificar si para el proceso que
describe el caso de uso, resulta
necesario tener en cuenta
restricciones asociadas a la
seguridad, velocidad,
disponibilidad, exactitud, tiempo de
respuesta o utilizacin de memoria,
precisando de qu manera lo afecta.

2.7.9 Vista Lgica

* Estilo Arquitectnico: Define la estructuracin en capas de la aplicacin.
* Patrones de Diseo
Un patrn de diseo es un conjunto de reglas que describen como afrontar
tareas y solucionar problemas que surgen durante el desarrollo del software.
Existen varias clasificaciones de los patrones, una de ellas es segn su
finalidad, dentro de la cual se consideran 3 conjuntos fundamentales:
Patrones de Creacin
Estos patrones crean objetos, evitando dicha funcin y la instanciacin directa
por parte de los desarrolladores. Ello proporciona a nuestros programas una
mayor flexibilidad para decidir que objetos usar. Dentro de este grupo los
ms conocidos son: Factory, Abstract Factory, Builder, Prototype y Singlenton.
Patrones Estructurales
Guan el desarrollo de la aplicacin bajo una determinada estructura. Entre
ellos se encuentran: Adapter, Bridge, Composite, Decorator, Facade,
Flayweight y Proxy.

Estructura del Patrn Adapter

Estructura del Patrn Decorator

Patrones de Comportamiento
Enfocados principalmente en algoritmos y en la
asignacin de responsabilidades entre los objetos. Describen el
comportamiento de objetos, clases y la comunicacin entre ellos.
Se clasifican
A nivel de clases: Usan la herencia como va para distribuir el
comportamiento. El Interpreter y el Template Method constituyen
ejemplos de este tipo de patrn.
A nivel de objetos: Usan la composicin, ms que la herencia para
llevar a cabo las tareas. Muestra de ellos son el Command, Iterator,
Chain of Responsibility, Strategy y el State.

Patrones de Diseo Detallados
Mencionar los patrones de diseo que se utilizan, especificando para cada
patrn:
a) Breve descripcin del patrn.
b) Dnde y por qu lo usan?
c) Diagrama de clases que muestre cmo se implementa el patrn en la
propuesta realizada del sistema.

* Mecanismos de Diseo
Son el resultado del refinamiento realizado sobre los mecanismos del
anlisis. Cabe destacar que dicho proceso se basa en las restricciones
impuestas por el ambiente de implementacin.
Ejemplos:
Mecanismo de Seguridad.
Mecanismo de Acceso a Datos.

Mecanismos de Diseo Detallados

a) Enunciar todos los mecanismos identificados y describirlos
brevemente.
b) Documentar los mecanismos identificados ms importantes. I. Vista
Esttica (Diagrama de clases).
II. Descripcin de cada elemento mostrado en la Vista Esttica.
III. Colaboraciones Genricas con Diagramas de Secuencia o de
Colaboracin.

2.7.10. Modelo Lgico de Datos

Incluir el Diagrama de Clases Persistentes asociado a la vista de la
arquitectura de la aplicacin. Dicho diagrama contiene las entidades del
sistema, sus atributos, as como las relaciones que se establecen entre ellas.
Se puede mostrar por paquetes o casos de uso para ganar claridad en la
presentacin.

2.7.11. Modelo Fsico de Datos

Empleado para describir la estructura de la informacin persistente
manipulada por el sistema. Se debe incluir su respectivo diccionario de datos.
2.7.12. Descripcin Detallada de los Algoritmos
Se deben explicar de manera exhaustiva en lenguaje natural los algoritmos
y diagramas de flujo ms importantes y complejos.

2.7.13. Diseo de Pantallas y Reportes

Breve descripcin de las consideraciones asociadas al diseo de las pantallas
y reportes de la aplicacin.

2.7.14. Descripcin de Campos Requeridos por Pantalla Incluir imgenes

de las pantallas.

2.7.15. Vista de Implementacin

Compuesta fundamentalmente por un diagrama que muestra las principales
piezas desde el punto de vista fsico (subsistemas de implementacin) que
conforman el sistema. Dicho diagrama representa la estructuracin fsica del
cdigo, los distintos directorios que organizan el cdigo fuente, libreras,
ficheros ejecutables (si existen), entre otros elementos. Se deben describir
los componentes mostrados en el diagrama, incluyendo su propsito y
contenido. Adems han de considerarse como parte de la vista las
dependencias con aplicaciones o componentes externos.

2.7.16. Vista de Despliegue

Abarca la representacin grfica del Diagrama de Despliegue. Se debe
explicar la estructura de los nodos que se presentan e indicar la
correspondencia de los mismos con la estructuracin en capas implementada.

Figura1. Ejemplo de Diagrama de Despliegue

2.7.17. Diagrama de Navegacin del Sistema
Muestra grficamente la interconexin entre cada una de las pantallas del
sistema, constituyendo de esta forma los diferentes caminos para llegar a
determinada parte de la aplicacin. Se deben mostrar los mens, submens
y pantallas a las que nos llevan cada uno de ellos.

2.7.18. Controles de Auditora Implementados en el Sistema

Adjuntar la documentacin vinculada a los controles de auditora
implementados en el sistema.

2.7.19. Glosario de Trminos

En l se definen los conceptos y trminos importantes para la comprensin
del problema, as como de todos los procesos descritos anteriormente.
3. Estndares de Elaboracin del Manual
Toda la documentacin que se relacione con un sistema, ya sea impresa o
digital, sencilla o compleja, debe reunir los siguientes requisitos bsicos:
Debe ser rotulada con claridad y bien organizada en carpetas e ndice,
con secciones claramente indicadas.
Los diagramas debern ser claros, no aglomerados y la escritura
manuscrita ha de ser legible.
La documentacin deber ser completa.
Se incluir una leyenda o explicacin de los trminos utilizados.
La documentacin siempre se conserva actualizada.

El estilo de redaccin de los manuales de documentacin debe:

Ser concreto.
Definir los trminos utilizados.
Utilizar ttulos, subttulos y prrafos cortos.
Emplear formas activas en lugar de pasivas.
Aplicar correctamente las referencias bibliogrficas.
No usar frases largas que presenten hechos distintos.