Manual tecnico

Vista previa del material en texto

Ingeniería de Software 
 
 
Easywork Academy 
 
 
Presentado por: 
Jaime Andrés Ruiz Melendres 
Jose Daniel Muñoz Gómez 
Fabian Alberto Sanchez Ruiz 
Roosevelt Daniel Santos Vanegas 
Sebastian Ricardo Cárdenas 
 
Presentado a: 
Oswaldo Velez Langs 
 
Universidad de Córdoba 
Facultad de ingeniería 
 
 
Montería - 2022 
Manual técnico del sistema 
 
 
1. Presentación 
2. Objetivo 
3. Resumen 
4. Finalidad del manual 
5. Introducción 
6. Aspectos técnicos 
6.1. Herramientas utilizadas para el desarrollo 
6.1.1. GitHub 
7. Diagramas del modelamiento 
7.1. Diagrama de clases 
7.2. Diagrama de casos de uso 
7.3. Diagrama relacional BD 
8. Requerimientos del software 
8.1. Requisitos mínimos 
 
 
 
 
 
Manual técnico del sistema 
 
Presentación 
 
El siguiente manual guiara para los usuarios o técnicos especializados que harán soporte al sistema, 
el cual les dará a conocer los requerimientos y la estructura para la construcción del sistema, en el 
desarrollo de programa de escritorio y aplicativo móvil conectados mediante una base de datos en la 
nube, el cual muestra las herramientas necesarias para la construcción y la funcionalidad del sistema 
además de cuáles son los datos que se utilizan en dicho sistema. 
 
Manual técnico del sistema 
 
Objetivo 
 
Tenemos como objetivo general el desarrollar un software que permita reducir la deserción que 
producen las dificultades académicas en los universitarios o tecnólogos. 
Por otra parte, tenemos unos más específicos los cuales son: 
 
● Analizar los requerimientos funcionales y no-funcionales que permita reducir las dificultades 
académicas en los estudiantes universitarios/tecnólogos. 
● Diseñar interfaces amigables que permitan facilidad y comodidad a los estudiantes a la hora 
de resolver sus problemáticas. 
● Ejecutar las pruebas de la aplicación web que garanticen un correcto funcionamiento. 
● Lograr que los estudiantes mejoren sus notas académicas mediante el software. 
● Establecer una herramienta de ayuda 24/7 de ayuda o guía. 
● Disponer de una biblioteca amplia de contenido para el soporte de los estudiantes. 
 
 
Manual técnico del sistema 
 
Resumen 
 
 El manual detalla los aspectos técnicos e informáticos del software EasyWork con la 
finalidad de explicar la estructura del sistema al personal que quiera administrarlo, 
editarlo o configurarlo. La siguiente Manuel contiene como esta estructurado, se muestra cuales son 
los datos y como se relacionan. 
Se tienen en cuenta que el aplicativo no solo estará para web sino para un entorno móvil donde se 
explicara un poco mas a detalle cuales son estos requisitos que tenemos que tener para poder usar el 
software. 
 
 
Finalidad del manual 
 
La finalidad de este manual técnico es instruir a la persona que quiera administrar, editar o 
configurar el software EasyWork usando las debidas herramientas y el previo conocimiento que se 
requiere para un entendimiento del software y poder manipularlo de forma correcta 
 
 
Manual técnico del sistema 
 
Introducción 
 
 
El manual se realiza con el fin de detallar el software EasyWork en términos técnicos 
para que la persona que vaya a administrar, editar o configurar el aplicativo lo haga 
de una manera apropiada sin dañar la integridad del software a trabajar. El documento se encuentra 
dividido en las siguientes partes para un correcto entendimiento del aplicativo y rápido. Tenemos: 
 
Aspectos técnicos: 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 y herramientas. 
 
Diagramas de modelamiento: Se compone por diagramas e ilustraciones alusivos al 
funcionamiento del aplicativo. 
 
Requerimientos del software: Detalla los requerimientos básicos necesarios para el 
funcionamiento del software. 
 
Manual técnico del sistema 
 
Herramientas utilizadas para el desarrollo 
 
ANDROID STUDIO: Es el entorno de desarrollo oficial de Android, reemplazando el 
lenguaje de programación de eclipse, el entorno de Android Studio está disponible para las 
plataformas Microsoft Windows, macOS y GNU/Linux en especial para el desarrollo de Android. 
 
GitHub: Es una plataforma de desarrollo colaborativo de software para alojar proyectos utilizando 
el sistema de control de versiones Git. GitHub aloja tu repositorio de código y te brinda herramientas 
muy útiles para el trabajo en equipo, Manual técnico del sistema dentro de un proyecto. Además de 
eso, puedes contribuir a mejorar el software de los demás. 
 
Para poder alcanzar esta meta, GitHub provee de funcionalidades para hacer un fork y solicitar pulls. 
Realizar un fork es simplemente clonar un repositorio ajeno (genera una copia en tu cuenta), para 
eliminar algún bug o modificar cosas de él. Una vez realizadas tus modificaciones puedes enviar un 
pull al dueño del proyecto. Éste podrá analizar los cambios que has realizado fácilmente, y si 
considera interesante tu contribución, adjuntarlo con el repositorio original. 
 
Para EasyWork, se maneja un repositorio privado el cual se contribuye diferentes commits con ajustes 
o cambios que se realizan en el software, haciendo así un trabajo en equipo en el desarrollo del 
aplicativo. 
 
PhpStorm es el IDE PHP «Lightning Smart» creado por JetBrains y el cual está disponible para 
desarrolladores en Linux, MacOS y Windows. Es importante mencionar que esta no es una aplicación 
gratuita y los usuarios deben comprar una clave de licencia para usarla en todo su potencial. 
Aunque JetBrains ofrece una licencia gratuita de un año para estudiantes, profesores, institutos y 
demás áreas académicas, la cual te permite no solo utilizar este IDE sino también te da acceso a los 
diferentes productos que ofrece JetBrains. 
 
PhpStorm proporciona un editor para PHP, HTML y JavaScript con análisis de código sobre la 
marcha, prevención de errores y refactorizaciones automatizadas para código PHP y JavaScript. La 
finalización del código de PhpStorm es compatible con diferentes versiones de PHP, incluidos 
generadores, corutinas, la última palabra clave, lista en foreach, espacios de nombres, cierres, rasgos 
y sintaxis de matriz corta. Además de que incluye un editor SQL completo con resultados de consulta 
editables. 
 
Si has llegado a este artículo podría ser porque te interesa PHP y eres programador o no tienes nada 
que ver con el mundo de la programación aún, pero te atrae o interesa, estas son mis interpretaciones 
y tú tendrás la tuya propia, así que hay que empezar desde el inicio, por básico que parezca para poner 
en contexto a Laravel y todas sus posibilidades. 
 
Laravel: Es un framework de PHP para ayudarnos en un tipo de desarrollo sobre aplicaciones 
escritas en este lenguaje de programación. Esté framework o más bien podría llamarlo compañero de 
Manual técnico del sistema 
 
ahora en adelante, nos ayuda en muchas cosas al desarrollar una aplicación, 
por medio de sus sistema de paquetes y de ser un framework del tipo MVC (Modelo-Vista-
Controlador) da como resultado que podamos “despreocuparnos” (por así decirlo) en ciertas aspecto 
del desarrollo, cómo instanciar clases y métodos para usarlos en muchas partes de nuestra aplicación 
sin la necesidad de escribirlo y repetirlos muchas veces con lo que eso conlleva a la hora de modificar 
algo en el código. 
 
DataGrid: Red Hat® Data Grid es una solución de almacenamiento de datos NoSQL distribuida 
y en memoria. Con ella, las aplicaciones pueden acceder a los datos, como así también procesarlos y 
analizarlos, todo a la velocidad de la memoria, para ofrecer una mejor experiencia al usuario. 
 
WebStorm: Es un entorno de desarrollo integrado para JavaScript y las tecnologías relacionadas. 
Al igual que otros IDE de JetBrains, hace que su experiencia de desarrollosea más agradable, 
automatiza las tareas repetitivas y le ayuda a gestionar las tareas complejas con facilidad. 
 
React: Es (también llamada React.js o ReactJS) es una biblioteca JavaScript de código abierto 
diseñada para crear interfaces de usuario con el objetivo de facilitar el desarrollo de aplicaciones en 
una sola página. Es mantenido por Facebook y la comunidad de software libre. En el proyecto hay 
más de mil desarrolladores libres. 
 
React intenta ayudar a los desarrolladores a construir aplicaciones que usan datos que cambian todo 
el tiempo. Su objetivo es ser sencillo, declarativo y fácil de combinar. React sólo maneja la interfaz 
de usuario en una aplicación; React es la Vista en un contexto en el que se use el patrón MVC 
(Modelo-Vista-Controlador) o MVVM (Modelo-vista-modelo de vista). También puede ser utilizado 
con las extensiones de React-based que se encargan de las partes no-UI (que no forman parte de la 
interfaz de usuario) de una aplicación web. 
 
Chakra UI: es una biblioteca de componentes de interfaz de usuario para React.js que está 
diseñada para la accesibilidad. Nos gusta, especialmente por sus características de accesibilidad, 
incluyendo el modo oscuro y la compatibilidad con las directrices de la Iniciativa de Accesibilidad 
Web – Aplicaciones enriquecidas de Internet Accesibles (WAI-ARIA). Es más, es fácil de probar y 
personalizar lo que contribuye a una buena experiencia de desarrollo, acelerando el proceso de 
desarrollo de soluciones UI en ambientes de producción. 
 
Tailwind: CSS es un framework CSS de bajo nivel altamente personalizable que le permite crear 
diseños personalizados eliminando los estilos de componentes pre-definidos que necesitarías sobre-
escribir en todo caso. 
Tailwind CSS es un framework CSS que permite un desarrollo ágil, basado en clases de utilidad que 
se pueden aplicar con facilidad en el código HTML y unos flujos de desarrollo que permiten optimizar 
mucho el peso del código CSS. 
 
Manual técnico del sistema 
 
Tailwind CSS es una potente herramienta para el desarrollo frontend. Está 
dentro de la clasificación de los frameworks CSS o también llamados frameworks de diseño. Permite 
a los desarrolladores y diseñadores aplicar estilos a los sitios web de una manera ágil y optimizada. 
 
El servidor de base de datos MySQL es uno de los más característicos y por tener la opción de 
código abierto a nivel mundial, siendo una de las más populares antes ORACLE y Microsoft SQL 
Server principalmente en entonos de desarrollo web. 
 
Flutter: el framework creado por Google para ayudar a la interfaz del usuario. Compartir: Flutter 
está directamente conectado al área de desarrollo mobile. Inicialmente, era direccionado solo para la 
creación de aplicaciones; pero, con las alteraciones realizadas hace poco tiempo, esto cambió. 
 
Manual técnico del sistema 
 
Diagramas del modelamiento 
 
Diagrama de clases 
1. Búsqueda de tarea
 
 
 
Manual técnico del sistema 
 
2. Subir recursos 
 
 
 
Manual técnico del sistema 
 
3. Solicitud de mentor 
 
 
Manual técnico del sistema 
 
4. Edición de perfiles 
 
 
 
 
 
Manual técnico del sistema 
 
5. Postear tarea 
 
 
 
 
 
Manual técnico del sistema 
 
6. Pasarela de pagos 
 
 
Manual técnico del sistema 
 
7. Aceptar tarea 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Manual técnico del sistema 
 
Diagrama de clases 
 
 
Manual técnico del sistema 
 
Diagrama relacional 
 
Manual técnico del sistema 
 
 
Manual técnico del sistema 
 
Requerimientos del software 
 
Requisitos mínimos pc: 
 
Sistema operativo Windows 10 
 Memoria RAM 2Gb 
 Espacio en disco duro 3Gb 
 Procesador Intel Core i3 
 Grafica UHD grafic 500 
 
 
Requisitos mínimos móvil: 
 
Procesador Snapdragon 540 
Sistema operativo Android 9 
Memoria RAM 3Gb 
Espacio 1Gb