Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Que Es Un Manual Tecnico Cual Es Su Estructura Ejemplos PDF
Que Es Un Manual Tecnico Cual Es Su Estructura Ejemplos PDF
Debe contener:
Que es lo que intentamos solucionar con la aplicación del sistema, y que es lo que en
realidad solucionamos, ya que existen ocasiones en las que no se logran o por completo
solucionar todo lo que aviamos requerido.
Se muestran las tablas de las bases de datos, con la descripción de cada uno de sus
campos, además del diagrama de relación entre tablas.
Esta parte consiste únicamente en detallar de la mejor manera posible como es que están
diseñados los reportes y pantallas, que partes constituyen, etc.
MANUAL
TÉCNICO
EJEMPLO 1
• Objetivos
• Alcances
• Manual de normas
• Base de Datos
• Diseño y Reporte de Pantallas
“REGISTRO DE ENTRADAS Y SALIDAS EXTRACLASE”
INTEGRANTES
MANUAL DE TECNICO
TIC0SM08
INDICE
INDICE ------------------------------------------------------------------------------------------------------ 2
INTRODUCCION ------------------------------------------------------------------------------------------ 3
OBJETIVO -------------------------------------------------------------------------------------------------- 4
Página 2
INTRODUCCIÓN
La Universidad Tecnológica de San Juan del Rio ofrece sus laboratorios de informática en horas
extraclase para que su alumnado pueda utilizar los equipos de cómputo que se encuentran dentro de
los mismos con el fin de que los alumnos puedan realizar sus tareas o bien para que puedan realizar
sus tareas, proyectos o trabajos con el objetivo de que los entreguen a tiempo o bien se apoyen en su
economía al utilizar los equipos que estén disponibles en los laboratorios.
Por ello nos dimos a la tarea de realizar un sistema que en particular para el laboratorio J2 Planta Alta
del Edificio J el cual registre el alumno, la hora de entrada y salida, fecha así como otros detalles que
le proporcionen un registro claro de los alumnos que utilicen el equipo disponible en el mismo.
Página 3
OBJETIVO
El objetivo del presente manual es mostrar los datos técnicos en cuanto al sistema desarrollado, en si
para facilitar la modificación o actualizaciones de el mismo en caso de que así sea necesario, o bien
para el mantenimiento posterior del mismo con el fin de que analistas, programadores puedan leerlo
e interpretarlo para los objetivos anteriormente descritos.
Este manual se encuentra las secciones de estructura de Base de Datos, codificación del sistema
donde se describirán los aspectos en los que se conforma cada uno de ellos. A continuación vera una
breve descripción del sistema, los objetivos y las prestaciones que le ofrece el sistema.
Objetivo General: Este sistema está enfocado a mejorar el servicio uso de las Computadoras del
laboratorio J2 Planta Alta ubicado en el edificio J dentro de la Universidad Tecnológica de San Juan del
Río ya que este laboratorio es ocupado en las horas libres por los alumnos de la carrera de
Tecnologías de la Información y Comunicación, Área Sistemas Informáticos para realizar sus tareas o
trabajos los cuales tengan que ver con el uso de un equipo de computo, y se pretende registrar las
entradas y salidas de cada alumno que necesite ingresar a este laboratorio, con el fin de registrar
quien, a qué hora utiliza el equipo así como la hora de que desocupa el equipo asignado a el alumno
que lo solicite con el fin de reportar anomalías en los equipos y mejorar el control y el buen uso del
mismo.
Página 4
MODELO UTILIZADO PARA EL DESARROLLO DEL SISTEMA
MODELO ESPIRAL
Elegimos este modelo porque nos permite regresar al punto donde se encuentra el error.
Este modelo fue propuesto por Boehm en 1988. Básicamente consiste en una serie de ciclos que se
repiten en forma de espiral, comenzando desde el centro. Se suele interpretar como que dentro de
cada ciclo de la espiral se sigue un Modelo Cascada, pero no necesariamente debe ser así. El Espiral
puede verse como un modelo evolutivo que conjuga la naturaleza iterativa del modelo MCP con los
aspectos controlados y sistemáticos del Modelo Cascada, con el agregado de gestión de riegos.
Tareas
Página 5
Análisis del riesgo
Se estudian todos los riesgos potenciales y se seleccionan una o varias alternativas propuestas
para reducir o eliminar los riesgos.
Planificar
Revisamos todo lo hecho, evaluándolo, y con ello decidimos si continuamos con las fases
siguientes y planificamos la próxima actividad.
Página 6
DISEÑO DE LAS BASES DE DATOS
Para un funcionamiento eficiente se diseñaron las Bases de Datos que conforman el sistema con la
aplicación MySQL debido a que esta aplicación nos permite un diseño amplio y concreto de las tablas
y los campos que contiene la Base de Datos. La implementación de restricciones de seguridad y llaves
foráneas entre otras cosas que incluye.
En primera instancia se muestran las tablas que conforman la Base de Datos.
TABLA ALUMNOS
Nombre del Campo Tipo de Dato
Numero_Expediente VarChar(15)
Nombre_Alumno VarChar(45)
Clave_Carrera Char(6)
Grupo Char(15)
TABLA APLICACIONES
Nombre del Campo Tipo de Dato
Clave_Aplicación Char(15)
Nombre_Aplicacion VarChar(45)
Descripción VarChar(1000)
TABLA CARRERAS
Nombre del Campo Tipo de Dato
Clave_Carrera Char(6)
Nombre_Carrera VarChar(45)
TABLA EQUIPOS
Nombre del Campo Tipo de Dato
No_Equipo Int(10)
Descripcion VarChar(45)
Clave_Status Char(2)
Página 7
TABLA PRESTACIONES
Nombre del Campo Tipo de Dato
Clave_Prestacion Char(2)
Hora_Entrada Char(15)
Fecha Date
Numero_Expediente Char(15)
No_Equipo Integer(10)
Nombre_Aplicacion VarChar(45)
Observacion_Equipo VarChar(45)
Observacion_Aplicacion VarChar(45)
Hora_Salida Char(15)
TABLA STATUS
Nombre del Campo Tipo de Dato
Clave_Status Char(2)
Descripción VarChar(1000)
Página 8
DIAGRAMA ENTIDAD RELACION
ALUMNOS 1 APLICACIONES 1
1 No_Expediente Clave_Aplicación
Nombre_Alumno Nombre_Aplicacion
Clave_Carrera Descripción
Grupo
N
EQUIPOS
PRESTAMOS
No_Equipo Clave_Prestamo
N
Tipo_Computadora N
Hora_Entrada
Clave_Status Fecha
No_Expediente
No_Equipo
Clave_Aplicación
Observacion_Equipo
Observacion_Aplicacion
Hora_Salida
N
CARRERAS 1
Clave_Carrera STATUS
Nombre Clave_Status
Descripción
Página 9
CODIFICACION DE LAS PANTALLAS
El diseño de las pantallas se llevo a cabo con la aplicación Microsoft Visual Studio 2005 al igual que la
codificación de las mismas la cual se muestra en la siguiente sección:
APLICACIÓN DEL PROYECTO
Se utilizara el Visual Studio 2005 para la ejecución de dicho proyecto de Entradas y Salidas Extraclase.
CODIFICACIÓN
Imports System.Data
Imports System.Data.OleDb
End Sub
End Class
Página
10
PANTALLA DE MENU
End Sub
CODIGO DEL BOTON PRESTAMO
End Sub
Página
11
CODIGO DEL BOTON EQUIPOS
Imports MySql.Data.MySqlClient
Página
12
CODIGO DEL BOTON ELIMINAR
End Sub
CODIGO DEL BOTON GUARDAR
Página
13
MessageBox.Show("Hubo un problema agregando el usuario", "Agregar",
MessageBoxButtons.OK, MessageBoxIcon.Error)
End If
conexion.Close()
Catch MiError As Exception
MsgBox("Ocurrio un error al intentar agregar el usuario. Verifique por
favor..." & MiError.Message)
Finally
conexion.Dispose()
End Try
End Sub
'conexion.ConnectionString = "server=localhost;user
id=root;password=utsjr;database=analisis_proyecto"
'Try
' conexion.Open()
' comando.Connection = conexion
' comando.CommandText = "SELECT No_Expediente,Nombre_Alumno FROM alumnos
where No_Expediente=" + txtexpediente.Text
' lector = comando.ExecuteReader
' While lector.Read
' respuesta.Add(lector("No_Expediente"))
' respuesta.Add(lector("Nombre"))
' End While
' If respuesta.Count > 0 Then
' txtexpediente.Text = respuesta(0).ToString
' txtnombre.Text = respuesta(1).ToString
' Else
' MsgBox("El usuario a consultar no existe.") '
End If
' lector.Close()
' conexion.Close()
'Catch MiError As MySqlException
' MsgBox("Ocurrio un error. Verifique su codigo: " & MiError.Message)
'Finally
' conexion.Dispose()
'End Try
'txtexpediente.Text = ""
'txtnombre.Text = ""
'txtcarrera.Text = ""
'txtgrupo.Text = ""
'End Sub
Página
14
CODIGO DEL BOTON MENU
End Sub
CODIGO DEL BOTON NUEVO
End Sub
End Class
PANTALLA DE EQUIPOS
Página
15
Imports MySql.Data.MySqlClient
Public Class Form4
Dim conexion As MySqlConnection
Dim comando As MySqlCommand
Dim lector As MySqlDataReader
Dim lector As MySqlDataReader
End Sub
CODIGO DEL BOTON GUARDAR
End Sub
Página
16
CODIGO DEL BOTON NUEVO
End Sub
CODIGO DEL BOTON ELIMINAR
End Try
End Sub
End Class
Página
17
PANTALLA APLICACIONES
BOTON ELIMINAR
Private Sub cmdeliminar_Click(ByVal sender As System.Object, ByVal e As
System.EventArgs) Handles cmdeliminar.Click
End Sub
Página
18
BOTON GUARDAR
conexion.ConnectionString = "server=localhost;user
id=root;password=utsjr;database=analisis_proyecto"
Try
Página
19
conexion.Open()
comando.Connection = conexion
comando.CommandText="SELECT
Clave_Aplicacion,Nombre_Aplicacion,Descripcion FROM aplicaciones where
Clave_Aplicacion='" + txtclaveapli.Text + "'"
lector = comando.ExecuteReader
While lector.Read
respuesta.Add(lector("Clave_Aplicacion"))
respuesta.Add(lector("Nombre_Aplicacion"))
respuesta.Add(lector("Descripcion"))
End While
If respuesta.Count > 0 Then
txtclaveapli.Text = respuesta(0).ToString
txtnombre.Text = respuesta(1).ToString
txtdescripcion.Text = respuesta(2).ToString
Else
MsgBox("La Aplicacion a consultar no existe.")
End If
lector.Close()
conexion.Close()
Catch MiError As MySqlException
MsgBox("Ocurrio un error. Verifique su codigo: " & MiError.Message)
Finally
conexion.Dispose()
End Try
End Sub
End Class
End Sub
Página
20
PANTALLA PRESTAMOS
Imports MySql.Data.MySqlClient
Public Class Form6
Dim conexion As MySqlConnection
Dim comando As MySqlCommand
Dim lector As MySqlDataReader
End Sub
Página
21
comando = New MySqlCommand(comando.CommandText, conexion)
conexion.Open()
resultado = comando.ExecuteNonQuery()
If resultado >= 1 Then
MessageBox.Show("El alumno se agregado con exito", "Registro de
Entrada", MessageBoxButtons.OK, MessageBoxIcon.Information)
Else
MessageBox.Show("Hubo un problema guardando el usuario", "Agregar",
MessageBoxButtons.OK, MessageBoxIcon.Error)
End If
conexion.Close()
Catch MiError As Exception
MsgBox("Ocurrio un error al intentar guardar el usuario. Verifique por
favor..." & MiError.Message)
Finally
conexion.Dispose()
End Try
End Sub
CODIGO DEL BOTON MENÚ
End Sub
End Class
Página
22
AL USUARIO FINAL
En este manual técnico se describen los componentes básicos, todo esto con el objetivo
de que se pueda leer, interpretar y analizar las partes de que se conforma el sistema
desarrollado a fin de que se le desee realizar modificaciones futuras o bien
actualizaciones para mejorar su eficiencia y de ser posible sea base para algunos
sistemas futuros a desarrollarse que sean afines a este.
Diseño de la
Base de
Datos. Tipos
de Datos
utilizados.
Vista de las Pantallas
Codificación de los botones de las pantallas.
Modelo implementado a seguir para la realización del sistema
Con este documento se espera que sea claro, fácil de entender para los programadores,
diseñadores, analistas de software que en si deseen, realizar alguna de las acciones
descritas anteriormente al sistema.
Página
23
MANUAL
TÉCNICO
EJEMPLO 2
• Objetivos
• Alcances
• Manual de normas
• Base de Datos
• Diseño y Reporte de Pantallas
Página
24
MyMSystem
Versión 2010
MANUAL TÉCNICO
Elaborado por:
1. Historia. 3
2. Introducción. 4
3. ERS. 5
5. Diccionario de datos 17
6. Diagrama relacional. 19
9. Anexos 24
Página
26
Historia
Historia.
Introducc
ión.
ERS (especificación de requerimientos del
software). Diagrama general (Entidad-
Relación, Diagrama de Contexto). Diccionario
de datos.
Diagrama relacional.
Definición de variables de
ambiente y librerías. Flujo grama
de información proceso actividad.
Anexos.
Página
27
Introducción
Página
28
Especificación de requisitos
de software
Proyecto: MyMSystem
Revisión 2.0
octubre
Página
29
Historial de Revisiones
Fdo. D./ Dña. Ing. Ricardo de Jesús Fdo. D./Dña. Ilian Patricia Bocanegra Alfaro
Bustamante González
Página
30
1 Introducción
El presente documento presentará de forma organizada los requisitos
que son indispensables para desarrollar un sistema de información
que le ayude a conseguir un mejor control de las finanzas, en cuanto
a la miscelánea se refiere. Este documento está estructurado en base
al estándar IEEE Recommended Practice for Software Requirements
Specification ANSI/IEEE 830 1998.
1.1 Propósito
El propósito general de este documento es darle a conocer al
usuario la forma correcta de trabajar en el sistema MyMSystem. Te
mostramos como se ha desarrollado cada una de las áreas
importantes en el desarrollo de nuestro sistema.
1.2 Alcance
Por el momento este sistema de información se implementará en la
miscelánea MyM. Sin embargo, con pequeñas
modificaciones, pudiera implementarse en más
misceláneas, puesto que el funcionamiento es muy similar en todas
ellas.
Página
32
Rol Diseñador
Categoría profesional Licenciado en Informática
Responsabilidades Diseñar el logotipo del sistema.
Diseñar las interfaces según los requerimientos del sistema. Elegir
estilos, colores y formas para conseguir una óptima
esteticidad de las interfaces.
Información de contacto Mzm_06@hotmail.com
Aprobación Ilian Patricia Bocanegra Alfaro
SW: Software
1.5 Referencias
Referencia Titulo Ruta Fecha Autor
NA NA NA NA NA
1.6 Resumen
En las siguientes secciones se encontrará la descripción del
producto, así como la descripción de lo que es necesario para que
tenga un correcto funcionamiento.
Página
2 Descripción general 33
Página
34
MyMSystem es un sistema que maneja altas, bajas y cambios referentes
a una miscelánea, es decir, referentes a productos, clientes propios
del negocio, los cuales, junto con una serie de usuarios y
contraseñas válidos, se almacenarán en una base de datos.
Logotipo
Colores:
Página
36
2.3 Características de los usuarios
Tipo de usuario Administrador
Formación Técnico en informática
Habilidades Habilidades básicas de manejo de una PC.
Actividades Altas, bajas y cambios de clientes. Altas,
bajas y cambios en el inventario.
Requisición de compras.
Ventas.
2.4 Restricciones
El sistema sólo podrá ser utilizado en plataformas de Microsoft
versión XP o posterior.
El sistema deberá de ser capaz de funcionar paralelamente con
otras aplicaciones, siempre y cuando el HW lo permita.
Sólo los usuarios registrados podrán hacer uso del sistema.
3 Requisitos específicos
Número de requisito R1
Nombre de requisito Requisito de autenticación
Tipo X Requisito Restricción
Fuente del requisito Todos los usuarios deberán introducir en la pantalla de “login” un
usuario y contraseña válidos en el sistema para poder entrar a éste.
Número de requisito R2
Nombre de requisito Requisito de descripción
Tipo Requisito X Restricción
Fuente del requisito El usuario administrador podrá guardar cambios en productos,
inventario, clientes y ventas, mientras que el usuario empleado sólo
lo podrá hacer en las ventas.
Prioridad del requisito Alta/Esencial X Media/Deseado Baja/ Opcional
Página
38
3.1 Requisitos comunes de los interfaces
La interfaz delogin necesita como entrada un usuario y contraseña
válidos para poder dar acceso a la siguiente interfaz.
Página
40
3.2.1 Requisito funcional 1 Autenticación
El usuario deberá proporcionar un usuario y contraseña válidos
para poder tener acceso al sistema.
3.3.1 Rendimiento
3.3.1.1 Requisito de respuesta
El sistema ofrecerá respuesta al usuario en tiempo real.
3.3.2 Seguridad
3.3.2.1 Requisito funcional-Seguridad 1: Requisito de
autenticación
El sistema requerirá de un usuario y
contraseña válidos para poder permitir el acceso.
Página
42
.
3.3.5 Mantenibilidad
3.3.5.1 Requisito funcional-Mantenibilidad 1:
Requisito de mantenimiento
El sistema recibirá mantenimiento una vez por
semana los primeros 6 meses.
Requisito funcional-Mantenibilidad 2:
3.3.5.2 Requisito de depuración de respaldos de bases de
datos.
Se revisarán los respaldos de la base de datos
para decidir si es necesaria una depuración.
3.3.6 Portabilidad
3.3.6.1 Requisito funcional-Portabilidad 1: Requisito
de SW MyMSystem será portablesiempre y cuando
el equipo en que
se quiera instalar cuente con un SO igual o de versión
posterior al primer equipo donde se instaló
4 Apéndices
Entrevista
Entrevista realizada para recopilar los requerimientos del sistema,
por Deahesy Nájera García.
1. ¿Qué módulos desea se encuentren en el
sistema? Ventas de contado
Ventas a
crédito
Inventario
Compras Página
43
2. ¿Necesita que tenga diferentes sesiones, o
sólo será una? Diferentes Como la del dueño y
la de los trabajadores.
Página
44
4. ¿Necesita que la base de datos de los productos
esté en crecimiento? Si. Porque quiero hacer más
grande en un futuro mi tienda
---
Diagrama E-R
Diagrama de Contexto
Página
46
Página
47
Diccionario de datos
TABLAS
RELACIONES
Página
49
Diagrama relacional
Página
50
Flujo grama de información/proceso/actividad
Proceso Inicio
Proceso Clientes
Página
51
Proceso Inventario
Proceso Compras
Página
52
Proceso Ventas
Página
53
Proceso completo
Página
54
Anexos
Diseño de interfaces
Interfaz de “Login”
Página
55
Interfaz de “Panel de Control”
Página
56
Interfaz de “Clientes”
Página
57
Página
58
Página
59
Página
60
Interfaz de “Inventario”
Página
61
Página
62
Página
63
Interfaz de “Compras”
Interfaz de “Ventas”
Página
64
Página
23