modelo de manual técnico

1. Oficina Nacional de Procesos Electorales
Manual Técnico
Sistema de Supervisión de Fondos Partidarios
<Código de Proyecto>
Versión <x.x>
Elaborado por: Revisado por: Aprobado por:
Fecha: / / Fecha: / / Fecha: / /

2. <Nombre del Proyecto> Versión: <x.x>
Manual Técnico Fecha: <dd/mm/aaaa>
<Nombre de Archivo>
HISTORIAL DE REVISIONES
Fecha de Fecha de
Versión Autor Descripción Revisado por
Elaboración Revisión
<Nombre de
la persona <Persona(s)
<x.x> que elabora <Detalles> <dd/mm/aa> que revisa(n) <dd/mm/aa>
el el documento
documento>
© Oficina Nacional de Procesos Electorales
Confidencial Página 2 de 8
ONPE - 2010

3. <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 7
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
© Oficina Nacional de Procesos Electorales
Confidencial Página 3 de 8
ONPE - 2010

4. <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.]
Sistema
Nombre de Módulo Nombre de Módulo
1. Opción 1. 1. Opción 1
2. Opción 2. 2. Opción 2
3. Opción n 3. 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.]
© Oficina Nacional de Procesos Electorales
Confidencial Página 4 de 8
ONPE - 2010

5. <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.]
Imagen del Formulario/Página/Pantalla
Nombre de la página: nombre.extensión
Descripció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 utilizadas
Campos 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ón
Descripción Describir la funcionalidad del formulario,
página o pantalla.
Librerías Listar las librerías utilizadas
© Oficina Nacional de Procesos Electorales
Confidencial Página 5 de 8
ONPE - 2010

6. <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 utilizadas
Campos Listar los campos afectados por esta
funcionalidad indicando el valor
Páginas Relacionadas Enumerar las páginas relacionadas
6. DICCIONARIO DE DATOS
6.1Descripción de Tablas
Entidades
Nº Nombre de la Tabla Descripción
1 Nombre tabla 1 Descripción tabla 1
6.2Atributos 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.3Descripción de Procedimientos Almacenados
6.3.1 “Nombre del Package”
PROCEDIMIENTO
DESCRIPCIÓN
ALMACENADO
Procedimiento almacenado 1 Descripción del procedimiento
Parámetros
Nombre de parámetro: Descripción del
parámetro
Valores devueltos
Nombre de los campos: Descripción
6.4Descripción de Vistas
VISTAS DESCRIPCIÓN
Nombre de la Vista 1 Descripción de la vista
6.5Descripción de Triggers
TRIGGERS DESCRIPCIÓN
Nombre del triggers 1 Descripción del triggers
© Oficina Nacional de Procesos Electorales
Confidencial Página 6 de 8
ONPE - 2010

7. <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.1Tablas sin Dependencia
N° NOMBRE DE TABLA
1 Nombre de la tabla 1
7.2Tablas con Dependencia
N° NOMBRE DE TABLA NOMBRE DE LA TABLA
DEPENDIENTE
1 Nombre de la tabla 1
8. MODELO DE DATOS
8.1Modelo Lógico
[Incluir el diagrama lógico de datos]
8.2Modelo 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.1Nombre del Package
Tabla 1
Tabla 2
Tabla 3
Tabla 4
Tabla n
PROCEDIMENTOS
ALMACENADOS VS TABLAS
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]
© Oficina Nacional de Procesos Electorales
Confidencial Página 7 de 8
ONPE - 2010

8. <Nombre del Proyecto> Versión: <x.x>
Manual Técnico Fecha: <dd/mm/aaaa>
<Nombre de Archivo>
Tabla 1
Tabla 2
VISTAS VS TABLAS
Vista 1 R
Vista 2 R
LEYENDA
C: Inserta Registros.
R: Lee Registros.
U: Actualiza Registros.
D: Elimina Registros.
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]
Tabla 1
Tabla 2
TRIGERS VS TABLAS
Trigger 1 C
C
C
C
C
C
LEYENDA
C: Inserta Registros.
R: Lee Registros.
U: Actualiza Registros.
D: Elimina Registros.
© Oficina Nacional de Procesos Electorales
Confidencial Página 8 de 8
ONPE - 2010