Please enable JavaScript.
Coggle requires JavaScript to display documents.
Manual técnico de aplicación - Coggle Diagram
Manual técnico de aplicación
Manual de usuario
El manual de usuario busca explicar cada una de las operaciones que se pueden realizar en la aplicación. Es un manual ilustrativo que se construye de tal manera que sea fácil comprensión para los usuarios finales de la aplicación
Componentes
Algunos de los ítems que se deben relacionar en este manual se muestran:
Estructura del software
Ingreso al sistema
Mapa de navegación
Descripción de las funciones del sistema
Descripción de los mensajes de error
Alcance
Describe los temas que serán abordados en el documento que servirán de guía al usuario. Incluye temas concernientes a la organización y las diferentes que ofrece la aplicación, que ponen contexto al usuario final
Requisitos de conocimiento para manejar el sistema
En este apartado se debe iniciar si los usuarios que van a manejar el sistema requieren de conocimientos técnicos particulares como los que se relacionan a continuación:
Informática básica
Sistemas operativos
Conocer las políticas de seguridad de la institución, por ejemplo, las políticas de ingreso, validación de usuarios y manejo de contraseñas
Requerimientos de hardware y software del equipo cliente
Es necesario indicar las especificaciones técnicas del hardware y software que se deben utilizar para que el sistema funcione adecuadamente en el equipo cliente de la aplicación. Estas ya fueron definidas en los documentos de diseño y validadas posteriormente durante el proceso de construcción de la aplicación
Política de seguridad
Las empresas deben tener una política de seguridad que es obligatorio cumplimiento por parte de los usuarios
Ingreso al sistema
Se debe explicar detalladamente la forma de ingresar al sistema de información, para cada uno de los usuarios que se deben leerla y tener claro todo el documento porque el no cumplimiento puede llevar a cometer infracciones o faltas que van desde leves hasta graves
Descripción de las funciones del sistema
Describe paso a paso los procesos con sus respectivas pantallas. Se recomienda incorporar algunos ejemplos. Puede ser presentada por módulos o perfiles de usuario
Información sobre la mesa de ayuda
Una vez que la aplicación entre a operar se requiere que se constituya una mesa de ayuda que se encargará de dar soporte de primer nivel a los usuarios.
Descripción de los mensajes de error
Es importante hacer una relación de los mensajes de error que pueden surgir de la operación de la aplicación. Además, se debe establecer una o varias acciones a seguir de acuerdo al error
Manual técnico
Este manual va dirigido al área de soporte técnico de la organización o a quien haga sus veces. En él se detallan aspectos sobre la estructura del sistema que le permitirá entender su funcionamiento global y posibilitar el mantenimiento del mismo
Componentes
Algunos de los componentes de este documento son:
Alcance
Se describe el objetivo general del sistema y los objetivos específicos que cumplieron con el desarrollo del sistema. También se deben establecer los límites de la documentación o los temas que no están cubiertos
Descripción de los procesos
En este ítem se describen los procesos que van a ser apoyados por el sistema de información. Generalmente en el informe de requerimientos se incluye un capítulo con el mapa de procesos de la empresa. También se puede seleccionar algunos de los diagramas ilustrativos de los requerimientos como puede ser el diagrama de casos de uso o una lista de requerimientos funcionales
Diagramas de UML
Es importante presentar los diagramas UML más representativos, entre ellos tienen: el diagrama de casos de uso, el diagrama de clases, el diagrama de secuencia, entre otros
Administración de usuarios
En este ítem se presenta el módulo de administración de usuarios incluyendo:
Creación, modificación y retiro de usuarios
Creación de roles y perfiles de usuarios
Descripción de la plataforma
En este numeral se relacionan las diferentes herramientas utilizadas para el desarrollo del sistema de información, entre ellas el lenguaje de programación, el sistema manejador de bases de datos o SGBD.
Documentación del código fuente
Describe la estructura de la aplicación, los componentes, la implementación de las clases y funciones. Este manual se suministra siempre y cuando el destinatario sea titular o licenciatario de los derechos de autor del software. Tiene como objetivo facilitar las labores de mantenimiento del código fuente
Descripción de los acuerdos de niveles de servicios o ANS
Los usuarios técnicos que tengan funciones de soporte a usuario finales deben tener conocimiento de la herramienta para el manejo de casos de la mesa de ayuda
Recomendaciones para realizar informe técnicos
Tanto el manual técnico como el manual de usuario son informes técnicos que deben seguir ciertas reglas o recomendaciones para que lleven a cabo una comunicación asertiva y efectiva con el usuario final. Las siguientes son algunas recomendaciones para redactar textos técnicos:
A. Los textos deben estar bien redactados
B. Usar la voz pasiva para la descripción de textos
C. Usar el modo verbal imperativo para las instrucciones
D. Solicitar el concepto de un tercero
E. Revisar la organización del texto para determinar que sigue una secuencia lógica
Ejercicio de creación de un manual de usuario
Para facilitar la compresión, se va a realizar la construcción del manual del usuario de una aplicación realizada durante la fase de desarrollo para un centro odontológico ficticio llamada: Gestión Odontológica.
Descripciones y detalles:
Alcance
Requisitos de conocimiento para manejar el sistema
Requerimientos de hardware y software
Ingreso a la plataforma
Interfaz gráfica
Mapa de navegación
Descripción
Ejercicio de creación de un manual técnico
1.Alcance
Descripción de procesos
Diagramas UML
4.Modelo relacional de la base de datos
Descripción de la plataforma
Documentación del código fuente