Vista previa del material en texto
AP09-AA10-EV03. ELABORACIÓN DEL MANUAL DE USUARIO Y MANUAL DE CONFIGURACIÓN DEL SISTEMA. EVIDENCIA EJEMPLO 2 TABLA DE CONTENIDO 1° INTRODUCCIÓN ......................................................................................... 3 2° OBJETIVO .................................................................................................. 4 3° CONVENCIONES ......................................................................................... 4 4° ESPECIFICACIONES TÉCNICAS .................................................................. 4 4.1 MÓDULO INICIAR SESIÓN .................................................................... 5 4.2 MÓDULO REGISTRO DE USUARIOS ...................................................... 5 4.3 MÓDULO REGISTRO DE CLIENTES ...................................................... 6 4.5 MODULO INGRESO DE PRODUCTOS ..................................................... 8 5° INGRESO A LA APLICACIÓN WEB............................................................. 10 5.1 REGISTRO DE USUARIOS ................................................................... 11 5.2 REGISTRO DE CLIENTES .................................................................... 16 5.3 REGISTRO DE PROVEEDORES ............................................................ 20 5.4 INGRESO DE PRODUCTOS .................................................................. 24 5.5 MOVIMIENTOS .................................................................................. 28 6° CONSIDERACIONES.................................................................................. 36 7° GLOSARIO................................................................................................ 36 EVIDENCIA EJEMPLO 3 MANUAL DEL USUARIO 1° INTRODUCCIÓN Este sistema de inventario es un software que nos permite obtener un adecuado manejo de la información, creando pautas para tener el control adecuado de las diferentes áreas del sistema como las son: inicio de sesión, registro de usuarios, registro de clientes, registro de proveedores, ingreso de productos y movimiento de entrada y salida de productos, a su vez clasificar todas aquellas operaciones del inventario del día a día para poder generar informes finales de forma oportuna y la verificación del funcionamiento de la empresa. Este sistema de inventario va orientado a dos esquemas, uno es el de entrada con despacho, orientado a empresas cuyas operaciones se realizan a través de despachos parciales en base a una orden de pedido. EVIDENCIA EJEMPLO 4 2° OBJETIVO El objetivo de este manual es el de brindar una comunicación técnica y asistencia a todos los usuarios que usaran el sistema de información, ademas de proporcionar la información necesaria para su utilización. 3° CONVENCIONES SDI: Acrónico que hace referencia al sistema de información (Sistema de Inventario). PHP: (acrónimo recursivo de PHP: Hypertext Preprocessor) es un lenguaje de código abierto muy popular especialmente adecuado para el desarrollo web y que puede ser incrustado en HTML XAMPP: es un paquete de software libre, que consiste principalmente en el sistema de gestión de bases de datos MySQL, el servidor web Apache y los intérpretes para lenguajes de script PHP y Perl. El nombre es en realidad un acrónimo: X (para cualquiera de los diferentes sistemas operativos), Apache, MariaDB/MySQL, PHP, Perl. HTML: siglas en inglés de HyperText Markup Language, hace referencia al lenguaje de marcado para la elaboración de páginas web. phpMyadmin: es el acrónimo usado para describir un sistema de infraestructura de Internet que usa las siguientes herramientas: Windows como sistema operativo; Apache, como servidor web; MySQL, como gestor de bases de datos; PHP, Perl, o Python, como lenguajes de programación. MySQL: es un sistema de gestión de bases de datos relacional desarrollado bajo licencia dual: Licencia pública general/Licencia comercial por Oracle Corporation y está considerada como la base de datos BBDD: Es el acrónico de base de datos, que es una colección de datos organizados y estructurados según un determinado modelo de información que refleja la relación entre ellos. 4° ESPECIFICACIONES TÉCNICAS SDI es una aplicación web que se desarrolló utilizando PHP (versión 7.4.1) lenguaje de scripting (lenguaje interpretado). Se requiere de un servidor web para alojar la aplicación. Hay diferentes paquetes de software que se pueden utilizar para ejecutar SDI como lo son XAMPP, WAMPSERVER por mencionar algunos. SDI se ejecuta sin modificaciones como, Linux, Windows, Mac Os y otros sistemas que EVIDENCIA EJEMPLO 5 soportan PHP, incluyendo la mayoría de proveedores de almacenamiento en internet. Los datos son almacenados en una sola base de datos MySQL (Lenguaje estructurado). Hace uso total de abstracción de la base de datos, para que los instaladores puedan elegir entre alguno de los diversos tipos de servidores de bases de datos (Oracle y Microsoft SQL server son dos ejemplos de sistemas administradores de datos). SDI se compone de 6 módulos que a continuación, haremos la descripción de cada uno de ellos, con base en los casos de uso del sistema: 4.1 MÓDULO INICIAR SESIÓN Caso de uso Iniciar Sesión Descripción Este Módulo se encarga de validar al usuario para entrar en el sistema con su respectivo usuario y contraseña Precondición El usuario debe estar registrado en el sistema, con su respectivo usuario y contraseña secuencia paso Acción 1 El sistema solicita usuario y contraseña. 2 El actor introduce usuario y contraseña. 3 El sistema confirma los datos. 4 El sistema lo envía al módulo principal Post condición El sistema deberá validar el usuario y contraseña, enviar mensajes de error o advertencia siempre y cuando los datos no sean correctos, posterior mente dar ingreso al módulo principal del sistema. Excepciones Acción El sistema comprueba la validez de los datos, si los datos no son correctos envía un mensaje al actor permitiéndole que lo corrija. 4.2 MÓDULO REGISTRO DE USUARIOS Caso de uso Registro de usuarios Descripción Este Módulo se encarga de hacer el registro de los diferentes usuarios, que harán uso del sistema de información. Dichos usuarios solo podrán ser registrados por el administrador del sistema de información. Precondición El usuario (administrador) debe estar registrado en el sistema, con su respectivo usuario y contraseña EVIDENCIA EJEMPLO 6 paso Acción Secuencia 1 El sistema solicita al usuario: Nombre, Correo, Usuario, Clave y tipo de Usuario. 2 El actor introduce los datos solicitados 3 El sistema confirma los datos. 4 El sistema registrara los datos correspondientes en la BBDD Post condición El sistema deberá validar los datos ingresados en el formulario, y posteriormente hacer el registro en la base de datos. Excepciones Acción El sistema comprueba la validez de los datos, si los datos son correctos envía un mensaje de validación al actor, de lo contrario envía un mensaje de error permitiéndole que lo corrija. 4.3 MÓDULO REGISTRO DE CLIENTES Caso de uso Registro de Clientes Descripción Este Módulo se encarga de hacer el registro o ingreso de los nuevos clientes, almacenando la información descrita en el ítem de entradas. Precondición Los usuarios que van a ser el registro deben a ver ingresado previamente al sistema y llenar todos los campos descritos en el formulario. secuencia paso Acción 1 El sistema solicita al usuario: Nit, Nombre, Teléfono, Dirección, Ciudad y Departamento. 2 El actor introduce los datos solicitados 3 El sistema confirma los datos. 4 El sistema registrara los datos correspondientes en la BBDDPost condición El sistema deberá validar los datos ingresados en el formulario, y posteriormente hacer el registro en la base de datos. Excepciones Acción El sistema comprueba la validez de los datos, si los datos son correctos envía un mensaje de validación al actor, de lo contrario envía un mensaje de error permitiéndole que lo corrija. EVIDENCIA EJEMPLO 7 4.4 MODULO REGISTRO DE PROVEEDORES Caso de uso Registro de Proveedores Descripción Este Módulo se encarga de hacer el registro o ingreso de los nuevos Proveedores, almacenando la información descrita en el ítem de entradas. Precondición Los usuarios que van a ser el registro deben a ver ingresado previamente al sistema y llenar todos los campos descritos en el formulario. secuencia paso Acción 1 El sistema solicita al usuario: Nit, Proveedor, Contacto, Teléfono, Dirección, Ciudad, Departamento y Correo. 2 El actor introduce los datos solicitados 3 El sistema confirma los datos. 4 El sistema registrara los datos correspondientes en la BBDD Post condición El sistema deberá validar los datos ingresados en el formulario, y posteriormente hacer el registro en la base de datos. Excepciones Acción El sistema comprueba la validez de los datos, si los datos son correctos envía un mensaje de validación al actor, de lo contrario envía un mensaje de error permitiéndole que lo corrija. EVIDENCIA EJEMPLO 8 4.5 MODULO INGRESO DE PRODUCTOS Caso de uso Ingreso de Productos Descripción Este Módulo se encarga de hacer el registro o ingreso de los nuevos Productos, almacenando la información descrita en el ítem de entradas. Precondición Los usuarios que van a ser el registro deben a ver ingresado previamente al sistema y llenar todos los campos descritos en el formulario. secuencia paso Acción 1 El sistema solicita al usuario: Producto, Proveedor, Cantidad, Precio Unitario y Total. 2 El actor introduce los datos solicitados 3 El sistema confirma los datos. 4 El sistema registrara los datos correspondientes en la BBDD Post condición El sistema deberá validar los datos ingresados en el formulario, y posteriormente hacer el registro en la base de datos. Excepciones Acción El sistema comprueba la validez de los datos, si los datos son correctos envía un mensaje de validación al actor, de lo contrario envía un mensaje de error permitiéndole que lo corrija. EVIDENCIA EJEMPLO 9 4.6 MODULO DE GENERAR MOVIMIENTO Caso de uso Generar Entrada Descripción Este es el Módulo encargado de generar una entrada de productos a sí mismo como las órdenes de compra Precondición Los usuarios que van a ser la entrada deben a ver ingresado previamente al sistema. secuencia pasos Acción 1 El sistema solicita al usuario: Nombre del producto, cantidad del producto, Precio Unitario, Total y Proveedor. 2 El actor introduce los datos solicitados 3 El sistema confirma los datos. 4 El sistema registrara la entrada. Post condición El sistema deberá validar los datos ingresados en los formularios, y posteriormente hacer el registro de la entrada. Excepciones Acción El sistema comprueba la validez de los datos, si los datos son correctos envía un mensaje de validación al actor, de lo contrario envía un mensaje de error permitiéndole que lo corrija. Caso de uso Generar Salida Descripción Este es el Módulo encargado de generar una salida de productos a sí mismo como las órdenes de compra Precondición Los usuarios que van a ser la salida deben a ver ingresado previamente al sistema. secuencia pasos Acción 1 El sistema solicita al usuario: Nombre del producto, cantidad del producto y Cliente. 2 El actor introduce los datos solicitados 3 El sistema confirma los datos. 4 El sistema registrara la salida. Post condición El sistema deberá validar los datos ingresados en los formularios, y posteriormente hacer el registro de la salida. Excepciones Acción El sistema comprueba la validez de los datos, si los datos son correctos envía un mensaje de validación al actor, de lo contrario envía un mensaje de error permitiéndole que lo corrija. EVIDENCIA EJEMPLO 10 5° INGRESO A LA APLICACIÓN WEB Ingresamos al módulo de apertura al aplicativo, digitamos el usuario y contraseña, posteriormente damos click en el botón INGRESAR Una vez hecho esto, el sistema nos dará ingreso a su Modulo principal donde tendremos todo el menú de opciones del sistema Una vez en el módulo principal tendremos acceso a las siguientes funcionalidades: EVIDENCIA EJEMPLO 11 5.1 REGISTRO DE USUARIOS Para hacer el registro de un nuevo USUARIO colocamos el cursor sobre el ítem de USUARIOS del módulo principal, se nos despliegan dos opciones damos clic sobre NUEVO USUARIO. Posteriormente se nos despliega el formulario con los datos correspondientes al nuevo usuario el cual debemos diligenciar. EVIDENCIA EJEMPLO 12 Cómo se puede observar en la ilustración, en el ítem Tipo Usuario se nos despliega tres opciones (Administrador, Operador, Vendedor). Administrador: Tiene acceso a la totalidad del sistema Operador: Tiene acceso a las opciones de CLIENTES, PRODUCTOS, VENTAS Vendedor: Tiene acceso a las opciones de CLIENTES, VENTAS Debemos seleccionar la opción de acuerdo con el tipo de usuario que estamos registrando. Posteriormente damos clic en GUARDAR Posteriormente el sistema comprueba la validez de los datos y nos envía la notificación de que el usuario se ha creado correctamente. EVIDENCIA EJEMPLO 13 De lo contrario, si los datos no son correctos envía un mensaje al actor permitiéndole que lo corrija. EVIDENCIA EJEMPLO 14 Para cerciorarnos que nuestro usuario quedo registrado nos dirigimos al ítem de USUARIOS opción LISTA DE USUARIOS. EVIDENCIA EJEMPLO 15 Posteriormente nos saldrá una pantalla como la que veremos a continuación, con todos los USUARIOS que hemos registrado en el sistema con su respectiva información. Como se puede observar en este ítem LISTA DE USUARIOS tenemos las opciones de EDITAR, ELIMINAR O BUSCAR un usuario. EVIDENCIA EJEMPLO 16 5.2 REGISTRO DE CLIENTES Para hacer el registro de un nuevo CLIENTE colocamos el cursor sobre el ítem de CLIENTES del módulo principal se nos despliegan dos opciones damos click sobre NUEVO CLIENTE Posteriormente se nos despliega el formulario con los datos correspondientes al NUEVO CLIENTE el cual debemos diligenciar. EVIDENCIA EJEMPLO 17 Posteriormente damos click en GUARDAR Posteriormente el sistema comprueba la validez de los datos y nos envía la notificación de que el CLIENTE se ha creado correctamente. EVIDENCIA EJEMPLO 18 De lo contrario, si los datos no son correctos envía un mensaje al actor permitiéndole que lo corrija. EVIDENCIA EJEMPLO 19 Para cerciorarnos que nuestro CLIENTE quedo registrado nos dirigimos al ítem de CLIENTES opción LISTA DE CLIENTES Posteriormente nos saldrá una pantalla como la que veremos a continuación, con todos los CLIENTES que hemos registrado en el sistema con su respectiva información. EVIDENCIA EJEMPLO 20 Como se puede observar en este ítem de LISTA DE CLIENTES tenemos las opciones de EDITAR, ELIMINAR O BUSCAR un CLIENTE. 5.3 REGISTRO DE PROVEEDORES Para hacer el registro de un nuevo PROVEEDOR colocamos el cursor sobre el ítem de PROVEEDORES del módulo principal se nos despliegan dos opciones damos click sobre NUEVO PROVEEDOR. EVIDENCIA EJEMPLO 21 Posteriormentese nos despliega el formulario con los datos correspondientes al nuevo PROVEEDOR el cual debemos diligenciar. Posteriormente damos click en GUARDAR. Posteriormente el sistema comprueba la validez de los datos y nos envía la notificación de que el usuario se ha creado correctamente. EVIDENCIA EJEMPLO 22 De lo contrario, si los datos no son correctos envía un mensaje al actor permitiéndole que lo corrija. Para cerciorarnos que nuestro usuario quedo registrado nos dirigimos al ítem de PROVEEDORES opción LISTA DE PROVEEDORES. EVIDENCIA EJEMPLO 23 Posteriormente nos saldrá una pantalla como la que veremos a continuación, con todos los PROVEEDORES que hemos registrado en el sistema con su respectiva información. EVIDENCIA EJEMPLO 24 Como se puede observar en este ítem LISTA DE PROVEEDORES tenemos las opciones de EDITAR, ELIMINAR O BUSCAR un PROVEEDOR. 5.4 INGRESO DE PRODUCTOS Para hacer el registro de un nuevo PRODUCTO colocamos el cursor sobre el ítem de PRODUCTOS del módulo principal se nos despliegan dos opciones, damos click sobre NUEVO PRODUCTO. EVIDENCIA EJEMPLO 25 Posteriormente se nos despliega el formulario con los datos correspondientes al nuevo PRODUCTO el cual debemos diligenciar. Posteriormente damos click en GUARDAR PRODUCTO. De lo contrario, si los datos no son correctos envía un mensaje al actor permitiéndole que lo corrija. EVIDENCIA EJEMPLO 26 Para cerciorarnos que nuestro usuario quedo registrado nos dirigimos al ítem de PRODUCTOS opción LISTA DE PRODUCTOS. Posteriormente nos saldrá una pantalla como la que veremos a continuación, con todos los PRODUCTOS que hemos registrado en el sistema con su respectiva información. EVIDENCIA EJEMPLO 27 Como se puede observar en este ítem LISTA DE PRODUCTOS tenemos las opciones de EDITAR, ELIMINAR, O BUSCAR un PRODUCTO. EVIDENCIA EJEMPLO 28 5.5 MOVIMIENTOS Para hacer el registro de un nueva ENTRADA colocamos el cursor sobre el ítem de MOVIMIENTOS del módulo principal se nos despliegan dos opciones, damos click sobre ENTRADA. Posteriormente se nos despliega el listado de entradas que hemos registrado en el sistema con su respectiva información y daremos click en el botón CREAR ENTRADA. EVIDENCIA EJEMPLO 29 Posteriormente se nos despliega el formulario con los datos correspondientes la nueva entrada el cual debemos diligenciar. Posteriormente damos click en AGREGAR. Al dar click en agregar se nos irán agregando los productos con su respectiva información en la tabla del lado derecho de la pantalla. EVIDENCIA EJEMPLO 30 Una vez agregados todos los productos posteriormente daremos click en el botón CONTINUAR ENTRADA Posteriormente se nos despliega el formulario con los nombres de los proveedores registrados en el sistema el cual debemos diligenciar o escoger uno según el cual tenga la entrada que se está registrando. EVIDENCIA EJEMPLO 31 Posteriormente damos click en GUARDAR. EVIDENCIA EJEMPLO 32 Para hacer el registro de un nueva SALIDA colocamos el cursor sobre el ítem de MOVIMIENTOS del módulo principal se nos despliegan dos opciones, damos click sobre SALIDA. Posteriormente se nos despliega el listado de salidas que hemos registrado en el sistema con su respectiva información y daremos click en el botón CREAR SALIDA. EVIDENCIA EJEMPLO 33 Posteriormente se nos despliega el formulario con los datos correspondientes la nueva salida el cual debemos diligenciar. Posteriormente damos click en AGREGAR. Al dar click en agregar se nos irán agregando los productos con su respectiva información en la tabla del lado derecho de la pantalla. EVIDENCIA EJEMPLO 34 Una vez agregados todos los productos posteriormente daremos click en el botón CONTINUAR SALIDA. EVIDENCIA EJEMPLO 35 Posteriormente se nos despliega el formulario con los nombres de cliente registrados en el sistema el cual debemos diligenciar o escoger uno según el cual tenga la salida que se está registrando. Posteriormente damos click en GUARDAR. EVIDENCIA EJEMPLO 36 6° CONSIDERACIONES Como aclaratoria cabe mencionar que este software vine inicialmente con una clave genérica de administrador, que será suministrada por el desarrollador del sistema, el administrador final podrá personalizar su usuario y contraseña, una vez el administrador personalicé su clave podrá realizar la asignación de los diferentes tipos de usuarios que admite el sistema, como lo son: Administrador, Operador o Vendedor 7° GLOSARIO Web: Web es un vocablo inglés que significa “red”, “telaraña” o “malla”. El concepto se utiliza en el ámbito tecnológico para nombrar a una red informática y, en general, a Internet (en este caso, suele escribirse como Web, con la W mayúscula). Usuario: En informática, un usuario es una persona que utiliza una computadora o un servicio de red. Los usuarios de sistemas informáticos y productos de software generalmente carecen de la experiencia técnica necesaria para comprender completamente cómo funcionan. Software: Se conoce como software al soporte lógico de un sistema informático, que comprende el conjunto de los componentes lógicos necesarios que hacen posible la realización de tareas específicas, en contraposición a los componentes físicos que son llamados hardware. Software Libre: El software libre es todo software cuyo código fuente puede ser estudiado, modificado, y utilizado libremente con cualquier fin y redistribuido con cambios y/o mejoras o sin ellas. Hardware: La palabra hardware en informática se refiere a las partes físicas, tangibles, de un sistema informático, sus componentes eléctricos, electrónicos, electromecánicos y mecánicos. Codigo Fuente: es el archivo o archivos con las instrucciones necesarias, realizadas en un lenguaje de programación, que sirve para compilar posteriormente un programa o programas para que puedan ser utilizados por el usuario de forma directa, tan sólo ejecutándolo. Codigo Abierto: El código abierto es un modelo de desarrollo de software basado en la colaboración abierta. Se enfoca más en los beneficios prácticos que en cuestiones éticas o de libertad que tanto se destacan en el software libre. Para muchos el término «libre» hace referencia al hecho de adquirir un software de manera gratuita. Manual de usuario: es un documento de comunicación técnica destinado a dar asistencia a las EVIDENCIA EJEMPLO 37 personas que utilizan un sistema en particular. Servidor Apache: El servidor HTTP Apache es un servidor web HTTP de código abierto, para plataformas Unix, Microsoft Windows, Macintosh y otras, que implementa el protocolo HTTP/1.1 y la noción de sitio virtual según la normativa RFC 2616. Leguaje de Script: es un pequeño lenguaje de programación cuyo código se inserta dentro del documento HTML. Este código se ejecuta en el navegador del usuario al cargar la página, o cuando sucede algo especial como puede ser el pulsar sobre un enlace. Windows: es el nombre de una familia de distribuciones de software para PC, teléfonos inteligentes, servidores y sistemas empotrados, desarrollados y vendidos por Microsoft y disponibles para múltiples arquitecturas, tales como x86, x86-64 y ARM. Sistema de Información: es un conjunto de datos que interactúan entre sí con un fin común. En informática, los sistemas de información ayudan a administrar, recolectar, recuperar, procesar, almacenar y distribuir información relevante para los procesos fundamentales y las particularidades de cada organización. EVIDENCIA EJEMPLO
