gres

Versión Elaborada por Revisada por Aprobada por Fecha

1.0 Edgar Meneses Ender Ceballos Jhonattan Rivera 23/08/2022
(Analista Funcional) (Project Manager) (CEO)

DOCUMENTACIÓN TÉCNICA
PROYECTO KIMI
VERSIÓN 1.0

Tabla de contenido
SECCIÓN 1. Introducción 4
1.1. Objetivos 4
1.2. Alcance 4
1.3. Responsables 4
1.4. Documentos de referencia 4
1.5. Definiciones y abreviaturas 4
1.6. Requisitos para el registro de usuarios 4
1.7. Requisitos para el registro de publicaciones 6
SECCIÓN 2. Requerimientos funcionales 8
2.1. Procedimiento de registro de usuarios 8
 2.1.1. Flujo de eventos 8
2.1.2. Excepciones 9
2.1.3. Diagrama del proceso de registro de usuarios 10
2.2. Procedimiento de gestión de usuarios 11
2.2.1. Flujo de eventos 11
2.2.2. Excepciones 11
2.2.3. Diagrama del proceso de gestión de usuarios 12
2.3. Procedimiento de registro de publicaciones 13
2.3.1. Flujo de eventos 13
2.3.2. Excepciones 14
2.3.3. Diagrama del proceso de registro de publicaciones 15
2.4. Procedimiento de gestión de publicaciones. 16
2.4.1. Flujo de eventos. 16
2.4.2. Excepciones. 17
2.4.3. Diagrama del proceso de gestión de publicaciones 18
2.5. Procedimiento de gestión de estado de las publicaciones. 19
2.5.1. Flujo de eventos. 19
2.5.2. Excepciones. 19
2.5.3. Diagrama del proceso de gestión de estado de las publicaciones. 20
2.6. Procedimiento de recuperación de contraseña. 21
2.6.1. Procedimiento de recuperación de contraseña. 21
2.6.2. Excepciones 22
2.6.3. Diagrama del proceso de mantenimiento de publicaciones. 23
SECCIÓN 4. Procesos para la integración 24
SECCIÓN 5. Tablas relacionadas 24
5.1. Relación de la Tabla 24
5.2. Diccionario de datos 24
SECCIÓN 6. Validaciones - BackEnd 24
SECCIÓN 7. Pruebas 25

2
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

SECCIÓN 1. Introducción

1.1. Objetivos
Los objetivos del presente documento son:
● Establecer los criterios de creación y verificación de los usuarios del
sistema.
● Establecer los criterios de creación y verificación de las publicaciones
generadas por los negocios.
● Presentar las validaciones y requerimientos esenciales para que el flujo
de registro de usuarios se realice correctamente.
● Presentar las validaciones y requerimientos esenciales para que el flujo
de registro de publicaciones funcione correctamente.
● Establecer los criterios para la recuperación de contraseña.

● Establecer los criterios para el mantenimiento de publicaciones.

● Establecer los criterios para el mantenimiento de usuarios.

1.2. Alcance
El alcance del presente documento comprende:
● El registro de criterios, validaciones y requerimientos necesarios para
el correcto registro de usuarios en el sistema.
● El registro de criterios, validaciones y requerimientos necesarios para
el correcto registro de las publicaciones de los usuarios negocio en el
sistema.

1.3. Responsables
● Project Manager

● Desarrollador de FrontEnd

● Desarrollador de Backend

● Analista Funcional

● Administrador bases de datos

● Analista QA

1.4. Documentos de referencia

● Casos de uso de negocio

1.5. Definiciones y abreviaturas

Landing Page
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

Página de destino, se trata de cada una de las páginas de aterrizaje

donde se dirigen los diferentes enlaces y campañas de publicidad.

Marketplace
Plataformas de venta online de terceros puestos a disposición de
particulares y empresas para vender allí sus productos sin necesidad
de disponer de una tienda online propia.

Merchant
Comerciante, esto es, cada uno de los vendedores que encontramos
habitualmente en una tienda online o marketplace.

Caché
Es un tipo de memoria informática que almacena datos de los usuarios
para que los futuros requerimientos a esos datos puedan ser servidos
más rápidamente.

Checkout
Se trata del último paso en el ecommerce, donde se completa el
pedido con el registro los y se efectúa el pago. Es un paso crítico
porque es donde se va a determinar si se realiza o no la conversión.

HTTPS
(Hypertext Transfer Protocol Secure) Es una combinación del protocolo
HTTP y una encriptación de seguridad (SSL) que se emplea para
lograr conexiones más seguras, muy útil para transacciones de pagos
y otras informaciones sensibles. Un imprescindible para tu tienda
online.

Geolocalización
Consiste en el conocimiento de la ubicación geográfica de
usuarios/clientes para poder aprovechar esta información para ofrecer
contenidos de una manera más segmentada.

Responsive
Se trata de un diseño web adaptativo que muestra una página
diferente en función del dispositivo y las características del mismo
desde el que se abre. Es de vital importancia para el m-commerce.

SSL (Secure Socket Layer)

Sistema de seguridad que encripta la información antes de enviarla
para evitar que sniffers u otros recursos puedan leerla. Garantiza una
alta seguridad en las transacciones a través de la red.

UX
User Experience o la experiencia del usuario se refiere a lo que un
usuario experimenta al navegar por una web o al interactuar con una
aplicación y a cómo optimizarla para conseguir los mejores resultados.

API (Application Programming Interfaces)

Entornos de programación de aplicaciones. Son conjuntos de
funciones y algoritmos ofrecidos por los programadores para que

4
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

puedan ser utilizados por otros como base para la creación de nuevas
aplicaciones o códigos.

1.6. Requisitos para el registro de usuarios

a) Visitar la página web de KIMI.

b) Tener un número de celular para la validación por SMS.

c) Para el registro del usuario negocio, se debe contar con un usuario

cliente que por defecto es el que se crea al registrarse.

d) Para el usuario del negocio, se debe contar con un nombre de negocio,

al menos 3 productos a rentar.

Foto 1 Landing page.

5
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

Foto 2 Formulario de registro.

Foto 3 Formulario de registro de usuario negocio.

6
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.7. Requisitos para el registro de publicaciones

a) El usuario debe estar logueado en el sistema.

b) El usuario debe haber sido confirmado por el administrador del sistema.

c) El usuario debe tener un perfil de negocio verificado.

d) Contar con al menos 3 fotografías del producto a rentar.

1.1.1.

7
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

Foto 4 Paso 1 del proceso de publicación de producto.

1.1.2.

Foto 5 Paso 2 del proceso de publicación de producto.

8
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

SECCIÓN 2. Requerimientos funcionales

El proceso de creación de usuarios consiste en los requisitos y validaciones que se deben
cumplir para que un cliente pueda ser registrado como un usuario cliente y posteriormente
cambie a un usuario negocio.

1.8. Procedimiento de registro de usuarios

El proceso de registro de usuarios consiste en los requisitos y validaciones que se

deben cumplir para que un cliente pueda ser registrado como un usuario cliente y
posteriormente cambie a un usuario negocio.

1.1.1. Flujo de eventos

a) El proceso de registro de usuario inicia cuando el usuario ingresa a la
página web de KIMI e intenta registrarse.

b) El sistema enviará un SMS al número de celular que registró para confirmar

el registro.

c) Una vez confirmado el registro, el sistema le asignará por defecto un

usuario cliente.

d) El sistema muestra una vista en la que presenta una opción para cliente
(sin activar por el momento) y otra para negocio.

e) El usuario selecciona la opción negocio y registra la información solicitada.

f) El administrador recibe una alerta de creación y tiene la posibilidad de

aceptar o rechazar el registro del nuevo negocio.

g) En caso el usuario negocio sea rechazado ocurrirá lo siguiente:

I. El usuario del negocio queda registrado en la base de datos con

un estado bloqueado.
II. Se enviará una notificación al usuario (por correo electrónico o por
el sistema).
III. Se actualiza el listado de usuarios a la vista del administrador.

h) En caso el administrador del sistema acepte al negocio, ocurrirá lo

siguiente:

I. El usuario negocio queda registrado en la base de datos con un

estado activo.
II. Se enviará una notificación al usuario (por correo electrónico o por
el sistema).
III. El negocio puede empezar a crear publicaciones.

9
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.1.2. Excepciones
a) Debe ingresar un número de celular válido.

b) Debe confirmar el código de verificación.

c) La contraseña debe contener una combinación de letras, números y

caracteres. Debe combinar mayúsculas y minúsculas. Debe ser mayor a 8
caracteres.

d) Debe ingresar ID documento válido.

e) Debe ingresar un correo electrónico válido.

f) Código de verificación válido.

g) Debe ser confirmado por el administrador.

10
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.1.3. Diagrama del proceso de registro de usuarios

11
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.9. Procedimiento de gestión de usuarios

El proceso de gestión de usuarios consiste en los requisitos y validaciones que se

deben cumplir para que un cliente o negocio pueda actualizar su perfil de usuario.

1.1.4. Flujo de eventos

a) El proceso de gestión de usuario inicia cuando el usuario registrado inicia
sesión.

b) El sistema mostrará un panel de control con ciertas opciones.

c) El usuario ingresa a la sección perfil.

d) El sistema muestra al usuario los campos que fueron previamente

registrados en la creación de usuario.

e) El usuario modifica o agrega información y tiene la opción de registrar estos

cambios.

f) Si el usuario cancela estos cambios, el sistema redirigirá a la vista de inicio

del panel de control.

g) En caso el usuario acepte los cambios sucederá lo siguiente:

I. El sistema valida los campos actualizados.

II. El sistema actualiza el usuario en la base de datos.
III. Se muestra una ventana emergente con el texto ‘Usuario
actualizado’ y el sistema redirige al usuario a la vista por defecto
del panel de control.

1.1.5. Excepciones
a) Debe ingresar un correo electrónico válido.

b) La contraseña debe contener una combinación de letras, números y

caracteres. Debe combinar mayúsculas y minúsculas. Debe ser mayor a 8
caracteres.

c) Debe ingresar ID documento válido.

d) Debe ingresar un correo electrónico válido.

12
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.1.6. Diagrama del proceso de gestión de usuarios

13
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.10. Procedimiento de registro de publicaciones

El proceso de registro de publicaciones consiste en los requisitos y validaciones que se

deben cumplir para que un cliente negocio pueda registrar publicaciones de sus
productos en renta.

1.10.1. Flujo de eventos

a) El proceso de registro de publicaciones inicia cuando el usuario negocio

ingresa a la página web de KIMI e intenta publicar un producto.

b) El sistema mostrará una vista con las categorías de producto que puede
elegir.

c) Luego de seleccionar una categoría, el usuario negocio deberá rellenar los

campos obligatorios y agregar por lo menos 3 fotografías del producto.

d) Luego de crear la publicación, el sistema enviará una notificación al

administrador del sistema.

e) El administrador ingresará a la vista del listado de publicaciones y podrá

aceptar o rechazar la publicación.

f) En caso el administrador no acepte la publicación, ocurrirá lo siguiente:

I. La publicación queda registrada en el sistema con un estado de

“bloqueado”.
II. Se enviará una notificación al usuario negocio (por correo
electrónico o por el sistema) con los detalles.
III. Se actualiza el listado de publicaciones en la vista del
administrador.

g) En caso el administrador del sistema acepte la publicación, ocurrirá lo

siguiente:

I. La publicación queda registrada en la base de datos con un estado

activo.
II. Se enviará una notificación al usuario negocio (por correo
electrónico o por el sistema).

14
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.10.2. Excepciones

a) El usuario debe ser verificado por el administrador.

b) Debe ingresar un nombre de negocio.

c) Debe seleccionar una categoría.

d) Debe ingresar un código postal válido.

e) Debe ingresar al menos 3 productos principales.

f) Debe seleccionar un área de servicio.

g) Debe aceptar los términos y condiciones

h) La publicación debe ser verificada por el administrador.

15
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.10.3. Diagrama del proceso de registro de publicaciones

16
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.11. Procedimiento de gestión de publicaciones.

El proceso de gestión de publicaciones consiste en los requisitos y validaciones que se

deben cumplir para que un cliente negocio pueda registrar publicaciones de sus
productos en renta.

1.11.1. Flujo de eventos.

a) El proceso de edición de publicaciones inicia cuando el usuario negocio o

administrador ingresa a la página web de KIMI.

b) El sistema mostrará un panel de control con ciertas opciones.

c) El usuario negocio/administrador selecciona la opción ‘publicaciones’.

d) El sistema muestra un listado con todas las publicaciones y en una

columna presenta el icono para editar.

e) El usuario negocio/administrador ingresa a la vista para editar la

publicación, el sistema muestra un modal con los distintos campos que
puede modificar.

f) En caso el usuario negocio/administrador cancele el modal editar, ocurrirá

lo siguiente:

I. No se guardan ningún cambio.

II. El sistema muestra el listado de publicaciones.

g) En caso el usuario negocio/administrador del sistema acepte los cambios,

ocurrirá lo siguiente:

I. Los cambios quedan registrados en el sistema.

II. El sistema muestra una ventana emergente con el mensaje
‘publicación actualizada’.
III. El sistema actualiza el listado de publicaciones y lo muestra en el
listado.

17
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.1.3. Excepciones.
a) Debe ser un usuario de negocio activo o administrador.

b) Debe ingresar un nombre de negocio.

c) Debe seleccionar una categoría.

d) Debe ingresar un código postal válido.

e) Debe ingresar al menos 3 productos principales.

f) Debe seleccionar un área de servicio.

g) La publicación debe ser verificada por el administrador en caso su estado

actual sea “bloqueado”.

18
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.11.2. Diagrama del proceso de gestión de publicaciones

19
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.12. Procedimiento de gestión de estado de las publicaciones.

El proceso de gestión de estado de las publicaciones consiste en los requisitos y

validaciones que se deben cumplir para que el estado de una publicación cambie de
activado a desactivado y viceversa.

1.12.1. Flujo de eventos.

a) El proceso de gestión de estado de las publicaciones inicia cuando el

usuario negocio o administrador ingresa a la página web de KIMI.

b) El sistema mostrará un panel de control con ciertas opciones.

c) El usuario negocio/administrador selecciona la opción ‘publicaciones’.

d) El sistema muestra un listado con todas las publicaciones y en una

columna con nombre A/D muestra un switch que permite activar/desactivar
la publicación.

e) El usuario negocio/administrador presiona el switch.

f) El estado de la publicación cambia dependiendo de su estado actual:

I. Si la publicación se encuentra activa cambia a desactivada.

II. Si la publicación se encuentra desactivada cambia a activa.

g) El sistema actualiza el listado y muestra una ventana emergente con el

texto ‘Publicación activada/desactivada’.

1.12.2. Excepciones.

a) Debe ser un usuario negocio activo o administrador.

b) La publicación debe estar verificada.

20
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.12.3. Diagrama del proceso de gestión de estado de las publicaciones.

21
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.13. Procedimiento de recuperación de contraseña.

El proceso de recuperación de contraseña consiste en los requisitos y validaciones que

se deben cumplir para que un usuario pueda recuperar su contraseña.

1.13.1. Procedimiento de recuperación de contraseña.

a) El proceso de edición de publicaciones inicia cuando el usuario ingresa a la

página web de KIMI.

b) El usuario selecciona la opción “Recuperar contraseña”.

c) El usuario ingresa su número de celular con el que se registró.

d) El sistema valida el número y envía un sms con el código de validación

autogenerado.

e) El sistema muestra una vista con un campo para colocar el código enviado.

f) El usuario ingresa el número y puede ocurrir lo siguiente:

I. El código es incorrecto y el sistema genera un mensaje con el

texto” código incorrecto, por favor vuelva a ingresar el código de
seguridad”.
II. El código es correcto y el sistema muestra una vista con dos
campos para generar una nueva contraseña.

g) El usuario ingresa su contraseña en el primer campo y la vuelve a escribir

en el segundo campo.

h) El sistema valida que ambas contraseñas sean iguales y cumpla los

requerimientos, luego envía un mensaje informativo al correo electrónico
del usuario y muestra al usuario la vista del panel de control.

22
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.13.2. Excepciones

a) Debe ingresar un número registrado.

b) Debe ingresar un número activo.

c) Debe ingresar el código de verificación.

d) Debe ingresar una nueva contraseña.

h) La contraseña debe contener una combinación de letras, números y

caracteres. Debe combinar mayúsculas y minúsculas. Debe ser mayor a 8
caracteres.

i) Debe repetir la contraseña.

23
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

1.13.3. Diagrama del proceso de mantenimiento de publicaciones.

24
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

SECCIÓN 4. Procesos para la integración

SECCIÓN 5. Tablas relacionadas

5.1. Relación de las Tablas

25
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

5.2. Diccionario de datos

26
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

SECCIÓN 6. Validaciones - BackEnd

27
 DOCUMENTACIÓN TÉCNICA
Proyecto Kimi

SECCIÓN 7. Pruebas

28