Elaboración del manual técnico del sistema.

Juan David Valencia

Yesney Romero
Natalia Mendieta

Instructor
Francisco Jesús Molina

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

ADSI (2104616)

SERVICIO NACIONAL DE APRENDIZAJE

SENA
PRESENTACION
RESUMEN
OBJETIVO
FINALIDAD DEL MANUAL
INTRODUCCION
1. ASPECTOS TEORICOS
1.1 HERRAMIENTAS UTLIZADAS PARA EL DESARROLLO

2. DIAGRAMAS DE MODELAMIENTO
2.1 DIAGRAMA DE CLASES
2.2 DIAGRAMAS DE CASOS DE USO
2.3 DICCIONARIO DE DATOS

3. ASPECTOS TECNICOS DE MODELAMINETO

3.1 MODIFICACION LOCAL

4. REQUERIMINETOS DEL SOFTWARE

4.1 REQUISITOS MINIMOS

BIBLOGRAFIA
 PRESENTACIÓN

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

información necesaria para realizar mantenimiento, instalación y exploración
del software AXY Software, el cual es un software de gestión documental que
se va a encargar de sistematizar toda la información del CDI JIREH,
generando documentos a partir de plantillas preestablecidas.

El manual ofrece la información necesaria de ¿cómo está realizado el

software? para que la persona (Desarrollador en el framework DJANGO) que
quiera editar el software lo haga de una manera apropiada, dando a conocer la
estructura del desarrollo del aplicativo.
 RESUMEN

El manual detalla los aspectos técnicos e informáticos del software AXY

Software, con la finalidad de explicar la estructura del aplicativo al personal
que quiera administrarlo, editarlo o configurarlo. La siguiente guía se
encuentra dividida en las herramientas que se usaron para la creación del
software con una breve explicación paso a paso, El aplicativo web maneja
diferentes funcionalidades y se explicará que funcionamiento de cada uno de
ellos, dando sugerencias para el debido uso del sistema de información.
 OBJETIVO

Dar a conocer el uso adecuado del software AXY 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 a la persona que quiera

administrar, editar o configurar el software AXY SOFTWARE usando las
debidas herramientas.
 INTRODUCCIÓN

El manual se realiza con el fin de detallar el software AXY Software

en términos técnicos, se darán a conocer las herramientas utilizadas
para su desarrollo, los requerimientos de hardware y software para su
instalación e implementación, e información detallada de sus
componentes como son:
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 la instalación y funcionamiento del software.
 1. ASPECTOS TEÓRICOS

El aplicativo AXY Software tiene la finalidad de mejorar los

procesos de administración y manipulación de la documentación de
la empresa CDI JIREH. Se recomienda que el siguiente manual sea
manipulado únicamente por la persona que esté autorizada para
administrar, editar o configurar el software AXY Software, la cual
debe tener conocimientos técnicos en los lenguajes, frameworks,
base de datos y librerías que se detallan más adelante, para velar por
la seguridad e integridad del aplicativo y la información de la base
de datos.
 2. HERRAMIENTAS UTILIZADAS PARA EL
DESARROLLO

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

para el desarrollo del aplicativo:

1.1. Visual Studio Code: Visual Studio Code es un editor de código

fuente que permite trabajar con diversos lenguajes de programación,
admite gestionar tus propios atajos de teclado y refactorizar el código.
Es gratuito, de código abierto y nos proporciona una utilidad para
descargar y gestionar extensiones con las que podemos personalizar y
potenciar esta herramienta.
1.2. Github: GitHub es una plataforma de alojamiento, propiedad de
Microsoft, que ofrece a los desarrolladores la posibilidad de crear
repositorios de código y guardarlos en la nube de forma segura, usando
un sistema de control de versiones, llamado Git. Facilita la
organización de proyectos y permite la colaboración de varios
desarrolladores en tiempo real. Es decir, nos permite centralizar el
contenido del repositorio para poder colaborar con los otros miembros
de nuestra organización.
1.3. Python: Python se define como un “lenguaje de programación versátil,
multiplataforma y multiparadigma que se destaca por su código legible
y limpio”. Cuenta con una licencia de código abierto que permite su
utilización en distintos contextos de forma gratuita. Para el desarrollo
del software se uso la versión 3.8
1.4. Django: Django es un framework web de alto nivel que permite
el desarrollo rápido de sitios web seguros y mantenibles. Desarrollado
por programadores experimentados, Django se encarga de gran parte de
las complicaciones del desarrollo web, por lo que puedes concentrarte
en escribir tu aplicación sin necesidad de reinventar la rueda. Es gratuito
y de código abierto, tiene una comunidad próspera y activa, una gran
documentación y muchas opciones de soporte gratuito y de pago. Para
el desarrollo del software se uso la versión 3.2.5.
1.5. MySql: MySQL es un sistema de gestión de bases de datos relacionales
de código abierto (RDBMS, por sus siglas en inglés) con un modelo
cliente-servidor. RDBMS es un software o servicio utilizado para crear
y administrar bases de datos basadas en un modelo relacional. Para el
desarrollo del software se usó la versión Distrib 10.4.20-MariaDB, for
Win64 (AMD64) que viene embebida en el paquete XAMPP.
1.6. Librerías, para la ejecución del software se requieren las
siguientes librerías de django:
1. asgiref==3.4.1
2. autopep8==1.5.7
3. beautifulsoup4==4.9.3
4. bs4==0.0.1
5. django-betterforms==1.2
6. django-widget-tweaks==1.4.8
7. frozen-django==1.0.2
8. Pillow==8.3.1
9. pycodestyle==2.7.0
10. PyMySQL==1.0.2
11. pytz==2021.1
12. six==1.16.0
13. soupsieve==2.2.1
14. sqlparse==0.4.1
15. toml==0.10.2
16. arabic-reshaper-2.1.3
17. future-0.18.2
18. html5lib-1.1 pyPdf2-1.26.0 python-bidi-0.4.2
19. reportlab-3.6.1
20. webencodings-0.5.1
21. xhtml2pdf-0.2.5
 2. DIAGRAMAS DE MODELAMIENTO

2.1 DIAGRAMA DE CLASES: describe la estructura de un sistema

mostrando las clases del sistema, sus atributos, operaciones (o
métodos), y las relaciones entre los objetos.
En este diagrama podemos verificar que la entidad principal es
Beneficiario, el cual se relaciona con las demás tablas, que serían las
tablas maestras del sistema.
Beneficiario: Entidad principal encargada de guardar la información
de los beneficiarios de los programas que ofrece el CDI- JIREH.

Sexo: Entidad secundaria donde se elegirá el sexo de los

beneficiarios.

Grupo Etareo: Clase donde se elegirá el grupo etareo, el cual es un

grupo en el cual se clasifican los beneficiarios de acuerdo a la edad.

Religiones: Clase donde se eligira la religión del beneficiario.

Hobbies: Clase donde se elegirá el Hobbie del beneficiario.

Deberes: Clase donde se elegirá los deberes del beneficiario.

Eduformal: Clase donde se elegirá el nivel de educación formal que

tenga el beneficiario.

Actividades Cristianas: Clase donde se elegirá las actividades

cristianas que realiza el beneficiario.

Materias: Clase donde se elegirá las materias favoritas del

beneficario.

Rendimiento académico: Clase donde se elegirá el rendimiento

académico del beneficiario.
 2.2 DIAGRAMAS 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 los actores del sistema.

En este caso existen tres casos de uso que son los tres perfiles con
los cuales pueden ingresar los usuarios del sistema, que son los
siguientes:
Perfil administrador: Permisos generales para administrar todo el
programa, incluyendo la creación de usuarios.
Perfil General: Perfil normal con el cual ingresará un usuario, tiene
permisos de ingresar a los modulos de su área correspondiente.
Perfil Básico: Es un usuario que solo podrá acceder a los reportes y
hacer consultas en el sistema, no tendrá opción de editar, crear o
eliminar nada en el sistema.

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.

Para cada clase le corresponde una entidad en la base de datos, las

cuales tienen el tipo de datos establecido, como se evidencia en el
diagrama relacional.
 3. Aspectos técnicos 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 MODIFICACION LOCAL: Si el usuario requiere hacer modificaciones de
manera local, tendrá que realizar la instalación desde 0 de todos los
componentes del sistema, a saber:
Python versión 3.8
Al instalar PYTHON, procedemos a instalar el editor de texto para código
Visual Studio Code, con licencia gratuita.

Continuamos descargando el aplicativo git para consolas en la pagina

https://git-scm.com/downloads.
Se puede clonar un repositorio con git clone [url]. Por ejemplo, si quieres
clonar la librería de Git llamada libgit2 puedes hacer algo así:
$ git clone https://github.com/libgit2/libgit2

En este caso sería git clone https://github.com/naxyam/axy.git

Al instalar Visual Studio Code abrir la aplicación y arrastrar la carpeta donde

está ubicado el proyecto creado en DJANGO, para poder visualizar los
archivos que contiene. Abrimos el archivo requirements.txt para validar que
estén los paquetes que se requieren para poder iniciar con las modificaciones
del software.
Validación del archivo requeriments.txt

Al validar los requerimientos, procedemos a abrir el símbolo del sistema

(cmd) para ejecutar el comando pip install -r requirements.txt
con el fin de instalar los paquetes necesarios para poder inicializar el servidor
local de DJANGO.
Si el administrador o desarrollador desea crear un usuario para poder ver la
administración de Django, lo realiza con el comando python manage.py
createsuperuser.
Se debe inicializar la base de datos, en nuestor caso la tenemos instalada con
el paque Xampp, por lo cual se debe iniciar Xampp y luego iniciar Apache y
Mysql.

Para iniciar el servidor de Django y realizar cambios localmente, se ejecuta el

comando: ‘python manage.py runserver’, se debe tener claro que no debe
haber errores en el código.
Ir a la URL localhost:8000/admin para abrir la administración de Django, después se ingresa
el usuario creado anteriormente, para el software se crea un usuario por defecto el cual es
admin y su contraseña es root.
Al ingresar a la administración de Django, si se requiere agregar, quitar o modificar datos
manualmente a los modelos lo pueden realizar en esta sección, esto se haría principalmente con
las tablas maestras las cuales no tienen opción de realizar operaciones a través del software.

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

 Sistema Operativo: Windows 8.1 o 10 64 bits.

 Procesador: Intel Core Celeron o superior

 Memoria RAM: 4GB mínimo

 Disco Duro: 1 TB

 Resolución de pantalla: 1280 x 720 pixeles

 Periféricos: Teclado, ratón, Bocinas, monitor.

 BIBLIOGRAFIA
git-scm.com: Como obtener un repositio en Git:
https://git-scm.com/book/es/v2/Fundamentos-de-Git-Obteniendo-un-
repositorio-Git
Git: Página de descargas de Git: https://git-scm.com/downloads
Hostinger Que es mysql: https://www.hostinger.co/tutoriales/que-es-
mysql Wikipedia: Diagrama de clases, copiado de:
https://es.wikipedia.org/wiki/Diagrama_de_clases
Wikipedia: Que es visual studio code:
https://es.wikipedia.org/wiki/Visual_Studio_Code
Developer.Mozilla.org: Que es Django:
https://developer.mozilla.org/es/docs/Learn/Server-side/Django/Introduct
ion