MANUAL TÉCNICO DEL SISTEMA

CONTENIDO

Pág.

PRESENTACIÓN.......................................................................................................5
RESUMEN.................................................................................................................6
OBJETIVO.................................................................................................................7
FINALIDAD DEL MANUAL........................................................................................7
INTRODUCCIÓN.......................................................................................................8
1. ASPECTOS TÉCNICOS....................................................................................9
1.1. HERRAMIENTAS UTILIZADAS PARA EL DESARROLLO.........................9
1.1.1. Visual studio code..................................................................................9
1.1.2. Gitlab......................................................................................................9
1.1.3. Xampp..................................................................................................10
2. DIAGRAMAS DE MODELAMIENTO...............................................................11
2.1. DIAGRAMA DE CLASES...........................................................................11
2.2. DIAGRAMA DE CASOS DE USO..............................................................12
2.3. DICCIONARIO DE DATOS........................................................................13
3. ASPECTO TÉCNICO DEL DESARROLLO DEL SISTEMA............................14
3.1. MODIFICACIÓN LOCAL............................................................................14
4. REQUERIMIENTOS DEL SOFTWARE...........................................................21
4.1. REQUISITOS MÍNIMOS............................................................................21
BIBLIOGRAFÍA................................................................................................................22
 LISTA DE FIGURAS

Pág.

Figura 1. Diagrama de modelado de clases............................................................11

Figura 2. Diagrama de casos de uso.......................................................................12
Figura 3. Página web de descarga Python.............................................................14
Figura 4. Página web de descarga Sublime Text....................................................15
Figura 5. Página web de descarga GitHub.............................................................15
Figura 6. Clonación repositorio de GitHub..............................................................16
Figura 7. Ventana de cambios del repositorio.........................................................16
Figura 8. Validación del archivo requirements.txt...................................................17
Figura 9. Ejecución de comando para instalar paquetes necesarios.....................17
Figura 10. Creación de súper usuario para la administración de Django...............18
Figura 11. Inicialización del servidor local...............................................................18
Figura 12. Ingreso a la administración de Django...................................................19
Figura 13. Administración de Django......................................................................19
Figura 14. Cambios repositorio en GitHub Desktop................................................20
 LISTA DE TABLAS

Pág.

Tabla 1. Diccionario de datos modelo usuarios......................................................13

Tabla 2. Diccionario de datos modelo niveles.........................................................13
Tabla 3. Diccionario de datos modelo actividades..................................................13
 PRESENTACIÓN

El siguiente manual se ha desarrollado con la finalidad de dar a conocer la

información necesaria para que el Administrador del Restaurante pueda tener una
información clara de cómo están los procesos entre el departamento de ventas y
la cocina.
El manual ofrece la información necesaria de ¿cómo fue creado el software? para
que la persona (Desarrollador o Ingeniero de Sistemas) pueda instalarlo, hacerle
mantenimiento o editar el software, y lo haga de una manera sencilla y apropiada,
dando a conocer la estructura del desarrollo de la aplicación.
 RESUMEN

El manual detalla los aspectos técnicos e informáticos del software (Pos de

ventas) con la finalidad de explicar la estructura de la aplicación al personal que
estará a cargo como son el Administrador los vendedores y el Departamento de
Contabilidad. La siguiente guía se encuentra dividida en Módulos que se usaron
para la creación del software con una breve explicación paso a paso. la aplicación
maneja diferentes funcionalidades requieren de hardware y software el cual se
explicará que funcionamiento realiza cada uno de ellos, dando sugerencias para el
debido uso del sistema de información.
 OBJETIVO

Dar a conocer el uso adecuado del software en aspectos técnicos de manera

descriptiva e ilustrada sobre los componentes y funcionalidades que conforman el
buen funcionamiento del sistema de información.

FINALIDAD DEL MANUAL

La finalidad de éste manual técnico es instruir al personal que estará a cargo de

administrar, editar o configurar el software usando las herramientas
adecuadamente para obtener el resultado deseado para lo cual fue creado la
aplicación.
 INTRODUCCIÓN

El manual se realiza con el fin de detallar el software en términos técnicos para

que la persona que vaya a administrar, editar o configurar la aplicación lo haga de
una manera apropiada. El documento se encuentra dividido en las siguientes
secciones:

ASPECTOS TEÓRICOS: Se darán a conocer conceptos, definiciones y

explicaciones de los componentes del aplicativo desde un punto de vista
teórico para mayor entendimiento por parte del lector sobre el
funcionamiento del sistema de información e herramientas.

DIAGRAMAS DE MODELAMIENTO: Se compone por diagramas e

ilustraciones alusivos al funcionamiento del aplicativo.

ASPECTO TÉCNICO DEL DESARROLLO DEL SISTEMA: Corresponde a

la instrucción al lector sobre los componentes del aplicativo desde una
perspectiva técnica en los aspectos de almacenamiento de datos,
estructura del desarrollo y recomendaciones del uso debido del aplicativo.

REQUERIMIENTOS DEL SOFTWARE: Detalla los requerimientos básicos

necesarios para el funcionamiento del software.
 1. ASPECTOS TÉCNICOS

El software tiene la finalidad de mejorar los procesos administrativos y

comunicación entre los departamentos internos del restaurante. Se recomienda
que el siguiente manual sea manipulado únicamente por la persona que tendrán
contacto directo con el software, para velar por la seguridad de los datos que se
almacenan en la base de datos ya que pueden ser usados para otros fines.

1.1. HERRAMIENTAS UTILIZADAS PARA EL DESARROLLO

Es ésta sección se procede a explicar las herramientas informáticas empleadas

para el desarrollo del aplicativo:

Visual Studio Code 

Es un editor de código fuente desarrollado por Microsoft para Windows, Linux y macOS.

Incluye soporte para la depuración, control integrado de Git, resaltado de sintaxis,
finalización inteligente de código, fragmentos y refactorización de código. También es
personalizable, por lo que los usuarios pueden cambiar el tema del editor, los atajos de
teclado y las preferencias. Sublime Text está disponible para OS X, Windows y Linux. Una
licencia es todo lo que necesita para utilizar Sublime Text en todos los equipos de su
propiedad, sin importar el sistema operativo que utiliza, pero también ofrece una licencia
gratuita de prueba. Usa un conjunto de herramientas de interfaz de usuario personalizada,
optimizado para la velocidad y la belleza, aprovechando al mismo tiempo la funcionalidad
nativa en cada plataforma.

GitLab

GitLab es una suite completa que permite gestionar, administrar, crear y conectar los
Repositorios con diferentes aplicaciones y hacer todo tipo de integraciones con ellas,
ofreciendo un ambiente y una plataforma en cual se puede realizar las varias etapas
de su SDLC/ADLC y DevOps.

Gitlab es un servicio web de control de versiones y desarrollo de software colaborativo

basado en Git. Además de gestor de repositorios, el servicio ofrece también alojamiento
de wikis y un sistema de seguimiento de errores, todo ello publicado bajo una Licencia de
código abierto.
XAMPP

XAMPP es una distribución de Apache que incluye varios softwares libres. El nombre es

un acrónimo compuesto por las iniciales de los programas que lo constituyen: el servidor
web Apache, los sistemas relacionales de administración de bases de datos MySQL y
MariaDB, así como los lenguajes de programación Perl y PHP.

Descripción completa del servidor web Apache.  Apache HTTP Server es un software

de servidor web gratuito y de código abierto para plataformas Unix con el cual se ejecutan
el 46% de los sitios web de todo el mundo. Les permite a los propietarios de sitios web
servir contenido en la web, de ahí el nombre de «servidor web» ...

.
 2. DIAGRAMAS DE MODELAMIENTO

2.1. DIAGRAMA DE CLASES

El diagrama de clases está compuesto de las entidades y atributos que se crearon

para el almacenamiento de datos del software.

Figura 1. Diagrama de modelado de clases

Fuente: Por los autores.

En la figura 1, se detalla cada una de las entidades (modelos) usadas para el

almacenamiento de datos del aplicativo, en el cual cada una de ellas realiza las
siguientes funciones:
 USUARIOS: Almacena los datos de los usuarios que se registran para poder ofrecerles
promociones o descuentos por fidelidad.

MODULOS: La composición y funcionalidades de cada una de los módulos que se

encuentran en el software.

REPORTES: Podrá tener los reportes de cada venta y los inventarios en tiempo real

2.2. DIAGRAMA DE CASOS DE USO

En el diagrama de caso de uso se detalla el papel a desempeñar en relación con

el aplicativo por parte de las personas relacionadas, y sus administradores o
acompañantes son: El terapeuta, docente, padre de familia o psicólogo.

Figura 2. Diagrama de casos de uso

Calicar Rendimiento

Seguimiento de Actividades
CONTADOR

Calicar Rendimiento
ADMINISTRADOR

Registro Usuario
PROVEEDORES

Otorgar Actividades
VENTAS

Realizar actividad Niño con síndrome

de Down

Fuente: Por los autores.

2.3. DICCIONARIO DE DATOS

Para el almacenamiento de datos del software, se definen los campos necesarios

para cada una de las entidades relacionadas con el aplicativo.

Tabla 1. Diccionario de datos modelo usuarios

USUARI
OS
NOMBRE TIPO DATO TAMAÑ DESCRIPCIÓN
CAMPO O
user OneToOneField Nombre usuario.
slug SlugField Identificador de usuario.
documento PositiveIntegerFie Documento del niño.
ld
genero CharField 2 Genero del niño
fnacimiento DateField Edad del niño
Fuente: Por los autores.

Tabla 2. Diccionario de datos modelo niveles

NIVELES
NOMBRE TIPO TAMAÑ DESCRIPCIÓN
CAMPO DATO O
nombre CharField 100 Nombre del nivel.
slug SlugField Identificador del nivel.
juego CharField 50 Nombre del juego.
color CharField 50 Color del nivel.
actividad ForeignKey Llave foránea con la actividad.
image ImageField Edad del niño
Fuente: Por los autores.

Tabla 3. Diccionario de datos modelo actividades

ACTIVIDAD
ES
NOMBRE TIPO TAMAÑ DESCRIPCIÓN
CAMPO DATO O
nombre CharField 100 Nombre de la actividad.
key_press CharField 3 Nombre de la tecla a presionar.
key_press_descriptio CharField 100 Descripción de la tecla a
n presionar.
slug SlugField Identificador de la actividad.
image ImageField Ubicación imagen de la actividad.
tiempo IntegerField Almacena el tiempo de la
actividad.
color CharField 50 Color de la actividad.
video CharField 200 Almacena de video de la actividad.
Fuente: Por los autores.
 3. ASPECTO TÉCNICO DEL DESARROLLO DEL SISTEMA

En la siguiente sección se procede a realizar una descripción detallada sobre los

aspectos técnicos del aplicativo, relacionado con la instalación de las herramientas
necesarias para realizar modificaciones requeridas de manera ordenada.

3.1. MODIFICACIÓN LOCAL

Si el desarrollador quiere realizar modificaciones del software de manera local,

tendrá que realizar la instalación de componentes adicionales, para empezar se
debe instalar Python versión 2.7.12, el cual se consigue de manera gratuita en la
página www.python.org, consiguiente se debe de descargar pip (Sistema de
gestión de paquetes de Python) para poder instalar los requerimientos del
software.

Figura 3. Página Visual Studio Code

Fuente: (python, s.f.)

Al instalar PYTHON, procedemos a instalar el editor de texto para código Sublime

Text, descargamos la última versión en la página oficial, esta descarga es con
licencia gratuita.
Figura 4. Página web de descarga Sublime Text

Fuente: (Visual studio code

Se continúa descargando el aplicativo Gitlab para escritorio, se realiza desde la

página oficial, con el fin de poder obtener el repositorio y realizarle cambios al
software llevando un historial.

Figura 5. Página web de descarga Gitlab

Fuente: (GitHub, s.f.)

Abrir el aplicativo Gitlab después de instalado, dirigirse al logo de adición y dar clic
en Clone, esa función clona el repositorio en un lugar indicado por el usuario. Se
valida que quede en la venta de cambios sin que haya generado error alguno.
Figura 6. Clonación repositorio de Gitlab

Fuente: Por los autores.

Figura 14. Cambios repositorio en GitHub Desktop

Fuente: Por los autores.

 4. REQUERIMIENTOS DEL SOFTWARE

En esta sección se detallará los requisitos mínimos del sistema para poder
ejecutar los aplicativos usados para modificar el software funnYD.

4.1. REQUISITOS MÍNIMOS

 Sistema Operativo: Windows 7

 Procesador: Intel Core Celeron

 Memoria RAM: 1GB

 Disco Duro: 1GB

 Resolución de pantalla: 1280 x 720 pixeles

 Periféricos: Teclado, ratón, Bocinas (Opcional)

 BIBLIOGRAFÍA

https://effervescentadsi.files.wordpress.com/2013/04/diagrama-de-activivdades-
ultimo1.png

https://visioncodigo.com/blog/como-clonar-un-repositorio-de-laravel-de-github-o-gitlab-
sin-problemas

https://code.visualstudio.com/Download