Plantilla Manual Tecnico

Manual Tcnico
Proyecto: [Nombre del proyecto]
MATERIA
Universidad de Guadalajara
Centro Universitario de Ciencias Exactas e
Ingenieras
Departamento de Ciencias Computacionales
[Mes de ao]
LOGO
<Nombre del Proyecto>
Pgina 1 de 8
MANUAL TCNICO
INSTRUCCIONES PARA EL USO DE ESTE FORMATO
1. Este formato es una plantilla para la realizacin de Manuales de Usuario

para Software.
2. La persona que haga uso de esta plantilla podr eliminar o anexar
apartados segn sea su criterio.
3. Las letras de color azul son indicaciones que se aportan para la buena
elaboracin del documento, deben ser eliminadas.
LOGO
MANUAL TCNICO
LOGO
MANUAL TCNICO
Pgina 2 de 8
LOGO
Pgina 3 de 8
MANUAL TCNICO
CONTENIDO
1. Objetivos.................................................................4
1.1 Objetivos Especficos...................................4
2. Alcance...................................................................4
3. Requerimientos Tcnicos.....................................4
3.1 Requerimientos Mnimos de Hardware.......4
3.2 Requerimientos Mnimos de Software........5
4. Herramientas Utilizadas para el Desarrollo........5
5. Instalacin..............................................................5
6. Configuracin........................................................5
7. Diseo de la Arquitectura Fsica..........................5
8. Usuarios..................................................................6
8.1 Usuarios de Base de Datos..........................6
8.2 Usuarios de Sistemas Operativos...............6
8.3 Usuarios de Aplicaciones.............................7
9. Contingencias y Soluciones.................................7
1. Objetivos
LOGO
Pgina 4 de 8
MANUAL TCNICO
En esta seccin, se debe mencionar el objetivo del documento,
con la informacin que presenta.
en relacin
1.1 Objetivos Especficos.

Enlistar claramente los objetivos especficos por los cuales ha sido creado este
documento.
Objetivo 1.
Objetivo 2.
Objetivo 3.
2. Alcance
Este apartado debe detallar cules son los lmites del documento, los usuarios
a quienes est dirigido, y los conocimientos bsicos para comprender los
apartados descritos.
ste documento est dirigido a: __________________
Conocimientos bsicos en: ______________________
3. Requerimientos Tcnicos
Describir y enlistar todos los requerimientos tanto de hardware como de
software necesarios para el buen funcionamiento del programa.
3.1 Requerimientos Mnimos de Hardware.

Procesador:
________________
Memoria RAM (Mnimo): ________________

Disco Duro:
________________
3.2 Requerimientos Mnimos de Software.

Privilegios de Administrador:
Si/No
LOGO
Pgina 5 de 8
MANUAL TCNICO
Sistema Operativo:
________________
4. Herramientas Utilizadas para el Desarrollo.

Enlistar los diversos programas que fueron utilizados para el desarrollo del
software y explicar el motivo para el cual se utilizaron.
Herramienta 1
<Descripcin>
<Motivo por el cual fue utilizado>
Herramienta 2
<Descripcin>
<Motivo por el cual fue utilizado>
5. Instalacin
En este apartado se debe detallar el proceso, paso a paso, de la instalacin,
las recomendaciones y si se considera necesario, agregar capturas de pantalla
para un mejor entendimiento
.
6. Configuracin
Describir las posibles configuraciones que existan, dependiendo si aplica para
el software en cuestin, y describir para que sirve cada una.
Detallar los comandos en los distintos lenguajes que se utilicen y explicar las
situaciones en las que sean requeridos y como deben de ser utilizados.
7. Diseo de la Arquitectura Fsica.

Cada una de las aplicaciones, ya sea en ambientes de desarrollo, pruebas y/o
produccin, debe tener un diagrama detallado con la siguiente informacin:
Nombre de los equipos: ___________________

Ubicacin fsica dentro del centro de cmputo, y en el sitio alterno de
procesamiento: ____________________
Direcciones IP asignadas: ___________________
LOGO
Pgina 6 de 8
MANUAL TCNICO
Puertos TCP/UDP necesarios para comunicacin: __________________
Dependencias con otros sistemas: ____________________
Interrelaciones de conexin entre los equipos.
Realizar diagramas por niveles (si es del caso), integrado al esquema fsico
de seguridad
8. Usuarios
Describir los distintos tipos de usuarios posibles, delimitar su lmite de
privilegios y dems informacin que se crea oportuna.
8.1 Usuarios de base de datos

Se debe incluir un listado de los usuarios de base de datos necesarios para el
aplicativo. Cada usuario debe incluir:
Nombre del usuario: _____________________
<Descripcin/Propsito>
Grupos a los que pertenece: ______________________
Privilegios generales a nivel de base de datos: ___________________
Privilegios sobre objetos de las mismas (tablas, vistas, triggers, etc.):
______
8.2 Usuarios de sistema operativo

Incluir un listado con usuarios del sistema operativo que utiliza la aplicacin,
incluyendo:
Nombre del usuario: indicar el dominio al que pertenece.
Grupos a los que pertenece: ___________________
Privilegios sobre carpetas: ______________________
8.3 Usuarios de aplicaciones
LOGO
Pgina 7 de 8
MANUAL TCNICO
Mencionar todo aquel usuario propietario de la aplicacin, con los siguientes
detalles:
Nombre del usuario: _____________________
Grupos a los que pertenece: _____________________
Privilegios dentro de la aplicacin: __________________________
9. Contingencias y soluciones.
Describir y enlistar las posibles contingencias que puedan ocurrir tanto en la
instalacin como en el uso del software as como la solucin recomendada.

Plantilla Manual Tecnico

Cargado por

Copyright:

Formatos disponibles

Plantilla Manual Tecnico

Cargado por

Información del documento

Descripción original:

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Plantilla Manual Tecnico

Cargado por

Copyright:

Formatos disponibles

Manual Tcnico

Proyecto: [Nombre del proyecto]

<Nombre del Proyecto>

INSTRUCCIONES PARA EL USO DE ESTE FORMATO

1. Este formato es una plantilla para la realizacin de Manuales de Usuario

<Nombre del Proyecto>

<Nombre del Proyecto>

<Nombre del Proyecto>

<Nombre del Proyecto>

1.1 Objetivos Especficos.

3.1 Requerimientos Mnimos de Hardware.

Memoria RAM (Mnimo): ________________

3.2 Requerimientos Mnimos de Software.

<Nombre del Proyecto>

4. Herramientas Utilizadas para el Desarrollo.

7. Diseo de la Arquitectura Fsica.

Nombre de los equipos: ___________________

<Nombre del Proyecto>

8.1 Usuarios de base de datos

8.2 Usuarios de sistema operativo

8.3 Usuarios de aplicaciones

<Nombre del Proyecto>

También podría gustarte