Prepara tus exámenes y mejora tus resultados gracias a la gran cantidad de recursos disponibles en Docsity
Gana puntos ayudando a otros estudiantes o consíguelos activando un Plan Premium
Prepara tus exámenes
Prepara tus exámenes y mejora tus resultados gracias a la gran cantidad de recursos disponibles en Docsity
Prepara tus exámenes con los documentos que comparten otros estudiantes como tú en Docsity
Los mejores documentos en venta realizados por estudiantes que han terminado sus estudios
Estudia con lecciones y exámenes resueltos basados en los programas académicos de las mejores universidades
Responde a preguntas de exámenes reales y pon a prueba tu preparación
Consigue puntos base para descargar
Gana puntos ayudando a otros estudiantes o consíguelos activando un Plan Premium
Comunidad
Pide ayuda a la comunidad y resuelve tus dudas de estudio
Descubre las mejores universidades de tu país según los usuarios de Docsity
Ebooks gratuitos
Descarga nuestras guías gratuitas sobre técnicas de estudio, métodos para controlar la ansiedad y consejos para la tesis preparadas por los tutores de Docsity
Este documento ofrece una guía detallada para la elaboración de un manual técnico de software, incluyendo objetivos, alcances, convenciones de formato y desarrollo. El manual está dirigido al personal encargado de mantener el software y contiene información sobre requisitos, diseño, organización y estructura.
Qué aprenderás
Tipo: Monografías, Ensayos
1 / 12
Esta página no es visible en la vista previa
¡No te pierdas las partes importantes!
Documentación Versión 1.0 Enero 2022
El objetivo de este documento es brindar al Departamento del Centro de Cómputo del Instituto Tecnológico de Ciudad Guzmán, una guía para la elaboración del manual de técnico de los distintos sistemas de información y/o aplicaciones, de tal manera, que éste oriente al programador o los programadores que en un futuro sean encargados del mantenimiento. Con la adopción y manejo de los conceptos abordados en la presente guía, se facilitará la elaboración de éstos.
Este documento describe el contenido mínimo y obligatorio de un manual técnico para los sistemas de información y/o aplicaciones del Departamento del Centro de Cómputo del Instituto Tecnológico de Ciudad Guzmán.
El manual técnico (también conocido como manual del programador) de una solución de software o de un Sistema de Información tiene como propósito ilustrar sobre la definición, diseño, organización y estructura del sistema o solución al personal encargado de mantener la prestación del servicio o servicios ofrecidos por el sistema o solución, estos lectores incluyen desarrolladores, arquitectos de software, ingenieros de pruebas, entre otros interesados. Dicho de otra forma, el manual técnico va dirigido a la dirección de IT (Tecnologías de la Información), al administrador del sistema y a otros desarrolladores de software que puedan darle mantenimiento al sistema en caso de que se requiera (también puede ser utilizado por el departamento de auditorías de sistemas).
El manual técnico debe de ser considerado durante todas las etapas que involucre el crear una solución de software, puesto que en este manual se plasma desde el Análisis hasta el Desarrollo, porque es importante que las personas encargadas del mantenimiento del software no sólo conozcan la Arquitectura y Desarrollo, sino que también sea de su conocimiento el cómo se cubrieron inicialmente los requisitos, qué métricas fueron usadas para saber en qué medida fueron cumplidos y otros aspectos importantes. Este manual debe de estar listo cuando la solución de software esté terminada, esperando que sea aprobado.
Antes de empezar a generar el contenido del manual técnico, hay diversas consideraciones que se deben de tener en cuenta al documentar, ya que estas le darán formalidad y mejor estructura al manual.
La portada deberá contener los respectivos logos y nombre de la institución, título del documento que se está generando y fecha de creación. 6.2. ÍNDICE GENERAL Tabla que relaciona las páginas y secciones que componen el manual. 6.3. ÍNDICE DE FIGURAS Tabla que relaciona las páginas en donde se encuentran las figuras en el manual. 6.4. ÍNDICE DE TABLAS Tabla que relaciona las páginas en donde se encuentran las tablas en el manual. 6.5. OBJETIVO GENERAL Explicar de manera clara y resumida cuál es el objetivo general del manual, qué se busca con éste. 6.5.1. OBJETIVOS ESPECÍFICOS Enlistar los objetivos específicos del manual, deben de ser concisos (Ejemplo: Dar a conocer los requisitos para la ejecución de la aplicación, Manifestar evidencias del diseño del sistema, entre otros). 6.6. ALCANCE Explicar qué alcance tiene el manual técnico, mencionar a quién va dirigido y enlistar de manera muy resumida con qué conocimientos debe de contar la persona que vaya a realizar el mantenimiento. 6.7. REQUERIMIENTOS TÉCNICOS Enlistar que requerimientos técnicos de software son necesarios para poderle dar mantenimiento a la solución de software, dicho de otro modo, se debe de mencionar
qué software deberá de tener instalado el programador para poder llevar a cabo el mantenimiento. Enseguida, también se deben de enlistar los requerimientos técnicos de hardware serán necesarios para poder llevar a cabo el mantenimiento, por ejemplo, un equipo de cómputo que cuente con ciertos periféricos, un dispositivo móvil, un cable en específico, entre otros. 6.7.1. REQUERIMIENTOS MÍNIMOS DE HARDWARE Lista con las especificaciones mínimas de hardware con las que debe de contar el equipo de cómputo para su correcto funcionamiento (procesador, memoria RAM y almacenamiento). 6.7.2. REQUERIMIENTOS MÍNIMOS DE SOFTWARE Lista con las especificaciones mínimas de software con las que debe de contar el equipo de cómputo para que el sistema funcione adecuadamente (versión mínima de SO, ¿Son necesarios los permisos de administrador?, entre otros). 6.8. HERRAMIENTAS UTILIZADAS PARA EL DESARROLLO Lista con las diferentes herramientas que fueron utilizadas para el desarrollo (IDE, Buscador Web, entre otras), explicando para qué fue usada cada una. 6.9. INSTALACIÓN 6.9.1. INSTALACIÓN DEL PROYECTO Explicar los pasos que se deben de llevar a cabo para instalar el proyecto, para proceder con el mantenimiento. Así mismo se debe de incluir un link que dirija al repositorio del proyecto. 6.9.2. INSTALACIÓN DE LA BASE DE DATOS Explicar los pasos necesarios para acceder a la base de datos y poderla gestionar. 6.10. CONFIGURACIÓN Mencionar si es o no necesario hacer una configuración general de la aplicación para empezar a hacer uso de ella y proceder con el mantenimiento. 6.11. ESTRUCTURA RAÍZ Mostrar cómo están estructurados los directorios que conforman el proyecto (con una imagen). Enseguida explicar qué contiene cada uno de los directorios y cada uno de los archivos que lo conforman. 6.12. ANÁLISIS Utilizar un estándar para el levantamiento de los requerimientos, se sugiere el estándar IEEE830.
Especificar los privilegios con los que cuenta el usuario, para que de esta manera sea consciente de las tareas que puede realizar y a los módulos que puede tener acceso. 6.16 DATOS PARA LA ASISTENCIA TÉCNICA Se deben agregar datos del programador o de la persona responsable encargada del proyecto para que si en algún momento el usuario llega a tener alguna duda o algún problema, pueda comunicarse para recibir ayuda.
