Sistema de Portal WEB (SPT)

Sistema de Portal WEB (SPT)

Manual Técnico para el Sistema

Descripción y contenido del Manual Técnico

El Manual Técnico del Sistema debe estar estructurado e incluir contendidos conforme al estándar de manual técnico descrito en el presente documento:

Tabla de Contenido

1. Propósito

2. Alcance

3. Documentos de referencia

4. Definiciones importantes

4.1. Conceptos generales

4.2. Procesos de entrada y salida

5. Descripción de módulos

6. Diccionario de datos

6.1. Modelo entidad-relación

6.2. Distribución física y lógica de base de datos

6.3. Tablas y vistas

6.4. Triggers

6.5. Restricciones especiales

6.6. Funciones de usuario, Stored Procedures y paquetes

6.7. Tareas programadas

6.8. Data Transformation Services (Bases de datos SQL Server)

7. Políticas de respaldo

7.1. Archivos

7.2. Base de datos

8. Descripción de interfaces con otros sistemas

9. Instalación y configuración

9.1. Requisitos generales pre-instalación

9.2. Detalles del proceso de instalación

9.3. Detalles de configuración de la aplicación

a. Variables de ambiente

b. Parámetros de aplicaciones

c. Archivos de configuración

d. Archivos de bitácora

e. Tareas programadas

9.4. Lista de contactos técnicos

10. Diseño de la arquitectura física

11. Procesos de continuidad y contingencia

12. Descripción de usuarios

12.1. Usuarios de base de datos

12.2. Usuarios de sistema operativo

12.3. Usuarios de aplicaciones

1.Propósito

En esta sección, se debe mencionar el objetivo del documento, en relación con la información que presenta.

Para todos los casos, este manual debe proporcionar una guía para las principales actividades técnicas del sistema <nombre del sistema> en la Institución.

2. Alcance

Este apartado debe detallar cuáles son los límites del documento, los usuarios a quienes está dirigido, y los conocimientos básicos para comprender los apartados descritos.

El documento debe estar orientado a los clientes internos y externos del área de Tecnología, y debe ser presentado como parte de los criterios de aceptación.

Queda claro que no todas las soluciones pueden incorporar datos en cada uno de los apartados, por lo que su uso depende de la naturaleza del software. Esto será evaluado por el departamento respectivo.

Adicionalmente, se deben presentar los procesos de instalación y configuración, interacción con otros sistemas y/o módulos, descripción de procesos de mantenimiento, descripción del contexto de uso, detalles de implementación y las principales funciones del software

3. Documentos de referencia

Deben indicarse todos los documentos relacionados con la solución, y cuya lectura complemente los conceptos tratados. Por ejemplo:

• Estatuto del Ministerio de Relaciones Exteriores y Culto

• Estatuto del Servicio Civil

• Reglamento al Estatuto del Servicio Civil

• Estatuto del Servicio Exterior

• Reglamento al Estatuto del Servicio Exterior

• Manual de Tareas y Funciones del Ministerio de Relaciones Exteriores y Culto

• Ley contra la corrupción y el enriquecimiento ilícito en la función pública, Ley nº 8422

• Ley general de control interno, Ley No. 8292

• Manual de normas generales de control interno para la Contraloría General de la República y las entidades y órganos sujetos a su fiscalización.

• Criterios de aceptación de Sistemas ( DISP-TI-11-05_ANEXO_012B)

4. Definiciones importantes

4.1 Conceptos generales

Debe ser especificada toda la terminología necesaria para comprender el contexto de la aplicación.

4.2 Procesos de entrada y salida

Deben ser descritos todos los procesos de entrada y salida que el aplicativo requiere para su funcionamiento.

5. Descripción de módulos

Dependiendo de las características del aplicativo, se debe realizar una descripción de sus diferentes módulos. Al menos deberá incluirse la siguiente información:

• Nombre del módulo

• Funcionalidad/Propósito

• Dependencias funcionales

6. Diccionario de datos

6.1 Modelo entidad-relación

Se debe agregar el modelo entidad-relación de la base de datos que forma parte de la solución. Este diagrama debe incluir al menos: nombres de las tablas, sus atributos, y un detalle de las relaciones entre cada una de las tablas.

6.2 Distribución física y lógica de base de datos

Deben mencionarse todos los detalles relacionados con la distribución física de la base de datos, por ejemplo: ubicación de los archivos de datos, archivos de índices y/o archivos de bitácora de transacciones en el sistema de archivos. Se deben indicar los tamaños sugeridos para cada uno de estos, sus características en cuanto a crecimiento proyectado e indicar si este crecimiento es automático o manual. Adicionalmente, la distribución de objetos lógicos por segmentos definidos (tablespaces, datafiles, filegroups, etc.).

6.3 Tablas y vistas

Descripción de cada una de las tablas y vistas que son utilizadas por la aplicación. Dentro de los datos mínimos están:

• Nombre del objeto

• Descripción/Propósito

• Lista de los atributos: incluyendo nombre, tipo de datos, longitud (en caso de ser necesario), permitir datos nulos, y cualquier otra restricción.

• Propietario/Esquema

• En el caso de las vistas, las condiciones utilizadas para crearla.

• Llaves primarias y de referencias a otras tablas

6.4 Triggers

Para este punto debe presentarse:

• Nombre del objeto

• Descripción/Propósito

• Propietario/Esquema

• Código del objeto (cuando no sea confidencial): debe documentarse fecha de creación, modificación, las variables, parámetros, condiciones especiales, etc., utilizadas y propósito de las mismas. Adicionalmente, cualquier comentario que facilite la comprensión del código.

6.5 Restricciones especiales

Cualquier restricción sobre tablas, vistas, campos u otro objeto debe ser mencionada en este apartado.

...