Requerimientos Tercera Edición

 




Versión PM-01





Elaborado por :


 Alonso Meléndez Heriberto Abraham          201846714

Ballesteros Soriano Luis Enrique                 201846830

Mendieta León Adriana                                201863504

Polaco Romero Luis Eduardo                      201826556

Vázquez Gutiérrez Marcelo                          201830117

 

 

 

 

 


Tabla de contenidos


Tabla de contenidos 2

Historial de revisiones 2

1. Introducción 3

1.1 Propósito 3

1.2 Convenciones de documentos 3

1.3 Público objetivo y sugerencia de lectura 3

1.4 Definición del producto 4

1.5 Referencias 4

2. Descripción general 5

2.1 Perspectiva del producto 5

2.2  Funciones del producto 5

2.3  Clases y características de Usuario 6

2.4 Entorno operativo 7

2.5 Restricciones de diseño e implementación. 7

2.6 Documentación para el usuario 8

2.7 Suposiciones y dependencias 8




Historial de revisiones

Nombre

Fecha

Razón de los cambios

Versión

Revisión 1

27/10/2020

Versión Inicial, previa aprobación del cliente.

PM-01

Revisión 2

11/11/2020

Segunda versión, especificación de casos de uso

PM-02

Revisión 3

17/11/2020

VOPCs

PM-03



1. Introducción

1.1 Propósito


La elaboración de este documento tiene como propósito definir las especificaciones funcionales y no funcionales del sistema para la implementación y correcta utilización de la página web del doctor Isaías Reyes Mar. 

La página permitirá mirar y consultar los distintos tipos de mariposas investigadas por el doctor, así como su información anexada como nombre de la mariposa, familia, subfamilia, género, especie, subespecie e imagen de cada uno de estos ejemplares de una manera clasificada, permitiendo un control de filtro para su fácil acceso.

1.2 Convenciones de documentos


Momentáneamente no se ha establecido ninguna convención para este documento, sin embargo de ser necesario se actualizará  en las convenciones y se establecerán en este documento.


1.3 Público objetivo y sugerencia de lectura

Este documento está dirigido para usuarios, desarrolladores, administrador de proyecto, y un escritor de documentación con el fin de que comprendan el uso del sitio web desde lo más básico hasta todas sus especificaciones.

Los usos que podrán tener cada uno de los distintos lectores son:

Los desarrolladores: Serán capaces de conocer cómo están distribuidos todos los módulos de la página, desde la página principal hasta el uso de todas las bases de datos utilizadas para la elaboración del sitio web, así como las funciones que pueden realizar los distintos tipos de usuarios (administrador y usuario), y gracias a esto serán capaces de leer, modificar, cambiar o añadir nuevas funcionalidades al sitio.

Usuarios: Serán capaces de comprender la forma en la que pueden consultar la información de los ejemplares de mariposas que se encuentran en el sitio, así como poder hacer búsquedas de un determinado tipo de mariposas, con el uso de los filtros integrados en el sitio web, con el fin de facilitar el acceso a la información.

Cliente (administrador del proyecto): El administrador será capaz de poder agregar y llevar control de todos los ejemplares, así como modificar uno o más campos de las mariposas, o eliminar ejemplares de la página según lo desee.


1.4 Definición del producto

Mariposas es un sitio web diseñado con el fin de que el administrador puede publicar y guardar la colección de mariposas que ha recabado durante sus años de investigación y a su vez sirva como un recurso en línea de información para un público interesado en el tema.  Mariposas es el sitio web indicado tanto para amantes de mariposas como para novatos que deseen conocer más de la taxonomía de esta especie, es un recurso didáctico sin fines de lucro. 

El objetivo es hacer conocer la información recabada por el administrador al público sin embargo la información es confidencial hasta que el administrador de la orden. 

“Mariposas”  cuenta con una interfaz amigable para el usuario, es intuitiva y fácil de usar, cuenta con una sección única para el administrador que le permitirá modificar la información publicada en el sitio, hacer altas y bajas de mariposas guardadas en la base de datos. Cuenta con información escrita y visual.

El usuario podrá observar la información pero no podrá hacer cambios, el usuario puede hacer búsquedas a través de filtros como buscar por familia o por subfamilia.


1.5 Referencias

Para las pruebas se obtuvo la información necesaria del sitio web, así mismo es el sitio web principal que se usó como base para el desarrollo de este proyecto.  https://www.butterfliesofamerica.com/

https://code.jquery.com/jquery-3.3.1.min.js?fbclid=IwAR14Fc_o04-sU9DbqKXlt4PRTZvg_fQYbaraQQrc6oNG2wUP_bE2H4kNVrU





2. Descripción general

2.1 Perspectiva del producto


Mariposas es un nuevo sitio web que no está ligado a algún proyecto ya existente, es decir es un sitio web autónomo. El origen de este sitio es por parte de un doctor que quiere hacer pública su colección de mariposas que ha recolectado en los últimos 5 años que ha su vez podría ir agregando más ejemplares con el paso del tiempo, así que se espera que el sitio se vaya actualizando cada vez que la colección aumenta. 


2.2 Funciones del producto

Nuestro producto ofrecerá las siguientes funciones, cabe destacar que más adelante se hará una explicación más detallada de cada función, además, las funciones dependerán de la jerarquía de usuario, es decir, el administrador tendrá funciones que el usuario común no, también, esto se ve más detallado más adelante.


2.3 Clases y características de Usuario

Este producto se aboca principalmente en aquellos conocedores del mundo de las mariposas que deseen retroalimentarse o conocer algo nuevo respecto a estas especies. Esto lo podemos generalizar en un principio y desglosar poco a poco.

De una manera más generalizada para comenzar, podemos clasificar a nuestros usuarios en dos: Administrador y Usuario común.

·         Administrador: El administrador será nuestro cliente principal, aquel que nos está solicitando el proyecto. Nuestro producto se amolda a las características que él está solicitando. Este usuario es capaz de administrar toda la información que exista en esta página, y estará disponible para su modificación: ya sea Editar, modificar, añadir o eliminar información de una mariposa o una familia de mariposas. Además, ayudará a que nuestro cliente pueda compartir todo su conocimiento con otras personas, los cuales serán los usuarios comunes. Este tipo de usuario tendrá la ventaja de:

o   Manipular la información solamente llenando los campos solicitados

o   Si quiere editar la información, no debe de eliminar toda la mariposa y volverla a crear, sino que dispondrá de un apartado de edición en el cual podrá modificar la información que el desee y  como desee.

·         Usuario Común: Serán las personas que verán el trabajo del administrador. Podrán ver, buscar o filtrar información dependiendo lo que ellos soliciten. El usuario común será el que cargará con una cantidad de funciones bastante limitadas, es decir, no podrá manipular muchas cosas que aparezcan en nuestro producto, pero además gozará de algunas ventajas a la hora de trabajar con nuestro producto; mencionando algunas:

o   El usuario común no podrá editar, añadir o eliminar información de las mariposas que el administrador ha añadido.

o   El usuario no será capaz de adquirir un nivel de administrador.

o   Podrá filtrar información dependiendo a lo que él desee, las filtraciones pueden ser por familia, entre otras.

o   Tendrá la información breve, concreta y agradable a la vista, teniendo el privilegio de tener hasta una imagen muestra de cada mariposa.

Dentro del usuario común, existe una gran diversidad de tipos de usuario, ya sea de gente conocedora, o gente que está aprendiendo, incluso gente que quiere iniciar en el mundo de la Lepidopterología, pero eso ya no es tan relevante en la generalización de nuestros tipos de usuarios.


2.4 Entorno operativo

El entorno operativo de la página web es uno muy amplio, debido a que casi todos los dispositivos tecnológicos actuales tienen acceso a la red, aunque es fundamental contar con una conexión de red estable.


2.5 Restricciones de diseño e implementación.

Las modificaciones para el sitio web deberán ser pedidas antes de la fecha determinada, debido a que después de ese tiempo, el sitio estará a cargo del cliente. Se presentaron ciertas dificultades debido a que no se nos fue entregada ninguna información de los ejemplares, y se tuvo que llevar una guía sobre datos de una página existente que nos proporcionó el cliente . Algunas cuestiones de diseño se vieron retrasadas debido a la elaboración del sitio en base a la página referencia. 

2.6 Documentación para el usuario

En caso de surgir alguna duda o problema con el servicio, los usuarios pueden acudir a nuestro sitio web para obtener el manual de usuario, o bien optar por recibir ayuda del equipo técnico.

SItio Web: shorturl.at/qzIT8

2.7 Suposiciones y dependencias

Dado que es un sitio web, se espera que el usuario cuente no solo con un navegador instalado en su dispositivo, sino también con una conexión a internet estable, esto con el objetivo de obtener el mejor desempeño posible.


Diagrama de casos de uso


3. Requisitos de interfaz externa

3.1 Interfaces de usuario


Cuando un usuario accede a la página  puede observar lo siguiente:

Previsualización de la página.



Como podemos ver el interfaz no ofrece muchas opciones y no es muy difícil de explicar, en la parte de arriba se puede observar un buscador, este buscador permite al usuario hacer un filtro de búsqueda escribiendo cualquier palabra o letra y este buscador encuentra cualquier coincidencia con cualquiera de los campos de mariposas (familia, subfamilia, tribu, género, especie o subespecie) y se muestran en pantalla.



Buscador de la página.



En la sección de abajo del buscador se puede observar un pequeño menú con pestañas como se muestra en la siguiente imagen:

Sub-páginas del sitio web.



En la sección (Todas las mariposas) usted podrá observar todos los ejemplares de mariposas que se encuentran en la página, la primera que usted observará es la última que se ha agregado (la más reciente) y se listan de la más actual hasta la más antigua. En la sección de clasificados usted como usuario podrá realizar un filtro un poco más específico para poder buscar los ejemplares de la página por los siguientes filtros (familia, subfamilia, tribu, género, especie o subespecie), una vez usted seleccione una familia le aparecen los ejemplares pertenecientes únicamente de esa familia, posteriormente usted puede hacer el uso de los siguientes filtros e ir viendo los ejemplares por un orden más específico.


Cabe destacar que las opciones de Administrador y salir son de uso exclusivo para los administradores de la página y usted no podrá acceder ni interactuar con esos apartados.

3.2 Interfaces de hardware

Considerando que estamos en un nuestro sitio web, debemos considerar que estamos trabajando con un navegador de internet , en el cual dispositivos como un teclado y un ratón están adaptados para poder trabajar, mientras que en dispositivos móviles está adaptado para funcionar de manera táctil.

La página ha sido diseñada para soportar los distintos dispositivos donde se accede a la red, por lo que esta misma ha sido diseñada de manera responsiva, esto quiere decir que independientemente del hardware que se ocupe para acceder a la página, la pantalla deberá adaptarse a cualquiera de estos dispositivos el rendimiento y diseño. 

3.3 Interfaces de software

Desde la primera versión, nuestro producto no ha sufrido ninguna modificación en cuanto a herramientas usadas, es decir, se utilizó el mismo lenguaje de programación, las mismas bases datos, el mismo motor de búsqueda, etc. Bases de datos como MySQL, lenguajes de programación orientados a desarrollo web, junto con todas sus herramientas son la base de todo nuestro producto.

Este producto fue realizado bajo el sistema operativo Windows, pero al tratarse de una página web, podrá funcionar en cualquier otro sistema operativo, ya sea de ordenador o de Smartphone (como Android o IOS).

Protocolos de interfaz de usuario han sido obtenidos en su mayoría gracias a las bibliotecas incluidas en el lenguaje de programación, ayudándonos a poder compartir información entre ambos componentes de la base de datos y el programa principal.

Los datos que se compartirán estarán relacionados con la información provista por el administrador, para ser más concretos, se verá involucrada la información de cada mariposa (Nombre, familia, clase, y clasificación superior) dependiendo de la cantidad y la variedad de mariposas que el administrador (nuestro cliente) desee agregar.

Solamente es necesario una comunicación entre la página y la base de datos para poder realizar el intercambio de datos. No es necesario depender de un sistema operativo que maneje y comparta la información en su totalidad. Mediante el ingreso de datos, el administrador podrá manipularlos a conveniencia, podrá (Editar, eliminar, buscar en la base de datos, o añadir más información); Haciendo que los datos se encuentren organizados en un solo lugar, y su manipulación sea lo más fácil, tanto para el usuario como para el ordenador.


3.4 Interfaces de comunicaciones

Para las pruebas de desarrollo de la página web Mariposas nosotros utilizamos localhost y XamPP, con éstas simulamos un dominio para poder hacer las pertinentes pruebas de desarrollo. 

Cuando la página web tenga un dominio se le asociará una dirección IP única, la cual es utilizada por el navegador. Cuando alguien ingresa el nombre de nuestro dominio en cualquier navegador, el sistema de nombre de dominio(DNS) se traduce en su dirección IP asociada, lo que permite al navegador ubicarlo y luego mostrar el sitio web a cualquier usuario que haga la búsqueda.

Para el cifrado y seguridad, dependerá del cliente ya que la compra del dominio en algunas ocasiones te ofrece el servicio de protección de privacidad con el que puede ocultar toda su información del entorno público. Sin embargo, la protección con la que la página cuenta aún sin un dominio es la parte administrativa, es decir, que cualquier modificación en la base de datos de la página es únicamente permitida al usuario que esté registrado como administrador. El administrador debe contar con el nombre de usuario y contraseña para hacer modificaciones. 




4. Características del sistema

4.0 Descripción de actores


Actor

Administrador

Descripción

El administrador es el responsable de los cambios que sufre la página.

Responsabilidades

  • Tiene la responsabilidad de agregar más ejemplares al gusto cuando él lo decida.

  • Comprobar que los datos que ingresa sean correctos de las mariposas y editar o cambiar tiempos según sean requeridos esos cambios.

Fuentes

https://www.butterfliesofamerica.com



Actor

Usuario

Descripción

Los usuarios pueden ver las mariposas y usar los filtros de búsqueda para tener un mejor acceso a la información.

Responsabilidades

  • Ninguna

Fuentes

https://www.butterfliesofamerica.com


4.1 Descripción de caso de uso: Iniciar sesión administrador.

Caso de uso: Iniciar sesión (administrador).

Fuentes

https://www.butterfliesofamerica.com

Actor

Administrador

Descripción

Para que un administrador agregue o modifique datos de los ejemplares, primero deberá loguearse para realizar estas acciones.

Flujo Básico

1.- El administrador entra en la página web y da clic en el botón del menú llamado Administrador.

2.- El sistema lo redirige a una subpágina donde aparece un formulario de dos campos, que son usuario y contraseña, acompañados de un botón enviar.

3.- El administrador deberá llenar correctamente esos campos y posteriormente da clic en el botón enviar.

4.- El sistema comprueba que los datos estén correctos y lo redirige a la pestaña administrador, donde este ya se encuentra logueado.

Flujos Alternos

3.1.- El sistema detecta que los datos ingresados no fueron correctos y manda una señal en pantalla que le indica al administrador que este no ha ingresado correctamente los datos

3.2.- El sistema redirige al administrador nuevamente al formulario.

Casos de uso de inclusión

N/A

Casos de uso de extensión

N/A

Notas

N/A


4.2 Descripción de caso de uso: Cerrar sesión administrador.

Caso de uso: Cerrar sesión (administrador).

Fuentes

https://www.butterfliesofamerica.com

Actor

Administrador

Descripción

Cuando un administrador finalice de hacer cambios en los ejemplares podrá cerrar la sesión que abrió.

Flujo Básico

1.- El administrador da clic en cerrar sesión.

2.- El sistema comprueba que efectivamente había una sesión previamente iniciada y cierra esa sesión

3.- El sistema redirige al administrador a la página de inicio

Flujos Alternos

2.1.- Si el sistema detectó que no había una sesión iniciada previamente redirige al formulario de inicio de sesión al administrador.

Casos de uso de inclusión

N/A

Casos de uso de extensión

Iniciar sesión de administrador.

Notas

N/A


4.3 Descripción de caso de uso: Agregar mariposa.

Caso de uso: Agregar Mariposa (administrador).

Fuentes

https://www.butterfliesofamerica.com

Actor

Administrador

Descripción

Cuando un administrador haya iniciado sesión podrá agregar más ejemplares para que aparezcan en la página.

Flujo Básico

1.- El administrador dá clic en la pestaña de administrador.

2.- El administrador dá clic en el botón agregar mariposa

3.- El sistema redirige al administrador a un formulario en donde se encuentran los siguientes campos a llenar: (familia, subfamilia, tribu, género, especie, subespecie).

4.- El administrador deberá de llenar bien los campos y dar clic en el botón de enviar.

5.- El sistema recupera esos datos y agrega una nueva mariposa a la página.

Flujos Alternos

N/A

Casos de uso de inclusión

N/A

Casos de uso de extensión

Iniciar sesión de administrador.

Notas

N/A


4.4 Descripción de caso de uso: Modificar Mariposa.

Caso de uso: Modificar Mariposa (administrador).

Fuentes

https://www.butterfliesofamerica.com

Actor

Administrador

Descripción

Cuando un administrador haya iniciado sesión podrá agregar más ejemplares para que aparezcan en la página.

Flujo Básico

1.- El administrador dá clic en la pestaña de administrador.

2.- El administrador dá clic en el botón editar mariposa

3.- El sistema redirigirá al administrador a una tabla donde se muestran todas las mariposas que están agregadas en la página web.

4.-El administrador localiza el ejemplar que desea editar y simplemente dá clic en el botón de la derecha de esa mariposa.

5.- El sistema redirige al administrador a el formulario de llenado de datos para agregar una mariposa, sin embargo este aparece con los datos de la mariposa que desea editar.

6.- El administrador llena los campos que desea editar y dá clic en agregar mariposa.

7.- El sistema guarda los cambios y redirige al administrador a la sección de agregar mariposa.

Flujos Alternos

N/A

Casos de uso de inclusión

N/A

Casos de uso de extensión

Iniciar sesión de administrador.

Notas

N/A


4.5 Descripción de caso de uso: Eliminar Mariposa.

Caso de uso: Eliminar Mariposa (administrador).

Fuentes

https://www.butterfliesofamerica.com

Actor

Administrador

Descripción

Cuando un administrador haya iniciado sesión podrá agregar más ejemplares para que aparezcan en la página.

Flujo Básico

1.- El administrador dá clic en la pestaña de administrador.

2.- El administrador deberá de dar click en el botón de eliminar mariposa.

3.- El sistema redirigirá al administrador a una tabla donde se muestran todas las mariposas que están agregadas en la página web.

4.-El administrador localiza el ejemplar que desea eliminar y simplemente dá clic en el botón de la derecha de esa mariposa.

5.- El sistema recupera los datos de esa mariposa y la elimina de  la base de datos y muestra en pantalla un mensaje que notifica al administrador que fue borrada con éxito. Posteriormente redirige al administrador a la sección de administración.

Flujos Alternos

N/A

Casos de uso de inclusión

N/A

Casos de uso de extensión

Iniciar sesión de administrador.

Notas

N/A


4.6 Descripción de caso de uso: Usar filtro de búsqueda.

Caso de uso: Filtro de búsqueda  (usuario).

Fuentes

https://www.butterfliesofamerica.com

Actor

Usuario

Descripción

El usuario podrá buscar por filtros las especies de la página

Flujo Básico

1.-El usuario dá clic en la pestaña Clasificados

2.- La pestaña muestra todas las especies, pero también muestra un select donde el usuario puede elegir un tipo de familia que exista en las especie.

3.- El usuario elige una familia y procede a dar clic en la familia que desea filtrar.

4.- El sistema ahora muestra únicamente los ejemplares que poseen esa familia y le muestra otro select al usuario pero ahora de subfamilias que poseen esa familia de mariposas.

5.- El usuario elige una subfamilia y procede a dar clic en la subfamilia que desea filtrar.

6.- El sistema ahora muestra únicamente los ejemplares que poseen esa subfamilia y le muestra otro select al usuario pero ahora de tribus que poseen esa subfamilia de mariposas.

7.- El usuario elige una tribu y procede a dar clic en la tribu que desea filtrar.

8.- El sistema ahora muestra únicamente los ejemplares que poseen esa tribu y le muestra otro select al usuario pero ahora de géneros que poseen esa tribu de mariposas.

9.- El usuario elige un género y procede a dar clic en el género que desea filtrar.

10.- El sistema ahora muestra únicamente los ejemplares que poseen ese género y le muestra otro select al usuario pero ahora de las especies que poseen ese género de mariposas.

11.- El usuario elige una especie y procede a dar clic en la especie que desea filtrar.

12.- El sistema ahora muestra únicamente los ejemplares que poseen esa especie y le muestra otro select al usuario pero ahora de subespecie que poseen esa especie de mariposas.

13.- El usuario elige una subespecie y procede a dar clic en la subespecie que desea filtrar.

14.- El sistema ahora muestra únicamente los ejemplares que poseen esa subespecie.

Flujos Alternos

1.1.- El usuario decide usar el filtro escrito de la página.

1.2.- El usuario escribe una palabra que desea filtrar y dá click en el botón buscar.

1.3.- El sistema filtra esa coincidencia de palabras de todos los campos (familia, subfamilia, tribu, género, especie, subespecie) y le muestra aquellos que tengan esa coincidencia.

Casos de uso de inclusión

N/A

Casos de uso de extensión

N/A

Notas

El filtro de buscar puede filtrar desde letras, hasta palabras completas.


4.7 Descripción de caso de uso: Ver todas las especies.

Caso de uso: Agregar Mariposa (administrador).

Fuentes

https://www.butterfliesofamerica.com

Actor

Usuario

Descripción

El usuario podrá ver todas las especies e imágenes que se hayan agregado a la página.

Flujo Básico

1.- El usuario ingresa a la página

2.- El usuario da clic en el botón de Todas las mariposas.

3.- El sistema redirige al usuario a la subpágina donde se ven todos los ejemplares.

Flujos Alternos

N/A

Casos de uso de inclusión

N/A

Casos de uso de extensión

N/A

Notas

N/A



VOPCs


Caso de uso (Iniciar sesión)


















Caso de uso (Cerrar sesión)















Caso de uso (Agregar Mariposa)
















Caso de uso (Modificar Mariposa)



















Caso de uso (Eliminar mariposa)



Caso de uso (Usar filtro de búsqueda)



Caso de uso (Ver todas las especies)


Comentarios