Oficina Nacional de Procesos Electorales

Manual Técnico<Nombre del Proyecto>

<Código de Proyecto>Versión <x.x>

Elaborado por: Revisado por: Aprobado por:

Fecha: / / Fecha: / / Fecha: / /

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

HISTORIAL DE REVISIONES

Versión Autor DescripciónFecha de

ElaboraciónRevisado por

Fecha de Revisión

<x.x>

<Nombre de la persona que elabora

el documento>

<Detalles> <dd/mm/aa><Persona(s) que revisa(n) el documento

<dd/mm/aa>

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 2 de 8

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

INDICE

1. INTRODUCCIÓN 4

2. OBJETIVOS Y ALCANCE 4

2.1. Objetivos 4

2.2. Alcance 4

3. ESQUEMA DEL SISTEMA Y SUS MODULOS 4

4. CONFIGURACIÓN DEL SISTEMA 4

4.1. Requerimientos del Sistema 4

5. LISTA DE OPCIONES DEL SISTEMA 5

5.1 Acceso al Sistema 5

5.2. Nombre de Opción de Sistema: Nombre de Página 5

6. DICCIONARIO DE DATOS 6

6.1 Descripción de Tablas 6

6.2 Atributos de Tablas 6

6.2.1 Atributos de la Tabla ”Nombre de Tabla” 6

6.3 Descripción de Procedimientos Almacenados 6

6.3.1 “Nombre del Package” 6

6.4 Descripción de Vistas 6

6.5 Descripción de Triggers 6

7. DEPENDENCIA DE TABLAS 6

7.1 Tablas sin Dependencia 7

7.2 Tablas con Dependencia 7

8. MODELO DE DATOS 7

8.1 Modelo Lógico 7

8.2 Modelo Físico 7

9. STORE PROCEDURES VS TABLAS 7

9.1 Nombre del Package 7

10. VISTAS VS TABLAS 7

11. TRIGERS VS TABLAS 8

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 3 de 8

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

Manual Técnico

1. INTRODUCCIÓN

[Describir de manera resumida el propósito del manual técnico dando especial énfasis en las partes que serán abordadas a lo largo del documento y a qué tipo de usuarios está dirigido.]

2. OBJETIVOS Y ALCANCE

2.1. Objetivos

[Describir el objetivo del Manual Técnico]

2.2. Alcance

[Listar lo que el documento contemplará y lo que no.]

3. ESQUEMA DEL SISTEMA Y SUS MODULOS

[Diagramar, de manera jerárquica, la relación existente entre el sistema y sus módulos. Indicar también las opciones de cada uno de los módulos.]

Nombre de Módulo Nombre de Módulo1. Opción 1.2. Opción 2.3. Opción n

1. Opción 12. Opción 23. Opción n

4. CONFIGURACIÓN DEL SISTEMA

4.1. Requerimientos del Sistema

[Definir los requerimientos mínimos de Hardware y Software que necesitará el sistema para ser instalado y ejecutado. Los requerimientos deben especificarse a nivel de servidor y a nivel de cliente.]

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 4 de 8

Sistema

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

5. LISTA DE OPCIONES DEL SISTEMA

5.1 Acceso al Sistema

[Describir el método de acceso al sistema, colocando las pantallas que se deben visualizar.]

5.2. Nombre de Opción de Sistema: Nombre de Página

[Incluya los formularios, páginas o pantallas utilizadas para la opción que esta describiendo .]

[Formulario/Página/Pantalla : Nombre.]

Nombre de la página: nombre.extensiónDescripción Describir la funcionalidad del formulario,

página o pantalla.Librerías Listar las librerías utilizadas Archivo Configuración Enumerar el (os) archivos de configuración

utilizados afectados por esta funcionalidad.

Procedimientos Almacenados Listar los nombres de los procedimientos almacenados utilizados.

Tablas Listar los nombres de las tablas utilizadasCampos Listar los campos afectados por esta

funcionalidad indicando el valor Páginas Relacionadas Enumerar las páginas relacionadas

Páginas Relacionadas

[Utilice el cuadro anterior para documentar el formulario/página/pantalla relacionado]

Nombre de la página: nombre.extensiónDescripción Describir la funcionalidad del formulario,

página o pantalla.Librerías Listar las librerías utilizadas

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 5 de 8

Imagen del Formulario/Página/Pantalla

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

Archivo Configuración Enumerar el (os) archivos de configuración utilizados afectados por esta funcionalidad.

Procedimientos Almacenados Listar los nombres de los procedimientos almacenados utilizados.

Tablas Listar los nombres de las tablas utilizadasCampos Listar los campos afectados por esta

funcionalidad indicando el valor Páginas Relacionadas Enumerar las páginas relacionadas

6. DICCIONARIO DE DATOS

6.1 Descripción de Tablas

Entidades

Nº Nombre de la Tabla Descripción1 Nombre tabla 1 Descripción tabla 1

6.2 Atributos de Tablas

6.2.1 Atributos de la Tabla ”Nombre de Tabla”

Campo Tipo de Dato Permite Nulo PK FK Descripción Valores Permitidos

6.3 Descripción de Procedimientos Almacenados

6.3.1 “Nombre del Package”

PROCEDIMIENTO ALMACENADO

DESCRIPCIÓN

Procedimiento almacenado 1 Descripción del procedimientoParámetros Nombre de parámetro: Descripción del parámetroValores devueltos Nombre de los campos: Descripción

6.4 Descripción de Vistas

VISTAS DESCRIPCIÓNNombre de la Vista 1 Descripción de la vista

6.5 Descripción de Triggers

TRIGGERS DESCRIPCIÓNNombre del triggers 1 Descripción del triggers

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 6 de 8

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

7. DEPENDENCIA DE TABLAS

[En esta sección debe listar las tablas que tienen dependencias y las que no tienen dependencias]

7.1 Tablas sin Dependencia

N° NOMBRE DE TABLA1 Nombre de la tabla 1

7.2 Tablas con Dependencia

N° NOMBRE DE TABLA NOMBRE DE LA TABLA DEPENDIENTE

1 Nombre de la tabla 1

8. MODELO DE DATOS

8.1 Modelo Lógico

[Incluir el diagrama lógico de datos]

8.2 Modelo Físico

[Incluir el diagrama físico de datos]

9. STORE PROCEDURES VS TABLAS

[En esta sección deberá desarrollar una matriz en la que se visualice las relaciones de Create, Read, Update, Delete; entre los procedimientos almacenados y las tablas]

9.1 Nombre del Package

PROCEDIMENTOS ALMACENADOS VS TABLAS

Tab

la 1

Tab

la 2

Tab

la 3

Tab

la 4

Tab

la n

Procedimiento 1 C U R     LEYENDA

Procedimiento 2       R R C: Inserta Registros.

Procedimiento 3     R: Lee Registros.

Procedimiento 4 U: Actualiza Registros.

Procedimiento n D: Elimina Registros.

10. VISTAS VS TABLAS

[En esta sección deberá desarrollar una matriz en la que se visualice las relaciones de Create, Read, Update, Delete; entre las vistas y las tablas]

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 7 de 8

<Nombre del Proyecto> Versión: <x.x>Manual Técnico Fecha: <dd/mm/aaaa><Nombre de Archivo>

11. TRIGERS VS TABLAS

[En esta sección deberá desarrollar una matriz en la que se visualice las relaciones de Create, Read, Update, Delete; entre los triggers y las tablas]

VISTAS VS TABLAS

Tab

la 1

Tab

la 2

Vista 1 RVista 2 R

LEYENDAC: Inserta Registros.R: Lee Registros.U: Actualiza Registros.D: Elimina Registros.

TRIGERS VS TABLAS

Tab

la 1

Tab

la 2

Trigger 1 CC

CC

CC

LEYENDAC: Inserta Registros.R: Lee Registros.U: Actualiza Registros.D: Elimina Registros.

Confidencial Oficina Nacional de Procesos Electorales

ONPE - 2010Página 8 de 8