Manual Técnico de Sistema

Participantes:

Jorge Andrés Viloria Molina

Santiago Gómez Marulanda

Instructores:

John Jairo Donato Ariza

Ilmer Cuello García

ficha 2104600

Servicio Nacional de Aprendizaje SENA

Centro de Gestión de Mercados, Logística y Tecnologías de la Información

Evidencia Fase 5 Tecnólogo en Análisis y Desarrollo de Sistemas de Información

Septiembre 2021
 CONTENIDO

Presentación…………………………………………………………

Resumen

Objetivo
Finalidad del Manual
INTRODUCCIÓN
1.1 Aspectos Teóricos
1.2 Diagramas de Modelamiento
1.3 Aspecto Técnico del Desarrollo
1.4 Requerimientos del Software
Aspectos Técnicos
Herramientas Utilizadas
1.1.1. Visual studio code
1.1.2. Gitlab
1.1.3. Xampp
Clonación repositorio de Gitlab.
Base de datos en Xampp

Diagrama de Modelamiento
1.1 Usuarios
1.2 Módulos
1.3 Reportes
Diagrama de Casos de Uso:
Diagrama de casos de uso

Requerimientos del Software

Requisitos Mínimos

Bibliografía
 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.

 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.

Herramientas Utilizadas

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.
La ventaja principal de GitLab es que facilita notablemente el desarrollo de software ágil entre

varios equipos. De esta manera, varios desarrolladores pueden trabajar simultáneamente en un

proyecto y editar, por ejemplo, diferentes funciones de forma paralela. La protocolización

continua de todos los procesos garantiza que no se pierda ninguna modificación del código ni

que se sobrescriba de forma no intencionada. También es posible deshacer rápidamente los

cambios ya aplicados.

GitLab se basa en el software de gestión de versiones de uso común Git. Git está disponible de

forma gratuita como software de código abierto y es considerado uno de los sistemas de control

de versiones más usados en general. GitLab es una de las alternativas a GitHub más populares

(cuando Microsoft se hizo con GitHub en 2018, muchos usuarios se cambiaron a GitLab).
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» ...

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.

 Diagrama de Modelamiento

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

.
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.

Módulos: 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.
Diagrama de Casos de Uso:

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

Ventas por parte del administrador y el Departamento de Ventas.

Diagrama de casos de uso

 Requerimientos del Software

En esta sección se detallará los requisitos mínimos para los archivos del sistema para poder

ejecutar el Programa POS y un navegador Web (se recomienda Google Chrome Versión 70

o superior).

Requisitos Mínimos:

 Sistema Operativo: Windows 10

 Procesador: Intel Core i3

 Memoria RAM: 8GB

 Disco Duro: 1 Terra

 Resolución de pantalla: 1280 x 720 pixeles

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

 [Compañía]

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

https://www.ionos.mx/digitalguide/paginas-web/desarrollo-web/tutorial-de-gitlab/

http://repository.unipiloto.edu.co/bitstream/handle/20.500.12277/6089/Manual%20T

%C3%A9cnico%20del%20Sistema%20funnYD.pdf?sequence=3&isAllowed=y