Universidad Simon Bolvar

Departamento de Electonica y Circuitos

Laboratorio de Proyectos III EC3883
Enero-Marzo 2007, Seccion 2.
Prof. Cecilia Murrugarra Q. cmquiroz@usb.ve
Generacion de Documentacion Tecnica.
(Informe tecnico, Protocolos de pruebas, Codicacion de programas,
Bitacora, Cronograma de proyectos.)
Este documento solo pretende ser una gua o referencia rapida para la elaboracion de doc-
umentacion tecnica de proyectos de Ingeniera. El mismo ha sido elaborado en base a mi
experiencia en la generacion de documentacion tecnica de proyectos, productos y servicios y
de conversaciones sostenidas con otros colegas que da a da se enfrentan a este reto.
Este documento ha sido organizado en cuatro secciones que describo a continuacion :
1. Informe Tecnico. En esta seccion se presenta el contenido basico que debe poseer el
informe tecnico de un proyecto.
2. Bitacora o Cuaderno de Bitacora. En esta seccion se describe que es una Bitacora
y como puede ser organizada.
3. Cronograma del Proyecto. En esta seccion se muestra una breve descripcion de los
metodos mas empleados para la generacion de cronogramas de proyectos.
4. Documentacion de Programas. En esta seccion se presenta una referencia de
la informacion que deben contener los archivos de programas generados durante la
elaboracion de un proyecto, de manera que permita rapidamente identicar ciertos
parametros de programacion y facilitar su lectura e interaccion con todos los programas
de dicho proyecto.
1 Informe Tecnico.
En esta seccion se presenta el contenido basico que debe poseer el informe tecnico de un
proyecto, de manera que la informacion reejada en el mismo de una descripcion del producto
que permita en todo momento conocer: Que es, Que hace, Como funciona el producto
elaborado. Considero que la clave para obtener o generar una buena documentacion tecnica
radica en estar consiente que la informacion reejada debe permitir la reproduccion exacta
del producto.
1. Descripcion General.
Identicacion del Proyecto.
Antecedentes y Justicacion
Objetivo General y Objetivos Especcos
Resultados Esperados (vista general de la presentacion nal del producto).
2. Diagrama de bloques de todo el sistema.
3. Esquematico de todo el sistema, diferenciando cada uno delos modulos del sistema.
1
4. Descripcion Modular.
Descripcion.
Diagrama esquem atico, diagramas de estado o vistas (dependera de lo que se este
presentando, un circuito, aplicacion o una maqueta fsica).
Lista de componentes, con especicaciones de tipo, potencia, etc. si se reere a
un programa especicar plataforma de sistema operativo para su funcionamiento,
nombre y version de la aplicacion, requerimientos de memoria, espacio en disco o
perifericos indispensables para su funcionamiento, etc.
Protocolos de pruebas para montaje y pruebas de funcionamiento del modulo.
5. Lista global de componentes y analisis de costos para un prototipo y para su produc-
ci on en masa.(Se debe mantener la misma nomenclatura o codicacion utilizada en las
descripciones anteriores.)
6. Protocolos de ensamblaje general de todos los modulos.
7. Protocolos de pruebas para el funcionamiento del producto.
2 Bitacora.
Es un registro escrito de las acciones que se llevaron acabo en cierto trabajo o tarea. Esta
bitacora incluye todos los sucesos que tuvieron lugar durante la realizacion de dicha tarea,
la fallas que se tuvieron, los cambios que se hicieron y los costos que ocasionaron.
Se recomienda utilizar un Cuaderno o libreta de hojas tama no carta con todas las paginas
numeradas correlativamente, donde se vaya plasmando el desarrollo diario del proyecto.
2.1 Organizacion.
Al inicio de la Bitacora es recomendable colocar una descripcion general del producto que
se documentara, o que informe al lector cual es el alcance deseado.
Se recomienda seguir las siguientes indicaciones para mantener cierto orden:
Identicar la fecha de inicio de cada sesion de trabajo.
Identicar en base al nombre especicado en el informe tecnico el nombre del modulo
donde se este trabajando.
Agregar las hojas de descripcion tecnica (datasheets) y anexos que Ud. considere nece-
sarios que permitan la reproduccion del prototipo en desarrollo.
En caso que se necesite eliminar informacion reejada en la Bitacora, esta debe ser
tachada, mas no eliminada del cuaderno !!.
3 Cronograma del Proyecto.
El cronograma del Proyecto muestra una descripcion cronologica de los tiempos de ejecucion
de cada una de las etapas empleadas para la elaboracion del proyecto o producto.
Anexo a la documentacion tecnica generada para el proyecto, debe presentar un esquema de
cronograma de ejecucion del proyecto, para ello utilice diagramas gantt, pert, cpm u otro
2
similar. La direccion electronica dada a continuacion muestra una explicacion y comparacion
entre los diagramas usados en la planicacion de proyectos.
http : //people.msoe.edu/ schroedp/se4900/slides/ControlCPM1.ppt
4 Codicacion de Programas.
La documentacion sugerida aplica tanto a programas, libreras o funciones.
1. Membrete Inicial. El membrete inicial debe contemplar:
El nombre y ubicacion en disco, es decir el path o lugar donde estara almacenado
el archivo y su nombre con su respectiva extension.
Descripcion general de su contenido, es decir, si es un programa indicar cual
es su funcionalidad, si es un conjunto de funciones para una aplicacion especca
que pueden ser recopiladas en un solo archivo indicar brevemente la descripcion
de cada uno de ellas, por ejemplo funciones para el uso de un puerto paralelo, se
recomienda escribir una funcion que congure el puerto, otra que escriba un dato
en puerto y otra que reciba un dato en puerto, etc.
Fecha de creacion y nombre del autor.
Fecha de modicacion o actualizacion y el nombre del autor.
Denicion del area del membrete, se recomienda colocarla al inicio de cada
programay encerrada o enmarcada entre caracteres de comentarios.
2. Nombre de las funciones. Establecer alg un tipo de codicacion en forma de nmenonico
para la asinacion de nombres de los archivos que conformen el conjunto de programas
de una aplicacion, para ello se recomienda utilizar identicadores de 3 5 caracteres
que permitan al programador identicar rapidamente su contenido.
3. Ubicacion o almacenamiento en disco de los archivos generados. Tambien es
recomendable que el programador establezca una especie de arbol no muy profundo
donde separe por direcorios el codigo fuente, los ejecutables, los archivos de datos, etc.
Para ello tambien puede usar nemonicos de tres caracteres como: src, bin,dat,lib,asm,
etc.
3