Universidad Técnica Federico Santa MaríaDepartamento de Electrónica

Documento Informe FinalInforme Final

de

Nombre del Sistema

Fecha [fecha último cambio]

Versión [versión actual]

Grupo [número]

Integrantes Nombre 1

del grupo Nombre 2

Nombre 3

Asignatura Laboratorio Electrónica B (ELO-109)

Profesor Daniel Rodriguez Sch.

Profesor Nicolas Alvarez M.

Documento Informe Final de Nombre del Sistema Página i

Prefacio

Este es el Documento Informe Final de Nombre del Sistema, explicación brevísima dequé es y/o que hace el sistema en Archivo-Propiedades-Resumen.

Alcance del documento

El Documento Informe Final es el documento que permite presentar el desarrollo completo de Nombre del Sistema. Describe los siguientes aspectos del sistema: propósito, contexto, requisitos funcionales, arquitectura revisada, descripción de cada módulo y diseño detallado de cada función incluyendo sus casos de prueba, resultados finales y conclusiones.

Documentos relacionados

Documento de Informe de Proyecto, proyecto Nombre del Sistema, versión X, fecha.

Autor [Autores]

Lectores Este documento está dirigido principalmente a los desarrolladores y a los profesores de la asignatura ELO-109, pero es de interés de todos los interesados en el mismo.

Aprobación Este documento debe ser aprobado por los profesores de la asignatura ELO-109 del proyecto Nombre del Sistema.

Historia del Documento

Versión Fecha Explicación del cambio Autor

0.1 Primer borrador

Documento Informe Final de Nombre del Sistema Página ii

Índice de Materias

Prefacio.......................................................................................................................................................... ii

Historia del Documento...............................................................................................................................ii

Lista de Figuras........................................................................................................................................... iv

Lista de Tablas............................................................................................................................................ iv

1 Introducción.......................................................................................................................................1

1.1 Propósito...........................................................................................................................................11.2 Alcance.............................................................................................................................................11.3 Contexto............................................................................................................................................11.4 Referencias........................................................................................................................................11.5 Documentación.................................................................................................................................1

2 Requisitos del Sistema.......................................................................................................................3

2.1 Requisitos Funcionales.....................................................................................................................32.2 Requisitos de Interfaces....................................................................................................................32.3 Requisitos de Prueba.........................................................................................................................4

3 Requisitos de Ambiente.....................................................................................................................5

3.1 Requisitos del Ambiente de Desarrollo............................................................................................5

4 Arquitectura Revisada del Sistema..................................................................................................6

4.1 Diagrama de Contexto......................................................................................................................64.2 Diagrama de Arquitectura.................................................................................................................74.3 Enumeración de Módulos.................................................................................................................74.4 Matriz de Requisitos Funcionales y Módulos...................................................................................8

5 Módulo [XX].......................................................................................................................................9

5.1 Definición del Módulo......................................................................................................................95.2 Estrategia de Prueba del Módulo......................................................................................................95.3 Diseño Detallado del Módulo...........................................................................................................9

6 Gestión de Riesgos............................................................................................................................12

6.1 Supuestos........................................................................................................................................126.2 Dependencias..................................................................................................................................126.3 Restricciones...................................................................................................................................126.4 Riesgos............................................................................................................................................12

7 Resultados.........................................................................................................................................13

8 Conclusiones.....................................................................................................................................14

Definiciones.................................................................................................................................................14

Documento Informe Final de Nombre del Sistema Página iii

Lista de FigurasFigura 1: Diagrama de arquitectura del sistema..............................................................................3

Lista de TablasTabla 1: Documentación del proyecto.............................................................................................3Tabla 2: Eventos externos................................................................................................................3Tabla 3: Respuestas del sistema......................................................................................................3Tabla 4: Excepciones.......................................................................................................................3

Documento Informe Final de Nombre del Sistema Página iv

1 IntroducciónEn esta introducción se describe brevemente el próposito, contexto, objetivos y alcance del sistema desarrollado, así como la documentación relativa al mismo. Esta información está basada en el Documento de Iniciación de Proyecto de Nombre del Sistema.

[Para usar esta plantilla, debe remover todos los párrafos que están entre corchetes, como éste, y reemplazarlos por un texto adecuado (este es el único párrafo entre corchetes que no se reemplaza por nada). Además, debe ir al menú File (archivo), opción Properties (propiedades), y modificar las propiedades Subject (tema o asunto) y Comments (comentarios). Una vez modificado, actualice las referencias seleccionando todo el documento y presione F9. Seleccione el pie de página y actualice la referencia al nombre del sistema. Luego revise que la primera oración del Prefacio se lee correctamente.]

1.1 Propósito[Describir aquí qué hace y qué es el sistema.]

1.2 Alcance[Describir hasta dónde llega el sistema: qué es y qué no es.]

1.3 Contexto[Dar información respecto del contexto del desarrollo. Tecnologías, trabajos previos, competencia, qué temas de la asignatura teórica involucra, etc.]

1.4 Referencias[Enumere la documentación y bibliografía ajena al proyecto, pero que se usó en él. Es importante que use un estilo estándar aceptado para poner las referencias: su documento debe ser profesional. Algunos tipos de referencias son:

Documentos asociados a los semiconductores y herramientas de software y de hardware

Artículos que fueron usados

Páginas Web de donde se obtuvo información necesaria para el proyecto

Textos de referencia

1.5 DocumentaciónLa documentación del sistema incluye documentación existente, documentación a desarrollar, y documentación a modificar.

1.5.1 Documentos ExistentesEste Documento Informe Final está basado en el Documento de Iniciación de Proyecto de Nombre del Sistema, de fecha [fecha].

[Indique aquí si hubiera otros documentos anteriores relacionados con el proyecto.]

Documento Informe Final de Nombre del Sistema Página 1

1.5.2 Documentos a DesarrollarDurante el proyecto se desarrolló la siguiente documentación (vea la Tabla 1).

Tabla 1: Documentación del proyecto

Código Documento Contenido

DIP Documento de Iniciación de Proyecto

Documento con el planteamiento del proyecto, entregado por los profesores de ELO_109

REQ Documento de Requisitos No se hizo

PP Plan del Proyecto Lista detallada de las actividades, sus dependencias y sus fechas (documento de planificación)

DPE Documento de la primera etapa

Detalles de la arquitectura y diseño detallado de la primera etapa, según el PP

PIP Plan de Integración y Pruebas Descripción de cómo se integraron y probaron las partes del proyecto

DIF Informe de Final Documento especial para informar del desarrollo completo del sistema

COD Código del sistema Archivos .c, .h, make, etc. (extensión de los archivos que se emplearon)

Adicionalmente se generaron informes de avance semanales y minutas de reuniones. Los informes y las minutas fueron mensajes de correo electrónico y están almacenados en la carpeta del proyecto.

1.5.3 Documentos a Modificar[Indique aquí si hubiera documentos existentes que serán modificados. En caso contrario, no elimine esta sección, sino que deje la palabra “Ninguno.”]

Documento Informe Final de Nombre del Sistema Página 2

2 Requisitos del SistemaEsta sección describe los requisitos funcionales del sistema, sus interfaces externa, las condiciones de excepción y las clases de pruebas que se harán para verificar que los requisitos se cumplen.

2.1 Requisitos FuncionalesLos requisitos funcionales definen el comportamiento del sistema. Es decir, describen lo que debe hacer el sistema.

RF1 [Describa en forma breve cada una de las cosas que el sistema hace. Puede usar un pequeño párrafo para cada requisito funcional, o ser simplemente una línea. Lo importante es que sea a la vez simple de entender, breve, e inambiguo. Por ej. “Debe acondicionar en niveles de tensión adecuados la señal proveniente del sensor de velocidad”]

RF2 [Otro requisito funcional. Por ej. “Debe generar una señal audible en caso de velocidad mayor que el límite ALTO”]

RF3 [Otro requisito funcional. Por ej. “debe poseer una comunicación serie, en lazo de corriente, del valor de velocidad de 4 a 20 mA”]

RF4 [Y otro más: para agregar más basta agregar párrafos que usan el estilo “Requisito”.]

2.2 Requisitos de Interfaces[Describa las interfaces externas que el sistema debe satisfacer. Incluya una lista de eventos externos a los que el sistema debe responder y las respuestas a esos eventos (indicar por lo menos dos). En caso de haber interacción con el usuario, puede enumerar los comandos como eventos externos, o bien especificarlos de otro modo. Por ej: Ajustar referencia de velocidad ]

La Tabla 2 muestra la lista de eventos externos a los que el sistema responde. La primera columna es el nombre del evento; la segunda es la descripción del mismo. El “iniciador” es la componente externa al sistema que inicia el evento. Los parámetros son los datos asociados al evento. La respuesta es el nombre de una respuesta, cuya descripción está en la .

Tabla 2: Eventos externos

Evento Descripción Iniciador Parámetros Respuesta

Vref Ajuste de velocidad usuario Voltaje que fija el valor de velocidad

Voltaje de salida

armadura del motor

La muestra las respuestas del sistema frente a eventos externos.

Documento Informe Final de Nombre del Sistema Página 3

Tabla 3: Respuestas del sistema

Respuesta Descripción Parámetros

2.3 Requisitos de PruebaLos requisitos de prueba son clases de pruebas que se hicieron sobre el sistema para determinar que se cumplían los requisitos funcionales. Un requisito de prueba pudo dar lugar a muchos casos de prueba.

RP1 [Describa en forma breve cada una de las clases de pruebas que se hicieron para verificar los requisitos funcionales. Probablemente usted necesitó unos 5 a 10 requisitos de prueba.]

RP2 [Otro requisito de prueba.]

RP3 [Para agregar más basta agregar párrafos que usan el estilo “Prueba”.]

Documento Informe Final de Nombre del Sistema Página 4

3 Requisitos de AmbienteEsta sección describe el hardware y software relevante para el sistema Nombre del Sistema.

3.1 Requisitos del Ambiente de Desarrollo

3.1.1 Hardware de Desarrollo[Describa todo el hardware utilizado para hacer el desarrollo. Por ej: Osciloscopio Textronix TDS 220, etc]

3.1.2 Software de Desarrollo[Describa todo el software utilizado para hacer el desarrollo.Por ej. Electronic Workbench 4.0,etc]

Documento Informe Final de Nombre del Sistema Página 5

4 Arquitectura Revisada del Sistema[NOTA: Para usar esta plantilla, remueva todos los párrafos que están entre corchetes que comienzan con la palabra NOTA, como éste; estos párrafos dan instrucciones de uso de la plantilla. Reemplace los demás párrafos entre corchetes por un texto adecuado; estos párrafos describen una parte del documento que usted debe completar.]

[NOTA: Para definir y propagar el nombre y propósito del sistema, vaya al menú File (archivo), opción Properties (propiedades), y modifique las propiedades Subject (tema o asunto) y Comments (comentarios). Una vez modificado, actualice las referencias seleccionando todo el documento y presione F9. Seleccione el pie de página y actualice la referencia al nombre del sistema. Luego revise que la primera oración del Prefacio se lee correctamente.]

En el Documento de Iniciación del proyecto Nombre del Sistema se especificó su arquitectura inicial. A la luz de un trabajo de diseño más detallado, aquí se presenta la arquitectura definitiva, que incluye más detalle y posiblemente algunos cambios.

4.1 Diagrama de ContextoEn el diagrama de contexto, el sistema está graficado como una caja negra, junto a los principales entes externos al sistema que interactúan con él. Estos entes externos pueden ser electrónicos, mecánicos, de software, e incluso personas. Las flechas que unen los entes externos con el sistema indican flujos de datos desde o hacia el sistema.

[ ]Figura 1: Diagrama de contexto del sistema

[Explique aquí qué son los entes externos y qué son los flujos de datos desde y hacia el sistema. Esto ayuda a definir más claramente qué es el sistema y cuál es su alcance.]

Documento Informe Final de Nombre del Sistema Página 6

4.2 Diagrama de ArquitecturaLa siguiente figura muestra los módulos internos del sistema y sus principales interacciones. Los módulos aparecen indicados con su nombre corto o abreviatura.

[ ]Figura 2: Diagrama de arquitectura del sistema

4.3 Enumeración de MódulosLa Tabla 4 muestra los módulos de la Error: Reference source not found. Por cada módulo se entrega un breve párrafo descriptivo de su propósito, además de la sección en donde se especifica el módulo en detalle.

[NOTA: Use referencias automáticas a los números de sección, para mantener consistencia.]

Tabla 4: Módulos de la arquitectura del sistema

Módulo Propósito Sección

Nombre largo 1 (abreviatura 1) Por ej.

ACOND

[Explicación de qué hace el módulo, indicando sus principales funciones y relación con otros módulos.]

5

Nombre largo 2 (abreviatura 2)

[Explicación de qué hace el módulo, indicando sus principales funciones y relación con otros módulos.]

Nombre largo 3 (abreviatura 3)

[Explicación de qué hace el módulo, indicando sus principales funciones y relación con otros

Documento Informe Final de Nombre del Sistema Página 7

Módulo Propósito Sección

módulos.]

4.4 Matriz de Requisitos Funcionales y MódulosLa siguiente matriz muestra qué módulos del sistema implementan qué requisitos funcionales.

[NOTA: Una línea vacía en la matriz indica un requisito funcional no implementado; en ese caso es probable que falte un módulo. Una columna vacía indica un módulo no es útil para estos requisitos funcionales; en ese caso es posible que falte un requisito funcional. Una columna demasiado llena indica un módulo que participa en demasiados requisitos; esto podría ser síntoma de una mala modularización, porque un cambio en el módulo puede afectar a todos los requisitos. Algo similar ocurre con una fila demasiado llena, que corresponde a un requisito que se implementa en todas partes; un cambio en el requisito podría implicar cambios en todas los módulos.]

[NOTA: La matriz de abajo debe re-formatearse de modo que tenga columnas para todas los módulos y filas para todos los requisitos funcionales. Una vez re-formateada la matriz, ponga una X en una celda para indicar que el módulo de la columna respectiva ayuda a implementar el requisito funcional de la fila respectiva.]

Tabla 5: Matriz de requisitos funcionales y módulos

C1 C2 C3RF1RF2RF3RF4RF5RF6RF7RF8

Documento Informe Final de Nombre del Sistema Página 8

5 Descripción de Módulos5.1 Modulo [XX]

5.1.1 Definición del MóduloPropósito [Describa aquí qué hace y qué es el módulo. Por ej: Acondiciona en

voltaje la señal de entrada]

Alcance [Describa el módulo en términos generales, incluyendo cómo calza dentro del sistema. No explique las partes del módulo (ejemplo, funciones, circuito, etc.), sino más bien cómo el módulo se presenta en la arquitectura del sistema. Es decir, cómo se ve la arquitectura desde el punto de vista del módulo. Por ej. ACOND. Recibe la señal proveniente del sensor de velocidad, previa entrega del voltaje de polarización, amplificándola para el próximo módulo de control]

Dependencias [Indique qué otros módulos son necesarios para el funcionamiento correcto de este módulo. Por cada otro módulo diga qué partes del otro módulo son necesarias, sin entrar en detalles. Por ej: módulo de FPOD, voltajes de alimentación]

Supuestos [Indique los supuestos asociados al módulo. Ejemplos: requisitos de tiempos de otros módulos, operación de otros módulos, etc.]Por ej, debe estar conectado al módulo SENS y al FPOD)

Restricciones [Indique las limitaciones del módulo, incluyendo capacidades de cómputo o de tiempos en forma cuantitativa, mínima carga (ejemplo, corriente máxima de salida)]

Documento Informe Final de Nombre del Sistema Página 9

5.1.2 Estrategia de Prueba del Módulo[Explique cómo probó el módulo, de modo de aislar los errores que pudo tener el módulo de los errores de otros módulos, de los errores de interfaces, de los errores de configuración de hardware, etc..]

5.1.3 Diseño Detallado del Módulo

A continuación se muestra el diagrama del circuito del módulo, indicando cada elemento con un nombre literal y número de referencia (Ej. R12, C6, L9, AO96, etc), las ecuaciones de diseño, una lista de los elementos y su valor numérico de diseño

Documento Informe Final de Nombre del Sistema Página 10

Propósito [Describa aquí qué hace y qué es el módulo. Esto es usualmente una expansión de la “descripción breve” mostrada arriba. Por ej. ACOND: amplificador de voltaje, que permite adecuar la señal de voltaje del sensor de velocidad, amplificándola adecuadamente)]

Dependencias [Indique qué otras funciones son llamadas y para qué. Por ej: Fuente de poder, requiere de voltaje de alimentación positivo y negativo ]

Parámetro Explicación

[Parámetro 1. Por ej: voltaje

“offset”]

[Explicación y rango de valores del parámetro 1. Por ej. Permite ajustar a cero el voltaje de salida, Vs1, dentro del rango de +- 1 volts ]

[Parámetro 2, Por ej: Ve1 ]

[Explicación y rango de valores del parámetro 2. Por ej: Voltaje de salida del sensor de velocidad de 0 a 500 mV)]

[Parámetro 3] [Explicación y rango de valores del parámetro 3]

Proceso [Muestre la secuencia de operaciones que hace el módulo.]

Primer paso

Segundo paso

Tercer paso

A continuación se muestran los casos de prueba del módulo. Cada caso de prueba se define con las entradas y las salidas, incluyendo el estado del sistema, una eventual excepción, y sus efectos laterales. Debe haber suficientes casos de prueba para demostrar las siguientes condiciones:

Casos habituales de los parámetros (por ej: característica de transferencia, respuesta en frecuencia)

Casos extremos de los parámetros (por ej. Valor máximo de velocidad,etc.)

Cada una de las posibles excepciones ( por ej. Ninguna)

Efectos laterales más comunes

[Repita la tabla de abajo por cada caso de prueba de este módulo]

Caso de Prueba 1(por ej. Motor detenido, respuesta a un pulso de entrada, respuesta a una señal de entrada determinada, respuesta en frecuencia, etc)

Parámetro Valor

[Parámetro 1. Por ej. Ve1]

[Valor del parámetro 1, Por ej. 15 mV ]

[Parámetro 2, por ej. Vs1]

[Valor del parámetro 2, por ej. 0 volts]

[Parámetro 3, por ej.

Voffset]

[Valor del parámetro 3 :150 mV]

Documento Informe Final de Nombre del Sistema Página 11

6 Gestión de Riesgos6.1 Supuestos

[Supuestos técnicos que hacemos y que necesitamos para ejecutar nuestro trabajo. El hacer un supuesto nos obliga a verificar su veracidad. Si el supuesto es crítico, puede dar lugar a un riesgo que debe identificarse y gestionarse.]

[Enumere aquí los supuestos que se plantearon al comienzo del proyecto, tanto los que cumplieron como los que no.]

6.2 Dependencias[Las dependencias son condiciones o hechos que deben ocurrir y que están fuera del control directo del equipo de proyecto. Usualmente se refieren a tareas que deben ser hechas por participantes que no son el equipo del proyecto. El indicar una dependencia nos obliga a verificar si ésta se cumplirá adecuadamente, y puede dar lugar a riesgos que deben ser gestionados.]

[Enumere aquí las dependencias.]

6.3 Restricciones[Las restricciones se refieren a los recursos, hardware, software, estándares, etc. que debemos usar en el proyecto. Las restricciones son indicaciones claras para los diseñadores respecto de qué se puede y no se puede hacer. Pueden dar lugar a riesgos, de que los diseñadores no sean capaces de diseñar sujeto a las restricciones; estos riesgos deben ser administrados.]

[Enumere aquí las restricciones que tuvo para desarrollar el proyecto.]

6.4 Riesgos[Los riesgos son hechos que pueden o no ocurrir, y que de ocurrir generan problemas al proyecto. Algunos riesgos provienen de supuestos, dependencias y restricciones, pero otros provienen de otras partes. El indicar un riesgo nos compromete a evitar que se transforme en problema; en el caso de los riesgos mayores, debemos tener de antemano un plan de contingencia.]

A continuación se indican los principales riesgos que tuvo en el proyecto.

6.4.1 Riesgo 1[El título debe ser el nombre del riesgo. En este párrafo describa el riesgo. Si el riesgo es importante, indique qué hizo para evitar que se transforme en problema y cómo abordó el problema en el caso de que se hubo presentado.]

6.4.2 Riesgo 2

[Describa los demás riesgos...]

Documento Informe Final de Nombre del Sistema Página 12

7 Resultados[Los resultados se refieren al comportamiento final alcanzado en el desarrollo de proyecto, que funcionalidades quedaron operativas, que grado de calidad se alcanzó y cuales deberían ser los pasos a seguir para tener el sistema completamente operativo.]

Documento Informe Final de Nombre del Sistema Página 13

8 Conclusiones[Las conclusiones se refieren a exponer qué experiencia se logró adquirir con la metodología de trabajo empleada, cuales son los aspectos positivos alcanzados, cuales son los aspectos negativos y algunas sugerencias que mejoren el desarrollo futuro de estas experiencias.]

Definiciones[Defina todos los conceptos, siglas, abreviaturas usados que no sean de conocimiento general de cualquier desarrollador de sistemas electrónicos. Incluya términos específicos de la aplicación. Ponga también las abreviaturas usadas para los documentos en la sección 1.5.2. Ordene los términos en orden alfabético (Word lo hace, menú Tabla o Table.)]

Abrev. [Definición]

Palabra [Definición]

Término muy largo

[Definición]

Documento Informe Final de Nombre del Sistema Página 14