Plantilla de la monografía

Vista previa del material en texto

<Título de la monografía (negrilla y en mayúsculas)>	Comment by Jhon Jairo Alvarez Londoño: Cada vez que se observe un texto con este patrón (signo menor, texto, signo mayor en letra Arial azul debe ser reemplazado con lo que se ilustra en su contenido, 
<Autores de la monografía>
Universidad del Cauca
Facultad de Ingeniería Electrónica y Telecomunicaciones
Departamento de <Departamento>
<Programa>
Popayán, <fecha>
<Título de la monografía (negrilla y en mayúsculas)>
Monografía presentada como requisito parcial para optar por el título de
Ingeniero en Automática Industrial
<Autores de la monografía>
Director: <nombre del tutor de la tesis>
Universidad del Cauca
Facultad de Ingeniería Electrónica y Telecomunicaciones
Departamento de <Departamento>
<Programa>
Popayán, 07 de noviembre de 2013
Nota de aceptación: ____________________________
____________________________
____________________________
____________________________
____________________________
____________________________
____________________________________
Firma del presidente del Jurado
____________________________________
Firma del Jurado
Popayán, 07 de noviembre de 2013
Agradecimientos
<Aquí van los agradecimientos>
Resumen
<El resumen expone de una forma muy concisa los aspectos relacionados con la construcción del simulador, al ser un proyecto de software se debe enunciar el proceso seguido para su construcción mencionando como mínimo la forma de la captura de requisitos, el diseño de planos arquitectónicos para el simulador, la construcción del software siguiendo los planos y las pruebas realizadas manteniendo la trazabilidad con los requisitos.>
Contenido
Agradecimientos	4
Resumen	5
Contenido	6
LISTA DE FIGURAS	8
LISTA DE TABLAS	9
1.	Introducción	10
2.	Conceptos preliminares	11
2.1.	Simuladores quirúrgicos:	11
2.1.1.	Simuladores comerciales:	11
3.	Proceso de construcción del software	12
3.1.	Captura de requisitos de software	13
3.1.1.	Visión del producto	13
3.1.2.	Diagrama de casos de uso	13
3.1.3.	Casos de uso detallados2	13
3.2.	Análisis	15
3.2.1.	Descripción de herramientas software	15
3.2.2.	Escenario quirúrgico	15
3.2.3.	Robots utilizados en el simulador	15
3.2.4.	Modelos matemáticos utilizados para la llevar a cabo la mecánica del movimiento de los robots.	15
3.2.5.	Algoritmos utilizados para la construcción de las mecánicas de la simulación.	15
3.3.	Diseño	16
3.3.1.	Modelo de diseño	16
3.3.2.	Diagrama de clases	16
3.3.3.	Diagrama de componentes	17
3.3.4.	Diagrama de comunicación	18
3.4.	Construcción	19
3.4.1.	Instalación	19
3.4.2.	Instrucciones de uso	19
3.5.	Pruebas	20
4.	Referencias	21
LISTA DE FIGURAS
<Como en el tabla de contenido, se referencian todas las figuras presentes en la monografía: 
· Para ingresar un texto reconocible por esta índice de figuras entonces, lo primero es ubicar el cursor en el lugar deseado para aplicar el estilo de figuras (Click en la pestaña inicio, y en la sección estilos seleccionar el estilo “Figuras”) y escribir el nombre de la figura.
· Con el nuevo texto añadido se puede actualizar el índice de figuras de ejemplo dándole click derecho a la tabla, y seleccionando actualizar campos.
Ejemplo de índice de figuras:
Figura 1. Logo del proceso PRODIGIA.	7
Figura 2. Ejemplo de diagrama de casos de uso	12
Figura 3. Ejemplo de modelo de diseño	15
Figura 4. Ejemplo de diagrama de clases	15
Figura 5. Ejemplo de diagrama de componentes	16
Figura 6. Ejemplo de un diagrama de comunicación.	17
>
Figura 1. Logo del proceso PRODIGIA.
LISTA DE TABLAS
< Como en el tabla de contenido, se referencian todas las figuras presentes en la monografía: 
· Para ingresar un texto reconocible por esta índice de figuras entonces, lo primero es ubicar el cursor en el lugar deseado para aplicar el estilo de figuras (Click en la pestaña inicio, y en la sección estilos seleccionar el estilo “Tablas”) y escribir el nombre de la tabla.
· Con el nuevo texto añadido se puede actualizar el índice de tablas de ejemplo dándole click derecho a la tabla, y seleccionando actualizar campos.
Ejemplo de índice de figuras:
Tabla 1. Tabla de ejemplo.	8
Tabla 2. Ejemplo de un caso de uso detallado	13
Tabla 3. Ejemplo de lista de pruebas.	19
>
	Tabla de ejemplo
	Lorem ipsum ad his scripta blandit partiendo, eum fastidii accumsan euripidis in, eum liber hendrerit an. Qui ut wisi vocibus suscipiantur, quo dicit ridens inciderint id. Quo mundi lobortis reformidans eu, legimus …
Tabla 1. Tabla de ejemplo.
1. Introducción
<La introducción de un sistema software introduce conceptos resumidos de la lógica del negocio, y en este caso, aspectos de la cirugía, su historia y los problemas actuales por los cuales atraviesa y las ventajas del uso de un simulador quirúrgico>
2. Conceptos preliminares
<Aquí se enuncian términos que son de uso específico de la monografía, se colocará de ejemplo un subtítulo	 para efectos de actualización del índice de contenido de a monografía>
2.1. Simuladores quirúrgicos:
Lorem ipsum ad his scripta blandit partiendo, eum fastidii accumsan euripidis in, eum liber hendrerit an. Qui ut wisi vocibus suscipiantur…
2.1.1. Simuladores comerciales:
Lorem ipsum ad his scripta blandit partiendo, eum fastidii accumsan euripidis in, eum liber hendrerit an. Qui ut wisi vocibus suscipiantur…
3. Proceso de construcción del software
<En ésta sección se debe hablar sobre el proceso de construcción del simulador llevado a cabo, en este caso debería hablarse a grandes rasgos de PRODIGIA (http://jhon-jairo-alvarez-londono.alwaysdata.net/PRODIGIA/) y su utilidad como guía de la construcción de la parte software del simulador y adjuntar la URL en caso de ser necesaria y se habla de las actividades realizadas en la construcción del software (captura de requisitos, análisis y diseño, construcción y pruebas)>
3.1. Captura de requisitos de software
<Se presenta de forma clara el proceso seguido para realizar la captura de requisitos, especialmente el documento de especificación de requisitos (SRS), en este caso los diagramas de casos de uso de forma muy rápida>
3.1.1. Visión del producto
<La visión del producto define la visión de los principales interesados en el proyecto del producto a ser desarrollado especificado en términos de las necesidades clave y características de los interesados y provee una base para requisitos técnicos más detallados.>
3.1.2. Diagrama de casos de uso[footnoteRef:1] [1: , 2 Estos dos apartados en últimas realizan el documento de especificación de requisitos especificado en el proceso PRODIGIA] 
<Representa la funcionalidad que finalmente va a tener el software, ilustra gráficamente la interacción entre el usuario y el software a través su división en funcionalidades y entre casos de uso y actores>
Figura 2. Ejemplo de diagrama de casos de uso
3.1.3. Casos de uso detallados2
<El documento de casos de uso especifica de manera detallada la funcionalidad de cada caso de uso de manera específica, a continuación se adjunta un ejemplo sencillo>
	Caso de uso
	Atender Consulta
	Nombre
	Atender Consulta
	Actores
	Pediatra
	Prioridad
	Alta
	Código
	R4
	Referencias Cruzadas
	R3, R1.1, R1.3, R1.5, R6.5
	Descripción
	Este caso de uso se inicia cuando el Pediatra le solicita al sistema la atención de un paciente. El sistema le permite al Pediatra registrar los datos del paciente si no existen y de la consulta, y según el diagnóstico médico proporciona de manera automática las conductas recomendadas. Para finalizar la consulta el sistema registra el RIPS correspondiente a la atención médica e imprime la fórmula médica, junto con las recomendaciones médicas las cuales serán entregadas al paciente.
Tabla 2. Ejemplo de un caso de uso detallado
3.2. Análisis
<En esta sección se coloca la fundamentación teórica utilizada para la construcción del software, incluyendo las herramientas software usadas para su construcción, los robots, los modelos matemáticos utilizados para su construcción etc..(Estohace parte del análisis) y los planos de construcción de software utilizados (Esto hace parte del diseño)>
3.2.1. Descripción de herramientas software
<En esta subsección se describe las diferentes herramientas software utilizadas en la realización del simulador, hablar de VTK y QT principalmente y modelar las secciones de código en diagramas UML que permitan ilustrar mejor la generación del código y su flujo de ejecución en el sistema.>
3.2.2. Escenario quirúrgico
<Ilustrar como se ha construido o elaborado el escenario en donde se desarrollará la simulación de la cirugía a realizar>
3.2.3. Robots utilizados en el simulador
<En esta subsección explica la función y finalidad de cada robot sobre el simulador>
3.2.4. Modelos matemáticos utilizados para la llevar a cabo la mecánica del movimiento de los robots.
<Aquí se exponen todos los modelos matemáticos utilizados para la construcción del simulador, sobre los cuales se basarán los movimientos realizados por los robots para la cirugía>
3.2.5. Algoritmos utilizados para la construcción de las mecánicas de la simulación.
<Si existen algoritmos específicos que determinen las mecánicas de la simulación podrían ser especificadas en esta subsección> 
3.3. Diseño
<El diseño de los sistemas software se da en este caso en los diagramas realizados como guía para la construcción de software, son los que ilustran y el comportamiento del sistema>
3.3.1. Modelo de diseño
< El modelo de diseño es un puente para aterrizar las funcionalidades de los casos de uso a un plano de la implementación de software, y es un modelo de objetos que permite la realización física de los caso de uso centrándose en requisitos funcionales y no funcionales. Mayor información en: http://www.upedu.org/process/artifact/ar_desmd.htm>
Figura 3. Ejemplo de modelo de diseño
3.3.2. Diagrama de clases
<Ilustra la estructura de un sistema mostrando sus clases orientadas a los objetos>
Figura 4. Ejemplo de diagrama de clases
3.3.3. Diagrama de componentes
<Representa cómo un sistema de software es dividido en componentes y muestra las dependencias entre estos componentes. Los componentes físicos incluyen archivos, cabeceras, bibliotecas compartidas, módulos, ejecutables, o paquetes.>
Figura 5. Ejemplo de diagrama de componentes
3.3.4. Diagrama de comunicación
<Un diagrama de comunicación modela las interacciones entre objetos o partes en términos de mensajes en secuencia. Los diagramas de comunicación representan una combinación de información tomada desde el diagrama de clases, secuencia, y diagrama de casos de uso describiendo tanto la estructura estática como el comportamiento dinámico de un sistema. Como prerrequisitos se debe realizar el diagrama de clases para ilustrar la comunicación en un nivel más alto que el diagrama de comunicación, En la figura 5 el “:<nombre_instancia_de_clase>” indica que es una instancia de la clase nombrada después de los 2 puntos “:”>
Figura 6. Ejemplo de un diagrama de comunicación.
3.4. Construcción
<Si se necesita, aquí se colocan ejemplos relevantes de la construcción de software como secciones importantes del código generado en la construcción de software>
3.4.1. Instalación
<Ilustra la manera de como el software será instalado, en donde por lo general muestra los requisitos no funcionales asociados al ordenador donde será instalado y sus características mínimas para su completo funcionamiento.>
3.4.2. Instrucciones de uso
<El manual de usuario muestra como deberá ser usado el software, en el caso del simulador, la interfaz haptica para su uso, las instrucciones y los resultados obtenidos tras el uso de cada parte del mismo.>
3.5. Pruebas
<Este apartado contiene las pruebas que han sido realizadas al software, se sugiere documentar la lista de pruebas realizadas y cada prueba que contenga una lista de chequeo con las actividades a realizadas en donde tengan 2 estados (superado | no superado) por iteración, la tabla 3 ilustra un ejemplo.
El artefacto a probar por lo general puede ser cualquiera que necesite ser probado con criterios previamente seleccionados para la naturaleza de dicho elemento, pueden ser pruebas que, por lo general son de caja negra, de artefactos que van desde documentación hasta código software (principalmente por motivos trazabilidad de los requisitos con el artefacto y errores lógicos de codigo software) si así se considera necesario.>
Tabla de pruebas al componente de la lógica de la jacobiana.
S = Superado
N = No superado
	Actividad
	Estado
	¿La clase A hereda de la clase B?
	S
	¿La clase A se comunica con la clase C a través de la función comunicacionConClaseC()?
	N
Tabla 3. Ejemplo de lista de pruebas.
4. Referencias