1

GA10-220501097-AA10-EV01
ELABORA DOCUMENTOS TÉCNICOS Y DE USUARIO DEL SOFTWARE

PAULA ANDREA GONZALEZ HERNANDEZ

Ficha 2627019

Instructor Técnico
Leonardo Lastra Salguero
Ingeniero de Sistemas
Especialista en Docencia Universitaria
Magister en Educación

SENA
Centro de Diseño y Metrología
Programa: Análisis y Desarrollo de Software ADSO
Bogota D.C
2024
 TABLA DE CONTENIDO 2

1. Introducción

2. Objetivo

3. Alcance

4. Términos y definiciones

5. Documento Tecnico y de usuario

6. Conclusiones
 3

1. INTRODUCCION

En el mundo actual, donde la tecnología avanza a pasos agigantados, la elaboración de

documentos técnicos y de usuario para el software se convierte en una pieza fundamental en el
proceso de desarrollo y utilización de programas informáticos.

Estos documentos no solo sirven como guía para los desarrolladores durante el ciclo de vida del
software, sino que también son esenciales para los usuarios finales, proporcionándoles la
información necesaria para comprender, utilizar y sacar el máximo provecho de las herramientas
digitales disponibles.

En esta era digital, la capacidad de crear documentos claros, precisos y comprensibles es crucial
para garantizar el éxito tanto en el desarrollo como en la adopción de software. En este contexto,
exploraremos la importancia, los elementos clave y las mejores prácticas en la elaboración de
documentos técnicos y de usuario del software.
 2. OBJETIVO 4

El Objetivo de este documento es brindar a una guía para la elaboración del manual técnico y de
operación para una solución de software, ilustrando sobre la definición, diseño, organización y
estructura al personal encargado de mantener la prestación del servicio.

3. ALCANCE

Este documento describe el contenido mínimo del manual técnico y de operación de los sistemas
de información da la tienda virtual Aluna siguiendo los lineamientos de Mintic.

4. TERMINOS Y DEFINCIONES

Este glosario ayudará a entender los términos, acrónimos y definiciones más usadas en el
presente documento:

Navegador Web: Es software utilizado para visualizar la información contenida en los sitios de
Internet.

Ciclo de vida de los Sistemas de Información: Ámbito del dominio de Sistemas de Información
del Marco de Referencia de Arquitectura TI de MINTIC que busca definir y gestionar las etapas
que deben surtir los Sistemas de Información desde la definición de requerimientos hasta el
despliegue, puesta en funcionamiento y uso.

Gestión de Sistemas de Información: procesos que permiten la administración del ciclo de vida
de la información, desde su origen hasta la disposición final.

Framework: Es un conjunto de prácticas y estándares estructurado que permiten la consecución

de objetivos siguiendo sus lineamientos como, por ejemplo: The Open Group Architecture
Framework (TOGAF), Information Technology Infrastructure Library (ITIL) Framework y .NET
Framework
Tienda virtual: Esté término hace referencia a la aplicación informática capaz de ofrecer acceso5
a productos donde estos se pueden comprar y pagar por mediación de cualquier medio
electrónico a través de la red. Donde se suelen dar servicios muy similares a los de una tienda
física.

Login: Es el nombre con el que se identifica a un usuario, que con anterioridad ha realizado un
proceso de registro, suele formarse con un código alfanumérico de varios dígitos. Dependiendo
de la aplicación se le pueden asignar distintos roles y accesos.

Password: palabra de paso o clave se acceso, permite el acceso a una persona, se le pueden
asignar permisos. Compuesta al igual que el login por un conjunto alfanumérico de varios dígitos.
Usuario anónimo: Usuario que visita el portal y del cual no se tiene información de registro.
Usuario registrado: Usuario que ha realizado el proceso de registro y por lo tanto se dispone de
información personal para identificarlo y personalizar su visita a la Web.
Servidor: Máquina que se encarga de ejecutar la aplicación para que los usuarios, clientes,
puedan acceder a recursos y páginas.
Cliente: Cualquier elemento de un sistema de información que requiere un servicio mediante el
envió de solicitudes al servidor.
Navegador: Aplicación para visualizar documentos WWW y navegar por Internet. En su forma
más básica son aplicaciones hipertexto que facilitan la navegación por los servidores de
navegación de Internet.
Protocolo: Conjunto de reglas y/o procedimientos para la transmisión de datos que ha de ser
observado por los dos extremos de un proceso comunicacional.
CSS: Cascading Style Sheets, hojas de estilo en cascada, es un lenguaje usado para definir la
presentación de un documento escrito en HTML o XML.
JavaScript: es un lenguaje de scripting basado en objetos no tipeado y liviano, utilizado para
acceder a objetos en aplicaciones, no requiere compilación.
UML: Unified Modeling Language, Lenguaje Unificado de Modelado, se trata de un lenguaje
gráfico para construir, documentar, visualizar y especificar un sistema software.
 DESARROLLO TEMÁTICO 6

5. MANUAL DE DOCUMENTO TECNICO Y DE USUARIO TIENDA VIRTUAL ALUNA

Descripción del proyecto

Nombre Pagina Web tienda virtual Aluna “Hecho a

Mano”
Objetivo Venta de artículo para el hogar y moda femenina

Propósito Vender artículos por internet en Colombia

Fecha Entrega 30/06/2024

Sigla Aluna

Versión 1.0

Categoria Portales Digitales

Fabricante Interactive Solutions

Fecha Vencimiento
Soporte
30/06/2025
Sistema Operativo
Funciona sobre multiplataforma
Arquitectura
WEB
Tecnologica
 Prerrequisitos de Instalación del Sistema: 7

 Sistema operativo compatible: Windows 10, macOS, Linux.

 Navegador web moderno (Google Chrome, Mozilla Firefox, Safari).
 Conexión a internet estable

Frameworks y Estándares:

 Framework utilizado: NodeJs

 Estándares de desarrollo: HTML5, CSS3, JavaScript. , react , express
 Base de datos: MongoDB Atlas
 Diagrama de casos de Uso 8

Escenario: Registrar

Escenario: Buscar producto

Escenario: identificarse 9

Escenario: Comprar producto

Escenario: alta categoría 10
El administrador una vez identificado, tiene la opción de introducir nuevas categorías en nuestro
catálogo de productos. Para ello introducirá el nombre de la nueva categoría y se realizará el alta
en nuestra base de datos.

Escenario: baja categoría.

Al igual que la operación de alta será el administrador el encargado de efectuar las bajas de
categorías. Se seleccionará la categoría que queremos borrar de nuestra base de datos y
pulsando el botón de eliminar efectuaremos la operación indicada.
Escenario: alta producto. 11

Nuestro administrador, tendrá la función de dar de alta productos, para realizar esta operación
deberá rellenar un pequeño formulario con el nombre del producto, precio, características

Escenario: Baja producto.

Esta operación consiste en seleccionar un producto y proceder a su eliminación de nuestra base

de datos.
Escenario: Listar usuarios registrados 12

Escenario: Eliminar usuario registrado

Escenario: listar pedidos 13

Escenario: Cambio estado pedido

MODELO ENTIDAD RELACIÓN DE LA BASE DE DATOS 14
 DIAGRAMA DE COMPONENTES 15

Alcance del Proyecto

Tecnologías a usar
Front Base de datos Back

Funcionalidades principales
1. Crud de usuarios en el Sistema con persistencia en la base de datos
2. Crud de productos
3. Boton de comprar que envia articulo al carrito del perfil que esta logueado
4. Opcion para poder dejar reviews en el productos
5. Control de existencias de inventario de prodcutos
6. Generación de orden de compra
7. Pasarela de pago
 16

Enrutamiento
 ARQUITECTURA MULTICAPA 17

Una arquitectura multicapa es un conjunto ordenado de subsistemas, cada uno de los cuales
está constituido en términos de los que tiene por debajo y proporciona la base de la
implementación de aquellos que están por encima de él.

Los objetos de cada capa suelen ser independientes, aunque suelen haber dependencias entre
objetos de distintas capas.

Existe una relación cliente/servidor entre las capas inferiores, que son las que proporcionan los
servicios, y las capas superiores, los usuarios de estos servicios.

El diseño de nuestra aplicación se basa en una arquitectura multicapa, más concretamente en

una arquitectura de tres capas:

- Capa de presentación, también conocida como interfaz gráfica, se encarga de la presentación

de los resultados al usuario y la recogida de información del usuario al sistema.

- Capa de negocio o lógica de la aplicación, proporciona la funcionalidad de la aplicación. Es el

encargado de realizar todas las operaciones a nivel aplicación.

- Capa de datos o persistencia, este nivel es el encargado de almacenar toda la información de

nuestra aplicación, además de asegurar el acceso a la información de una forma controlada y
segura. Este nivel lo forman la base de datos y el software de gestión de base de datos.
 18

CONCLUSIONES
La elaboración de documentos técnicos y de usuario es un proceso fundamental en el

desarrollo y la implementación exitosa de software. Estos documentos actúan como guías

esenciales tanto para los desarrolladores como para los usuarios finales.

Los documentos técnicos proporcionan una descripción detallada de la arquitectura,

funcionalidades y requisitos del software, facilitando la comprensión y el mantenimiento del

sistema a lo largo del tiempo.

Los documentos de usuario ofrecen instrucciones claras y concisas sobre cómo utilizar el

software, lo que permite a los usuarios aprovechar al máximo sus capacidades y

funcionalidades.

La calidad de los documentos técnicos y de usuario impacta directamente en la experiencia

del usuario y en la eficiencia del desarrollo de software. Es crucial invertir tiempo y esfuerzo

en su elaboración y mantenimiento.

La comunicación efectiva entre desarrolladores y usuarios, facilitada por estos documentos,

es fundamental para garantizar la satisfacción del cliente y el éxito del producto en el

mercado.

La evolución tecnológica y la diversificación de las plataformas de software plantean nuevos

desafíos en la elaboración de documentos, como la adaptación a diferentes dispositivos y

la inclusión de multimedia para una mejor comprensión.

En resumen, la elaboración cuidadosa de documentos técnicos y de usuario es un19

componente esencial en el desarrollo de software de calidad y en la creación de

experiencias positivas para los usuarios finales.