Guia documentacion tecnica

Universidad Sim´n Bol´ o ıvar Departamento de Elect´nica y Circuitos o Laboratorio de Proyectos III EC3883 Enero-Marzo 2007, Secci´n 2. o Prof. Cecilia Murrugarra Q. cmquiroz@usb.ve

Generaci´n de Documentaci´n T´cnica. o o e (Informe t´cnico, Protocolos de pruebas, Codificaci´n de programas, e o Bit´cora, Cronograma de proyectos.) a
Este documento solo pretende ser una gu´ o referencia r´pidapara la elaboraci´n de docıa a o umentaci´n t´cnica de proyectos de Ingenier´ El mismo ha sido elaborado en base a mi o e ıa. experiencia en la generaci´n de documentaci´n t´cnica de proyectos, productos y servicios y o o e de conversaciones sostenidas con otros colegas que d´ a d´ se enfrentan a este reto. ıa ıa Este documento ha sido organizado en cuatro secciones que describo a continuaci´n : o1. Informe T´cnico. En esta secci´n se presenta el contenido b´sico que debe poseer el e o a informe t´cnico de un proyecto. e 2. Bit´cora ´ Cuaderno de Bit´cora. En esta secci´n se describe que ´s una Bit´cora a o a o e a y como puede ser organizada. 3. Cronograma del Proyecto. En esta secci´n se muestra una breve descripci´n de los o o m´todos m´s empleados para la generaci´n de cronogramas deproyectos. e a o 4. Documentaci´n de Programas. En esta secci´n se presenta una referencia de o o la informaci´n que deben contener los archivos de programas generados durante la o elaboraci´n de un proyecto, de manera que permita r´pidamente identificar ciertos o a par´metros de programaci´n y facilitar su lectura e interacci´n con todos los programas a o o de dicho proyecto.

1

InformeT´cnico. e

En esta secci´n se presenta el contenido b´sico que debe poseer el informe t´cnico de un o a e proyecto, de manera que la informaci´n reflejada en el mismo de una descripci´n del producto o o que permita en todo momento conocer: ”Que ´s”, ”Que hace”, ”Como funciona” el producto e elaborado. Considero que la clave para obtener o generar una buena documentaci´n t´cnica o e r´dica en estarconsiente que la informaci´n reflejada debe permitir la reproducci´n exacta a o o del producto. 1. Descripci´n General. o • Identificaci´n del Proyecto. o • Antecedentes y Justificaci´n o • Objetivo General y Objetivos Espec´ ıficos • Resultados Esperados (vista general de la presentaci´n final del producto). o 2. Diagrama de bloques de todo el sistema. 3. Esquem´tico de todo el sistema, diferenciandocada uno delos m´dulos del sistema. a o
1

4. Descripci´n Modular. o • Descripci´n. o • Diagrama esquem´tico, diagramas de estado o vistas (depender´ de lo que se este a a presentando, un circuito, aplicaci´n o una maqueta f´ o ısica). • Lista de componentes, con especificaciones de tipo, potencia, etc. si se refiere a un programa especificar plataforma de sistema operativo para su funcionamiento,nombre y versi´n de la aplicaci´n, requerimientos de memoria, espacio en disco o o o perif´ricos indispensables para su funcionamiento, etc. e • Protocolos de pruebas para montaje y pruebas de funcionamiento del m´dulo. o 5. Lista global de componentes y an´lisis de costos para un prototipo y para su produca ci´n en masa.(Se debe mantener la misma nomenclatura o codificaci´n utilizada en las o odescripciones anteriores.) 6. Protocolos de ensamblaje general de todos los m´dulos. o 7. Protocolos de pruebas para el funcionamiento del producto.

2

Bit´cora. a

Es un registro escrito de las acciones que se llevaron acabo en cierto trabajo o tarea. Esta bit´cora incluye todos los sucesos que tuvieron lugar durante la realizaci´n de dicha tarea, a o la fallas que se tuvieron, los cambiosque se hicieron y los costos que ocasionaron. Se recomienda utilizar un Cuaderno ´ libreta de hojas tama˜o carta con todas las p´ginas o n a numeradas correlativamente, donde se vaya plasmando el desarrollo diario del proyecto. 2.1 Organizaci´n. o

Al inicio de la Bitacora es recomendable colocar una descripci´n general del producto que o se documentar´, o que informe al lector cual es el...