como escribir documentos tecnicos de ingenieria v13

177
FACULTAD DE INGENIERÍA ELECTRÓNICA CÓMO ESCRIBIR DOCUMENTOS TÉCNICOS DE INGENIERÍA Fabio Téllez Barón, Ernesto Sabogal Gómez, Mireya Mora 2009

Upload: pmo79

Post on 02-Jul-2015

776 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Como Escribir Documentos Tecnicos de Ingenieria v13

FACULTAD DE INGENIERÍA

ELECTRÓNICA

CÓMO ESCRIBIR DOCUMENTOS TÉCNICOS DE INGENIERÍA

Fabio Téllez Barón, Ernesto Sabogal Gómez, Mireya Mora

2009

Page 2: Como Escribir Documentos Tecnicos de Ingenieria v13

CÓMO ESCRIBIR DOCUMENTOS TÉCNICOS DE

INGENIERÍA

TABLA DE CONTENIDO

RECONOCIMIENTOS ........................................................................................ 8

PREFACIO ....................................................................................................... 9

1. REDACCIÓN DE DOCUMENTOS TÉCNICOS .............................................. 12

1.1 Calidad .............................................................................................. 12

1.2 Estructura fundamental ...................................................................... 13

1.3 Documentos y público ........................................................................ 14

1.4 Autores ............................................................................................. 17

2. ESTRUCTURA DE LOS DOCUMENTOS ...................................................... 18

2.1 Documentos académicos ..................................................................... 18

2.1.1 Propuesta inicial ............................................................................ 19

2.1.2 Anteproyecto ................................................................................ 20

2.1.3 Sustentación ................................................................................. 21

2.1.4 Documento final del trabajo de grado ............................................. 23

2.1.5 Documento final del auxiliar de investigación ................................... 30

2.2 Documentos de la actividad profesional ................................................ 31

2.2.1 Presentaciones orales .................................................................... 31

2.2.2 Artículo de revista ......................................................................... 32

3. GUÍA PARA PRESENTAR AVANCES .......................................................... 35

3.1 Encabezado ....................................................................................... 35

3.2 Alcance ............................................................................................. 36

3.3 Papel ................................................................................................ 36

3.4 Márgenes .......................................................................................... 36

3.5 Espaciado .......................................................................................... 36

3.6 Títulos ............................................................................................... 37

3.7 Encabezamiento y numeración de las páginas ....................................... 37

3.8 Tablas y figuras ................................................................................. 37

Page 3: Como Escribir Documentos Tecnicos de Ingenieria v13

3.9 Correcciones e inserciones .................................................................. 38

3.10 Formato ......................................................................................... 38

3.11 Estilo ............................................................................................. 40

3.12 Ortografía ...................................................................................... 41

4. GUÍA PARA HACER REFERENCIAS DOCUMENTALES ................................. 44

4.1 Tipos de estilos de citas y referencias .................................................. 46

4.1.1 Sistema nombre-año ...................................................................... 46

4.1.2 Sistema numérico-alfabético ........................................................... 46

4.1.3 Sistema por orden de mención ....................................................... 47

4.2 Estilos más recomendados .................................................................. 47

4.2.1 Estilo del MLA ............................................................................... 48

4.2.2 Estilo del APA ................................................................................ 49

4.2.3 Estilo del IEEE ............................................................................... 50

4.3 Estilo propuesto ................................................................................. 52

4.3.1 Estilo de citación ........................................................................... 52

4.3.2 Estilo de la lista de referencias ........................................................ 53

4.3.3 Información de los libros ................................................................ 55

4.3.4 Información de las revistas ............................................................. 56

4.3.5 Información de artículos de conferencia .......................................... 58

4.3.6 Información de documentos citados por internet .............................. 59

4.3.7 Información de otras fuentes .......................................................... 59

4.3.8 Información de la lista de referencias .............................................. 60

5. DOCUMENTACIÓN ................................................................................. 61

5.1 Clasificación de la información ............................................................. 63

5.2 Clasificación y descripción de los tipos de documentos .......................... 64

5.2.1 Documentación de planeación ........................................................ 64

5.2.2 Documentación de diseño global ..................................................... 64

5.2.3 Documentación de diseño detallado ................................................ 65

5.2.4 Documentación de implementación ................................................. 66

5.2.5 Documentación de pruebas ............................................................ 67

5.2.6 Documentación del cliente ............................................................. 67

5.2.7 Documentación de planificación y control ........................................ 68

Page 4: Como Escribir Documentos Tecnicos de Ingenieria v13

5.3 Documentación relacionada con las opciones de grado ......................... 68

5.3.1 Trabajo de grado ........................................................................... 68

5.3.2 Auxiliar de investigación ................................................................. 72

6. CÓMO HACER PRESENTACIONES ORALES ............................................... 74

6.1 Diferencias entre lo escrito y lo oral ..................................................... 74

6.2 Estructura .......................................................................................... 75

6.3 Cómo prepararse ............................................................................... 76

6.3.1 Ayudas audiovisuales ..................................................................... 77

6.3.2 Tiempo ......................................................................................... 78

6.3.3 Público ......................................................................................... 79

6.3.4 Ensayos ........................................................................................ 79

6.4 Exposición de la conferencia................................................................ 80

6.4.1 Lenguaje ...................................................................................... 81

6.4.2 Apertura ....................................................................................... 81

6.4.3 Curso de la conferencia .................................................................. 82

6.4.4 Cierre ........................................................................................... 83

6.4.5 Preguntas ..................................................................................... 84

7. BÚSQUEDA Y RECUPERACIÓN DE INFORMACIÓN ......................................... 85

7.1 Búsqueda de información .................................................................... 85

7.1.1 Definir los criterios de búsqueda ..................................................... 85

7.1.2 Formular la estrategia de búsqueda ................................................ 86

7.2 Recuperación de información .............................................................. 92

7. CÓMO ELABORAR UN ARTÍCULO PARA REVISTA ...................................... 96

8.1 Normas y políticas editoriales de la revista............................................ 98

8.2 Generalidades del artículo ................................................................... 98

8.3 Contenido del artículo ....................................................................... 101

8.4 Resumen ......................................................................................... 104

8.5 Introducción .................................................................................... 105

8.6 Desarrollo temático .......................................................................... 107

8.7 Conclusiones .................................................................................... 109

8.8 Documentación referenciada ............................................................. 110

8.9 Importancia de un manuscrito bien preparado .................................... 110

Page 5: Como Escribir Documentos Tecnicos de Ingenieria v13

9. CÓMO ESCRIBIR UN ARTÍCULO DE REVISIÓN ....................................... 111

9.1 Generalidades .................................................................................. 111

9.2 Tipos de revisiones ........................................................................... 111

9.3 Estructura ........................................................................................ 112

9.4 Fuentes de información .................................................................... 113

9.5 Búsqueda de información .................................................................. 114

9.5.1 Biblioteca universitaria ................................................................. 114

9.5.2 Internet ...................................................................................... 115

9.6 Consideraciones para revisar la literatura ........................................... 116

9.7 Proceso de elaboración ..................................................................... 117

9.8 Redacción ........................................................................................ 118

10. CÓMO ELABORAR CARTELES ................................................................ 119

10.1 Tamaño ....................................................................................... 119

10.2 Estructura .................................................................................... 120

10.3 Preparación .................................................................................. 121

10.3.1 Título ........................................................................................ 123

10.3.2 Introducción .............................................................................. 123

10.3.3 Objetivo .................................................................................... 124

10.3.4 Metodología .............................................................................. 124

10.3.5 Resultados ................................................................................ 124

10.3.6 Conclusiones ............................................................................. 124

10.3.7 Referencias bibliográficas ........................................................... 124

11. CÓMO ESCRIBIR UN ENSAYO ............................................................... 125

11.1 Escritos de investigación ................................................................ 125

11.2 Escritos de ingeniería .................................................................... 126

11.3 Definiciones .................................................................................. 126

11.4 Estructura .................................................................................... 128

11.4.1 Introducción .............................................................................. 128

11.4.2 Desarrollo ................................................................................. 129

11.4.3 Conclusión ................................................................................ 129

11.5 Aspectos formales ......................................................................... 129

11.5.1 Persona gramatical .................................................................... 129

Page 6: Como Escribir Documentos Tecnicos de Ingenieria v13

11.5.2 Formato .................................................................................... 129

11.5.3 Portada ..................................................................................... 130

11.5.4 Resumen y palabras clave .......................................................... 130

11.5.5 Introducción .............................................................................. 131

11.5.6 Desarrollo ................................................................................. 131

11.5.7 Conclusiones ............................................................................. 131

11.5.8 Referencias ............................................................................... 131

11.5.9 Extensión .................................................................................. 131

11.6 Pasos a seguir para escribir el ensayo ............................................. 131

11.6.1 Conocimiento del tema ............................................................... 131

11.6.2 Documentación ......................................................................... 132

11.6.3 Búsqueda de argumentos ........................................................... 132

11.7 Documentación complementaria ..................................................... 132

12. CÓMO ELABORAR INFORMES DE AVANCE ............................................. 134

13. CÓMO ELABORAR FIGURAS Y TABLAS .................................................. 135

13.1 Tablas .......................................................................................... 136

13.2 Figuras ......................................................................................... 136

14. CÓMO ESCRIBIR EL TRABAJO DE GRADO.............................................. 139

14.1 Resumen/Abstract ......................................................................... 141

14.2 Tabla de contenido ....................................................................... 143

14.3 Título del trabajo de grado............................................................. 144

14.4 Introducción ................................................................................. 146

14.5 Problema...................................................................................... 147

14.6 Estado del arte ............................................................................. 148

14.6.1 Bases teóricas ........................................................................... 148

14.6.2 Tecnología ................................................................................ 150

14.7 Glosario de términos ..................................................................... 151

14.8 Justificación .................................................................................. 152

14.9 Objetivos...................................................................................... 152

14.10 Requerimientos ............................................................................. 153

14.11 Metodología de desarrollo .............................................................. 155

14.12 Recursos ...................................................................................... 156

Page 7: Como Escribir Documentos Tecnicos de Ingenieria v13

14.12.1 Humanos ................................................................................ 156

14.12.2 Técnicos ................................................................................. 156

14.12.3 Institucionales ......................................................................... 156

14.12.4 Financieros .............................................................................. 157

14.12.5 Tiempo de ejecución ................................................................ 157

14.13 Cronograma de actividades ............................................................ 158

14.14 Compromisos ................................................................................ 158

14.15 Diseño global ................................................................................ 158

14.16 Diseño detallado ........................................................................... 161

14.17 Implementación ............................................................................ 162

14.18 Pruebas ....................................................................................... 163

14.19 Manuales ..................................................................................... 164

14.20 Resultados ................................................................................... 165

14.21 Discusión ..................................................................................... 166

14.22 Conclusiones ................................................................................ 166

14.23 Referencias documentales ............................................................. 167

14.23.1 Citación de libros ..................................................................... 168

14.23.2 Citación de revistas .................................................................. 169

14.23.3 Citación de internet .................................................................. 169

14.23.4 Citación de otras fuentes .......................................................... 170

14.23.5 Documentación citada .............................................................. 170

14.23.6 Anexos .................................................................................... 170

BIBLIOGRAFÍA ............................................................................................. 171

ANEXO A ..................................................................................................... 173

ANEXO B...................................................................................................... 175

ANEXO C ..................................................................................................... 177

Page 8: Como Escribir Documentos Tecnicos de Ingenieria v13

RECONOCIMIENTOS

Después de varios años de impartir el seminario de investigación a los estudiantes

de ingeniería electrónica de la Universidad El Bosque, surgió la necesidad de escribir los

procedimientos que he reunido a lo largo de los años, orientados hacia los ingenieros

quienes varias veces me manifestaron la necesidad de tener una ayuda escrita.

Algunas de las ideas que aparecen en el libro son fruto de la experiencia en

actividades de investigación y desarrollo, tanto en la Universidad del Cauca como en la

División de Investigación de Telecom. Sin embargo, también he tomado muchas de cuatro

autores que me han atraído por su claridad meridiana: Umberto Eco, Joseph Gibaldi,

Robert A. Day y Herbert B. Michaelson. He pretendido ajustar sus ideas a las necesidades

de un pregrado en ingeniería.

En este trabajo he tratado de citar cuidadosamente las fuentes, cuyos materiales

he utilizado. Pero en el transcurso de los años, al asimilar las ideas y procedimientos para

adaptarlos, no recuerdo bien de dónde las tomé y me he ido convenciendo de que muchas

son mías. Esto es más real en cuanto se refiere a las ideas tomadas de las conversaciones

que he tenido con otros colegas. Me excuso por esas fallas de la memoria.

Quiero agradecer especialmente a tres colegas. A la doctora Mireya Mora por su

paciencia para leer, discutir y sugerir cambios al original vistos desde una disciplina

diferente a la ingeniería; esta versión contiene muchas de sus sugerencias para hacer más

entendible la obra. Al ingeniero Ernesto Sabogal por su claridad y pragmatismo para

visualizar los documentos relacionados con los auxiliares de los proyectos de investigación

institucionales; además, el capítulo Guía para analizar documentos es de su autoría. Y al

ingeniero Fernando Rivera, decano de la Facultad de Ingeniería Electrónica, por su interés

en la elaboración de este libro y por sus sugerencias en los contenidos del mismo.

Page 9: Como Escribir Documentos Tecnicos de Ingenieria v13

PREFACIO

El propósito de este documento es suministrar ayuda a los ingenieros sobre la

forma correcta de escribir los trabajos técnicos que deben realizar durante su formación

académica y en su vida profesional; la lectura de estas guías aumentará la probabilidad de

que sus trabajos sean perfectamente entendidos cuando se publiquen.

El ingeniero, durante su formación, inicia una trayectoria más o menos continua y

profusa que continúa en su vida profesional: debe publicar sus trabajos. Un trabajo

científico, tecnológico, de manufactura o de cualquier otra índole no termina hasta que no

se publica. De hecho, la premisa de la ciencia es que se deben publicar los trabajos

originales; éstos serán verificados por sus pares y, posteriormente, serán añadidos a la

base de datos del conocimiento científico. Los ingenieros utilizan esa misma proposición,

por extensión, en sus trabajos. Pero sucede que su formación está llena de conocimientos

físicos, matemáticos y técnicos, y poco relacionada con las artes de la comunicación. En

consecuencia, es muy común encontrar excelentes ingenieros que son pésimos

redactores.

Para los profesionales que no hacen parte de las carreras de comunicaciones, la

manera más fácil de aprender a redactar es leyendo buena literatura. Así, poco a poco,

van adquiriendo un estilo que es imitación de la forma de escribir de los autores

preferidos. También se imita a algunos profesores. De esta forma algunos aprenden a

redactar; otros sólo asimilan los errores de redacción de sus modelos.

Cabe resaltar que se parte de una condición indispensable: para escribir un

documento el ingeniero tiene que saber qué hacer y por qué. Esto debe estar claro y

presente, siempre, en su mente.

El documento consta de varios capítulos, que se pueden agrupar según sus

propósitos. Una primera parte se refiere a la calidad de los escritos que elaboran los

ingenieros y está constituida por los siguientes apartados: a) Redacción de documentos

técnicos, donde se señalan los principios de calidad y las estructuras básicas que rigen a

Page 10: Como Escribir Documentos Tecnicos de Ingenieria v13

los escritos técnicos. b) Guía para presentar avances, donde se describe el formato básico

de uso para puntualizar el adelanto alcanzado; aplicable a cualquiera de los documentos

específicos tratados. c) Estructura de los documentos, que describe la estructura básica de

los diferentes trabajos universitarios que conducen al grado –propuesta inicial,

anteproyecto, trabajo de grado, auxiliar de investigación- y otros documentos que aplican

tanto al ámbito universitario como profesional. d) Guía para hacer referencias

documentales, que enfatiza la importancia de citar las fuentes; presenta las partes que

constituyen el cuerpo de las referencias documentales para cada uno de los medios más

utilizados. e) Función del trabajo de grado, que muestra las habilidades y destrezas que

adquieren los ingenieros cuando elaboran sus trabajos de grado o cuando participan en

actividades relacionadas con su formación como investigadores; también destaca la

necesidad de documentar todos los trabajos de ingeniería.

Una segunda parte contiene los capítulos relacionados con la búsqueda,

recuperación y análisis de la documentación de soporte. Esta parte se relaciona,

habitualmente, con las actividades de investigación, desarrollo e innovación –I+D+i- y sus

documentos conexos, pero aplica a muchas otras actividades. a) Búsqueda y recuperación

de información, que muestra el proceso a seguir para obtener referencias bibliográficas de

calidad. b) Guía para analizar documentos, que indaga si cada documento encontrado es

relevante para ayudar a la solución del problema objeto de investigación y, en caso

afirmativo, muestra cómo analizarlo.

La tercera parte trata de los documentos más utilizados por los ingenieros. a)

Cómo hacer presentaciones orales, que bosqueja la estructura de la exposición, destaca la

concisión requerida y plantea el buen uso de los medios disponibles. b) Cómo escribir un

artículo de revista, donde se pone de manifiesto la estructura y contenido del mismo, y se

destaca la necesidad de conocer el público destinatario y las exigencias de forma

impuestas por los editores de la revista. c) Cómo escribir un artículo de revisión; de gran

utilidad al elaborar el estado del arte de una disciplina. d) Cómo elaborar informes de

avance, para dar a conocer el estado de un proyecto según el cronograma original

propuesto. e) Cómo elaborar carteles, que destaca la estructura y síntesis necesarias para

resumir un proyecto en una hoja, como alternativa a las presentaciones orales. f) Cómo

escribir un ensayo, que suministra los fundamentos para realizar un ensayo en ingeniería.

Page 11: Como Escribir Documentos Tecnicos de Ingenieria v13

g) Guía para elaborar tablas y figuras, donde se tratan los puntos esenciales para construir

estas ayudas, integrándolas al cuerpo del escrito desde su fase de planeación.

Finalmente se relaciona el trabajo de grado: Guía para escribir el trabajo de grado,

que describe los capítulos que lo constituyen y sus contenidos.

La última parte se relaciona con el fraude: Cómo controlar el fraude, que destaca

los principios éticos a tener en cuenta cuando se publica un trabajo.

También se incluyen algunos anexos con contenidos ligados al cuerpo del

documento:

a. Obras de referencia seleccionadas en ingeniería

b. Sistema internacional de medidas y sus símbolos

c. Ejemplo de un paper original

A los ingenieros interesados en profundizar el tema se les recomienda leer los

siguientes libros: el del doctor Umberto Eco (Eco, 1996, XIX edición) titulado Cómo se

hace una tesis, quizás el libro de más éxito, que trata de la elaboración de una tesis

doctoral en humanidades. El ejemplo que sigue a lo largo de todo el libro ilustra bien los

procesos de búsqueda de información, tipos y manejo de fichas, elaboración de la

estructura del documento y organización de la documentación. En segundo lugar, el del

doctor Robert A. Day (Day, 2003) titulado Cómo escribir y publicar trabajos científicos, que

se refiere a los artículos que contribuyen al avance del conocimiento. Y en tercer lugar, el

del doctor Herbert B. Michaelson (Michaelson, 1990), titulado How to Write and Publish

Engineering Papers and Reports, relacionado con los documentos de postgrado y de la

actividad profesional de los ingenieros. En esos documentos encontrarán también una

buena bibliografía relacionada con el tema. Sin embargo, hay que tener en cuenta que el

público destinatario de los documentos mencionados son los doctores; en menor escala

los maestros, y, extrapolando, los ingenieros y los estudiantes de pregrado.

Page 12: Como Escribir Documentos Tecnicos de Ingenieria v13

1. REDACCIÓN DE DOCUMENTOS TÉCNICOS

El prestigio de un ingeniero está fundamentado en la calidad de todos y cada uno

de sus trabajos. A los documentos técnicos elaborados por él se les exigen los mismos

estándares de calidad que a sus otros productos; cada manuscrito técnico refleja la

reputación de su autor. Sin embargo, es muy frecuente que los autores de buenos

trabajos técnicos sean muy descuidados con la redacción del documento final de soporte.

Esto desdice de la calidad del trabajo de esos ingenieros.

Un escrito técnico es inútil si no es recibido y entendido por el público a que se

destina; la publicación no basta si el documento no se entiende. Aunque no se pretende

que un trabajo técnico sea una obra literaria, sí se busca que su estilo sea tan diáfano y

directo como sea posible; que las palabras que llevan el mensaje al lector sean claras,

sencillas, ordenadas y con significado.

En este apartado se tratarán varios aspectos que inciden en la redacción de los

documentos técnicos: los criterios de calidad; su estructura organizacional; el público

destinatario; y los autores.

1.1 Calidad

La calidad de un documento técnico está relacionada con su contenido, estructura

organizacional, estilo, validez y significado (Eco, 1996, 177-260), (Day, 1996, 1-7),

(Michaelson, 1990, 1-6) y (Gibaldi, 2000, 1-46).

Cuando se está en la fase de planeación, cuando se plantean el problema a

solucionar y los alcances del proyecto, se está en contacto directo con el contenido del

trabajo a realizar, y, en ese instante, se toman las medidas que garanticen la calidad de la

documentación. Si, por el contrario, su elaboración se deja pendiente para cuando se haya

terminado el resto del trabajo, entonces su calidad queda comprometida.

La redacción de documentos técnicos exige, ante todo, claridad. Con este fin se

requiere una mente ordenada que formule concretamente el problema a tratar, lo

Page 13: Como Escribir Documentos Tecnicos de Ingenieria v13

delimite, plantee una propuesta de solución, defina sus objetivos y requerimientos, y

proponga la metodología de desarrollo que lo lleve a las conclusiones esperadas.

Pero la claridad no es suficiente. Se deben redactar documentos que también sean

legibles y concisos. La legibilidad depende del uso apropiado del lenguaje técnico y de la

concatenación de las ideas desarrolladas a través de las frases y parágrafos del

documento. La concisión es importante para redactar documentos libres de información

ajena al punto central del trabajo.

Cuando se escribe por primera vez un documento, es frecuente que se redacten las

ideas sin tener en cuenta estos principios. Es necesario releerlo y reescribirlo varias veces

para ir puntualizando las ideas expuestas hasta que éstas ganen en claridad, legibilidad y

concisión; el trabajo de redacción es iterativo. Sólo así los lectores podrán recibir

documentos redactados en forma impecable.

1.2 Estructura fundamental

Por otra parte (además de la claridad, legibilidad y concreción), es necesario

ordenar bien los documentos. En ese sentido se parte del principio de organización del

artículo científico -Introducción, Métodos, Resultados y Discusión- llamado IMRYD, que se

aclara con las siguientes preguntas (Mackerle, 6):

• ¿Qué problema se estudió?: La respuesta está en la Introducción.

• ¿Cómo se estudió el problema?: La respuesta está en los Métodos.

• ¿Cuáles fueron los resultados o hallazgos?: La respuesta está en los

Resultados.

• ¿Qué significan esos resultados?: La respuesta está en la Discusión.

Pero los ingenieros, en general, no producen nuevos conocimientos. Buena parte

de sus trabajos están orientados a desarrollar soluciones a problemas concretos de

ingeniería que pueden concluir en dispositivos, materiales, sistemas o procesos. También

buscan aplicaciones prácticas de conocimientos existentes, desarrollo de nuevos métodos,

establecimiento de estándares, control de calidad de procesos de manufactura,

confiabilidad de los sistemas, control de elementos y materiales adquiridos, etc.

Page 14: Como Escribir Documentos Tecnicos de Ingenieria v13

Para divulgar los resultados de sus proyectos los ingenieros utilizan un tipo de

documento (llamado paper en la cultura anglosajona) que tiene una estructura bien

definida –Introducción, Desarrollo, Conclusiones y Discusión-, análoga a la del artículo

científico. En él se parte de una Introducción, se continúa con el Desarrollo bien

organizado, se llega a la sección de Conclusiones y se realiza la Discusión de los

resultados. Esta estructura se complementa con un breve Resumen o abstract y con la

Documentación de Referencia.

La Introducción incluye el problema, sus antecedentes y la aproximación del autor

a la posible solución. Para el orden u organización del apartado de Desarrollo se escoge el

tema principal, que se convierte en su espina dorsal, y se apuntala con otras secciones

menores o complementarias; aquí se encuentra el grueso de la actividad. La sección de

Conclusiones resume los resultados y su significado, tomando en cuenta los trabajos

previamente desarrollados. Y, finalmente, la sección de Discusión presenta los aspectos

positivos y negativos del proyecto, lo que la solución puede hacer y lo que no puede

hacer; a veces se incluyen las alternativas de solución al problema de ingeniería planteado

y las razones que llevaron a la alternativa seleccionada.

Una excepción aparente a la estructura anterior es la que presenta, a primera

vista, el trabajo de grado. La estructura anterior parece diluirse, pues los trabajos de

grado son una forma más detallada y extensa de contestar las preguntas del paper - se

utilizan 22 apartados, ver capítulo decimosexto-. Se puede decir que el trabajo de grado

es una forma de aprendizaje que siguen los estudiantes de pregrado para, posteriormente,

estar en capacidad de resumir sus trabajos de ingeniería en documentos más concisos.

Empero, si se abstraen los contenidos, el trabajo de grado contiene también las cuatro

secciones fundamentales mencionadas antes: el contenido de la Introducción se desarrolla

en las secciones que van del problema a los requerimientos; el Desarrollo se hace en las

secciones que van del diseño global a los manuales de usuario; después vienen los

Resultados, su Discusión y las Conclusiones.

1.3 Documentos y público

En general, cuando se va a escribir un manuscrito sobre un trabajo de ingeniería

hay que reflexionar tanto sobre los objetivos del proyecto como sobre las motivaciones

que se tienen para elaborar el documento. Los objetivos del proyecto son diferentes a los

Page 15: Como Escribir Documentos Tecnicos de Ingenieria v13

objetivos del documento: en aquél son inherentes al trabajo propuesto y en éste se

ajustan a las necesidades del público destinatario.

En un trabajo de grado, los objetivos están relacionados con el problema y su

solución. Pero los trabajos, una vez terminados, deben ser examinados para que sean

publicados; ese análisis lo hacen el director, los jurados y los asesores. Por lo tanto, su

escritura, paralela al desarrollo del producto, está orientada para satisfacer a su público

primario: director, jurados y asesores.

No ocurre lo mismo en la vida profesional. Por un lado, los objetivos del proyecto

pueden ser, como se mencionó anteriormente, la búsqueda de aplicaciones prácticas de

conocimientos existentes, el desarrollo de nuevos métodos, el establecimiento de

estándares, el control de calidad de procesos de manufactura, la confiabilidad de los

sistemas, el control de elementos y materiales adquiridos, etc.-. Y, por otro lado, las

motivaciones para escribir el documento pueden ser: la necesidad de documentar el

diseño y operación del sistema; la necesidad de reconocimiento de sus pares; la

publicación de su trabajo en una revista de prestigio; la asistencia a un simposio o

congreso como ponente para ser publicado en las memorias del mismo; etc. En

consecuencia, la combinación de esos objetivos diferentes –el del trabajo y el del

documento- hace necesario que se varíe la orientación del manuscrito, su énfasis.

Por lo tanto, es necesario tener en cuenta el público a quien va dirigido el

documento. ¿Quiénes son ellos? ¿Cuál es su disciplina de formación? ¿Cuál es su nivel de

formación? ¿Cuál es su interés?, etc.

Así, aunque, a primera vista, el público de un trabajo de grado parece estar

conformado por el director, los jurados y asesores, y otros estudiantes y profesores

interesados en el tema. Sin embargo, es claro, que cuando se está redactando el

documento se está escribiendo para el director, los asesores y los jurados, quienes

aprueban o no el proyecto.

Cuando se va a publicar en una revista es necesario conocer el interés de sus

lectores. Una buena práctica es revisar la tabla de contenido de los números anteriores de

esa publicación seriada; allí se encuentra información sobre los temas de interés de la

revista, así como instrucciones normativas a seguir por los autores; esto ayuda.

Page 16: Como Escribir Documentos Tecnicos de Ingenieria v13

Cuando se va a participar en un simposio o congreso, existen instrucciones de los

organizadores sobre los temas de interés y la presentación de documentos en cuanto a

tamaño, formato y fechas de remisión. También es necesario conocer un poco más sobre

los asistentes al simposio; esta información se encuentra en la convocatoria y publicidad

del evento.

Existen otros medios de publicación diferentes a los mencionados. En cada caso

específico es necesario analizar el público destinatario para ajustar la estructura y

orientación del documento. En la afinación de esa indagación puede estar el éxito o el

fracaso de cualquier tipo de presentación.

En resumen, se debe buscar empatía con el público. Por ejemplo, si se supone que

el trabajo reciente de un ingeniero versa sobre las aplicaciones prácticas de una nueva

tecnología, el énfasis del escrito se podría orientar según los intereses del público

esperado; ver tabla 1.1.

Tabla 1.1. Énfasis del documento según el público

Interés básico del público

Énfasis del documento

Interés en la nueva tecnología • Tendencias actuales de diseño

• Aplicaciones potenciales de la

nueva tecnología

Mejores métodos • Diseño básico usando la nueva

tecnología

• Menores costos

Productos más eficientes • Ventajas del uso de la nueva

tecnología

Más información de soporte sobre

el tema

• Referencias bibliográficas

Si el autor identifica el interés básico del público, entonces obtiene los puntos a

enfatizar en su documento para satisfacer las expectativas de sus lectores. Así, por

ejemplo, si al público le interesa obtener o manufacturar productos más eficientes,

Page 17: Como Escribir Documentos Tecnicos de Ingenieria v13

entonces su interés primario discurrirá sobre las ventajas que se pueden obtener con el

uso de la nueva tecnología.

1.4 Autores

Por otra parte, cuando el trabajo es conjunto, es necesario aclarar desde un

principio cuál será el orden de los autores (Day, 1996,21-27). Normalmente se considera

que el primer autor es el que tuvo mayor incidencia en el mismo; el segundo un poco

menos; y así sucesivamente.

Es una práctica normal que los autores aparezcan en el trabajo final en orden

alfabético. Sin embargo, esa situación no refleja siempre ni el conocimiento ni el esfuerzo

realizado por cada uno de los miembros del grupo, lo que no es justo. Por lo tanto, surge

la pregunta: ¿quién es el autor principal en un trabajo y en qué orden deben aparecer los

demás? El orden de los autores debe hacerse teniendo en cuenta los aportes de cada uno

a la solución del problema planteado. En consecuencia, sólo deberá utilizarse el orden

alfabético en aquellos casos en que todos han hecho aportes similares.

En un grupo de trabajo académico constituido por varios investigadores en

formación, la cabeza visible del grupo es el director del trabajo, quien orienta/vigila las

decisiones técnicas que se tomen. Al nivel de los investigadores en formación es normal

que exista un investigador responsable de coordinar las actividades de los demás

miembros del grupo. Existe, pues, una pequeña estructura de mando, que debe

relacionarse con el conocimiento aportado y el esfuerzo realizado.

La falta de atención a este aspecto lleva, a veces, a divergencias que crean

malestar en el grupo. Ante todo: claridad; el orden de los autores debe mostrar las ideas y

esfuerzos aportados.

Page 18: Como Escribir Documentos Tecnicos de Ingenieria v13

2. ESTRUCTURA DE LOS DOCUMENTOS

Una de las primeras cosas que se hace antes de empezar a escribir es trazar el

mapa de ruta del documento, definir su estructura. Es decir, elaborar el índice final del

escrito.

Esta decisión puede parecer apresurada, pero, por otra parte, le obliga a

preguntarse si las ideas que tiene son claras o no; se pueden tener definidos los puntos de

partida y el final, pero el camino entre los dos extremos puede ser nebuloso. Este es el

punto a aclarar cuando se plantea la estructura del escrito.

A lo largo de su vida, el ingeniero debe elaborar documentos propios de su

formación académica, otros afines con su actividad profesional y otros que aplican en

ambos terrenos. La mayoría de los escritos de ingeniería caben perfectamente en la

estructura básica definida para el llamado paper: introducción, desarrollo, conclusiones y

discusión.

En este capítulo se mostrará la organización de los documentos más conocidos.

Algunos ya tienen su estructura definida, que, además, es aceptada por la mayoría de las

instituciones. Habrá otros documentos, los menos, en que será necesario elaborarla.

2.1 Documentos académicos

En los últimos semestres de su carrera el estudiante debe elegir su opción de

grado: desarrollar un trabajo de grado o participar en un proyecto institucional de

investigación donde inicia su formación como auxiliar. Cualquiera que sea su decisión,

deberá elaborar una serie de documentos que soporten el trabajo ejecutado.

El trabajo de grado se desarrolla por etapas y consta de los siguientes

documentos:

1. Propuesta inicial,

2. Anteproyecto,

3. Sustentación y

4. Documento final

Page 19: Como Escribir Documentos Tecnicos de Ingenieria v13

Si trabaja como auxiliar de investigación, según el estado de avance del proyecto

institucional, elabora documentos, tales como:

1. Ayuda de la planeación de su objetivo puntual (anteproyecto),

2. Búsqueda y recuperación de información,

3. Análisis de documentos,

4. Artículo de revisión,

5. Diseño,

6. Implementación,

7. Pruebas y

8. Documento final de soporte de sus actividades como auxiliar

2.1.1 Propuesta inicial

Las líneas de investigación plantean una serie de temas de grado para que los

estudiantes los analicen y, si están interesados, tomen uno de ellos para desarrollar su

trabajo de grado. Empero también los estudiantes pueden presentar una propuesta inicial,

independiente de las líneas de investigación, siempre y cuando obtengan el apoyo de un

profesor.

La propuesta inicial tiene la siguiente estructura:

1. Línea de investigación

2. Título provisional

3. Descripción general del proyecto:

3.1. Problema

3.2. Aspectos a solucionar: del espectro amplio del problema, concretar

cuáles son los puntos a solucionar

3.3. Arquitectura de la solución propuesta: diagrama de bloques

4. Justificación del proyecto

5. Objetivos:

5.1. General

5.2. Específicos

6. Recursos necesarios:

6.1. Humanos: estudiantes, director y asesores

Page 20: Como Escribir Documentos Tecnicos de Ingenieria v13

6.2. Técnicos: hardware, software, caja, cableado, circuitos impresos,

impresión, etc.

6.3. Institucionales: documentación, equipo de laboratorio, espacio en los

laboratorios, etc.

6.4. Financieros: costo del sistema a desarrollar; como si fuera a ser

implantado

6.5. Tiempo de ejecución: se calcula una dedicación de 10 horas por

semana para cada estudiante

7. Cronograma

8. Documentación básica: sobre el tema problema

2.1.2 Anteproyecto

Una vez aprobada la propuesta inicial se inicia el desarrollo del anteproyecto; con

el que termina la planeación del trabajo de grado.

Su estructura es la siguiente:

1. Título

2. Introducción

3. Tema del trabajo:

3.1. Definición del problema

3.2. Estado del arte:

3.2.1. Bases teóricas

3.2.2. Tecnología

3.3. Glosario de términos

3.4. Justificación

4. Objetivos:

4.1. General

4.2. Específicos

5. Requerimientos

6. Metodología de desarrollo

7. Recursos:

7.1. Humanos

Page 21: Como Escribir Documentos Tecnicos de Ingenieria v13

7.2. Técnicos

7.3. Institucionales

7.4. Financieros

7.5. Tiempo de ejecución

8. Cronograma de actividades

9. Compromisos

10. Documentación de referencia

11. Anexos

En la Guía para escribir el documento de trabajo de grado, capítulo decimosexto,

se encuentran los contenidos y las indicaciones para elaborar cada uno de los apartados

enunciados.

2.1.3 Sustentación

Los capítulos de ejecución del trabajo de grado son: diseño, implementación y

pruebas. En ese momento se puede comprobar si el sistema trabaja según lo especificado

o no; de ser necesario, se le hacen los ajustes o las modificaciones convenientes. Una vez

hechas las pruebas iniciales de funcionamiento –en protoboard-, se elaboran los circuitos

impresos definitivos y se hacen las pruebas de aceptación; para ejecutarlas se requiere

que los manuales de usuario ya estén elaborados

El documento contiene los capítulos nuevos y los desarrollados que son

pertinentes. Su estructura es:

1. Resumen/Abstract

2. Título del proyecto

3. Introducción

4. Definición del problema

5. Estado del arte:

5.1. Bases teóricas

5.2. Tecnología

6. Glosario de términos

7. Justificación

Page 22: Como Escribir Documentos Tecnicos de Ingenieria v13

8. Objetivos:

8.1. General

8.2. Específicos

9. Requerimientos

10. Diseño global

11. Diseño detallado

12. Implementación

13. Pruebas

14. Manuales de usuario

15. Resultados

16. Discusión

17. Conclusiones

18. Referencias documentales

19. Anexos

Sin embargo, las secciones indicadas corresponden a un trabajo típico que termina

en un dispositivo, equipo o sistema – en adelante se hablará de sistema-; pero no todos

terminan en un equipo concreto. En este sentido, los proyectos se pueden clasificar en

tres grupos, a saber:

• Uno, que termina en un sistema

• Otro, que puede concebirse como estudio de preingeniería

• Y el tercero, concerniente a un trabajo teórico

Veamos cómo se modifica esa estructura en cada caso:

• Un trabajo que termine en un sistema contiene cada uno de los 19

apartados mencionados arriba.

• Un proyecto que termine en un estudio de preingeniería contiene las

secciones iniciales, hasta el diseño global. Los apartados de diseño

detallado, implementación, pruebas y manuales no aplican; en su lugar, a

partir del diseño global, se hacen las especificaciones o requerimientos del

sistema que se implantaría en caso de que el estudio se lleve a cabo. Con

Page 23: Como Escribir Documentos Tecnicos de Ingenieria v13

esa información se hace un estudio de costos, y, finalmente, se calcula la

viabilidad del mismo.

En los estudios de preingeniería no debe haber confusión en cuanto al

capítulo de requerimientos, que se trata dos veces y en forma diferente.

Por primera vez, en el apartado de requerimientos del anteproyecto –fase

de planeación del proyecto-, donde se trata de especificar detalladamente

el contenido mínimo de cada una de las secciones del desarrollo. Y por

segunda vez, en las especificaciones o requerimientos del sistema a

implantar -fase de ejecución-, que fija las características técnicas y los

valores mínimos solicitados.

• En un estudio teórico se siguen los mismos lineamientos del estudio de

preingeniería. Los capítulos de ejecución -diseño detallado, implementación,

pruebas y manuales-, se reemplazan según se indica en el capítulo de

requerimientos; allí se plantean cuántas son las secciones de ejecución,

cómo se titulan y qué contenido tienen.

Una forma rápida de saber cuántas secciones puede contener la fase de

ejecución de un estudio teórico es hacer una relación unívoca entre

aquellas y cada uno de los objetivos específicos del proyecto.

2.1.4 Documento final del trabajo de grado

El documento final de un trabajo de grado tiene una serie de formalidades que le

imprimen un carácter más solemne. Es el documento para guardar y mostrar; se empasta

y se entrega oficialmente a la universidad.

Una vez que se ha sustentado el trabajo de grado, se hacen los ajustes finales

solicitados por los jurados y se entrega el documento final. El formato del trabajo final no

difiere mucho del que se ha seguido hasta el momento; sólo se agregan las páginas

iniciales de presentación, los índices de tablas y figuras, y se modifican los márgenes

izquierdo y derecho para facilitar la lectura luego de que se empaste.

A continuación se indican los puntos a tener en cuenta en el documento final del

trabajo de grado. Éstos son similares en todas las universidades; aquí se utiliza, como

ejemplo, el documento final de la Facultad de Ingeniería Electrónica de la Universidad El

Bosque.

Page 24: Como Escribir Documentos Tecnicos de Ingenieria v13

a. Portada o página titular

Es la primera página de un trabajo de grado; es la presentación del documento e

indica quienes son los autores y la institución. Se presenta de manera sobria, distribuida

en tal forma que agrade; se evade todo tipo de adorno y se ciñe a la presentación de los

elementos que la componen, que van centrados.

La página titular consta del título del trabajo, el nombre del autor o autores, la

universidad, la facultad, los créditos institucionales, notas de confidencialidad o restricción

de la información, la ciudad y la fecha de terminación del trabajo.

Los datos deben ir centrados en la hoja.

• Título

Se ubica a siete (7) centímetros del borde superior de la hoja; si se tiene

subtítulo éste irá debajo del título. Debe ir en mayúsculas fijas, con tildes,

centrado y en negrilla. El tipo de letra es tahoma, tamaño 14.

• Autores

Los autores se presentan con nombres y apellidos completos; se ordenan

según su grado de participación en el trabajo de grado: el autor principal va

primero y después los demás. Si se quiere se pueden escribir los dos

apellidos.

Deben ir centrados, en negrilla, en tahoma 12, con mayúsculas en las

iniciales. Si desea reconocer las contribuciones de otros investigadores (por

ejemplo, asesoría temática o metodológica, análisis estadísticos, revisión o

supervisión del manuscrito), se puede hacer con una nota en la página de

agradecimientos. Para los pies de página se usan números con letra

tahoma 10.

La autoría se reserva para quienes hicieron una contribución importante y

asumen la responsabilidad en la publicación del trabajo. La autoría no solo

se refiere a aquellas personas que lo escribieron, sino también a aquellos

que hicieron importantes contribuciones científicas al estudio. El autor

principal será el responsable legal del mismo y tendrá las responsabilidades

legales que de él se deriven. Quienes lo deseen podrán consultar la norma

Page 25: Como Escribir Documentos Tecnicos de Ingenieria v13

emitida en la circular 6 de 2002 sobre derechos de autor en el ámbito

universitario, disponible en la División de Investigaciones.

• Vinculación institucional

La vinculación identifica a la institución donde el autor o autores condujeron

la investigación. Cuando se incluye más de una institución es porque

ambas han financiado de forma sustancial el estudio o bien la financió una

pero la investigación tuvo lugar en otra. A renglón seguido se debe escribir

la facultad o el departamento al cual pertenecen el autor o autores,

dejando la margen correspondiente. Este nombre debe anotarse de la

manera más completa posible, conservando el orden jerárquico de la

institución.

Ejemplo:

• Universidad

• Facultad

• Programa

b. Página de identificación

Contiene los siguientes puntos:

• Universidad

• Facultad

• Línea de investigación

• Título del proyecto

• Instituciones participantes

• Tipo de investigación (institucional, mixta, pregrado, postgrado, docente)

• Investigador principal

• Investigadores asociados

• Asesores temáticos

• Asesor metodológico

Page 26: Como Escribir Documentos Tecnicos de Ingenieria v13

c. Página de aprobación

Cuando los proyectos corresponden a trabajos de grado, se incluye una página en

original con el Acta de Grado. Esta presenta la categoría de aprobación y las firmas del

director del proyecto, jurados y secretario de la Facultad.

d. Nota de salvedad de responsabilidad institucional

Todos los proyectos incluyen una hoja en la cual se define el alcance de la

responsabilidad institucional, que debe decir:

“La Universidad El Bosque no se hace responsable de los conceptos emitidos por

los investigadores en su trabajo, solo velará por el rigor científico, metodológico y ético del

mismo en aras de la búsqueda de la verdad y la justicia”.

e. Página de agradecimiento

Se debe hacer el reconocimiento a las personas y a las instituciones que ayudaron

en la realización del proyecto.

f. Hoja de dedicatoria (opcional)

Corresponde al espacio en el cual el autor puede expresar afectivamente en honor

a qué personas o instituciones realizó el trabajo.

g. Resumen

A partir de este numeral aparecen los demás numerales pertenecientes al trabajo

de grado, como se indica en la sección 16 de este documento. Allí se indica qué debe

contener cada uno de ellos y se dan, si es del caso, algunos ejemplos. En este capítulo

solo se mencionan los aspectos de forma del trabajo definitivo.

Debe:

• Ir sin título de resumen.

• Se pone sangría de 2.7 cm a ambos lados.

• En tahoma 10.

• Al final se deben citar máximo cinco palabras clave o descriptores primarios.

h. Abstract

Corresponde al resumen traducido al inglés, con los mismos requisitos.

Page 27: Como Escribir Documentos Tecnicos de Ingenieria v13

i. Tabla de contenido

Señala el orden sistemático seguido en el trabajo y representa la estructura del

mismo. Delimita los diversos aspectos del trabajo y señala el número de la página en

donde aparece cada uno de ellos.

Se debe evitar usar esquemas con muchas subdivisiones; utilizar máximo tres.

j. Lista de tablas y gráficas

Aparecen después de la tabla de contenido; indican la numeración y título de las

tablas y gráficas con la respectiva página donde se encuentran.

k. Estructura general del trabajo

a. Normas generales

• Texto justificado en Word

• Tahoma 11

• Párrafo: a 1.5 espacios

• Espaciado entre líneas: a uno y medio (1.5) espacios

• Sangría: formato de párrafo con sangría especial (primera línea) a 1.25 cm

• Márgenes: hasta antes de empastar la página se configura a 2.5 cm en

todos sus márgenes (arriba, abajo, derecha e izquierda); para la

encuadernación se varían los márgenes izquierdo y derecho: izquierda a 3 y

derecha a 2 cm.

• Numeración: se ubica el número centrado en la parte inferior de cada hoja

indicando el número de página sobre el total de páginas del documento.

• Encabezados: a la izquierda, el título del trabajo; a la derecha, los autores.

b. Titulación

• Titulación principal: la que abre la sesión -introducción, metodología,

diseño, desarrollo, pruebas y referencias, etc.- va centrada, en negrilla, en

mayúsculas y en letra tahoma de 14 puntos.

• La titulación de segundo nivel va a la izquierda, sin mayúsculas, en cursiva,

en negrilla y en letra tahoma de 13 puntos.

• La titulación de tercer nivel va a la izquierda, sin mayúsculas, normal, sin

negrilla y en letra tahoma de 12 puntos.

Page 28: Como Escribir Documentos Tecnicos de Ingenieria v13

• Las subdivisiones adicionales van en letras.

• Para los proyectos no empíricos, revisiones y ensayos, se admite la

numeración de títulos principales en números romanos; los títulos

subsiguientes en número arábigos y las subdivisiones adicionales en letras.

c. Pie de página

• Letra tahoma de 10 puntos, como superíndice.

• Se usan para poner cosas importantes de los autores como, por ejemplo:

o Dónde trabaja, cuándo escribió el artículo

o Tipo de trabajo

o Correo electrónico (E-mail)

d. Tablas y figuras

Tabla: presenta la información ordenada en filas y columnas. No se usa el

término: cuadro.

• Toda tabla tiene un título comprensible; no se usan abreviaturas.

• Tiene el nombre arriba:

• Las tablas se numeran con números arábigos sucesivos. No

se escribe ni la palabra número ni las abreviaturas No. o #.

• El nombre de la tabla va en letra cursiva; la primera letra en

mayúscula.

• La tabla no debe tener líneas verticales; sólo horizontales.

• Cada fila y cada columna debe tener un nombre.

• Las variables deben ir acompañadas de su unidad.

• Las notas y explicaciones de la tabla, van en la parte inferior; se

usan asteriscos para indicar la parte a la que la nota hace

referencia.

Figuras: información gráfica que se presenta en ejes de coordenadas o

esquemas.

• Toda figura tiene un título comprensible, sin abreviaturas.

Page 29: Como Escribir Documentos Tecnicos de Ingenieria v13

• No se usan los términos: gráfica, foto, mapa, dibujo, esquema,

radiografía.

• Cada eje de coordenadas tiene indicado el nombre de la variable y la

unidad de medida.

• Las barras que representan promedios llevan una línea delgada,

centrada y proporcional que corresponda a la desviación estándar;

no al error estándar.

• Las figuras se titulan abajo, así:

• Figura 1… (en números arábigos), y a continuación el

nombre de la figura en el mismo renglón, en letra cursiva.

No se escribe ni la palabra número ni las abreviaturas No. o

#.

• La figura no tiene recuadros o marcos, y va centrada.

Las figuras y tablas deben estar citadas dentro del texto.

l. Capítulos del trabajo de grado

Corresponde a los diferentes apartados del trabajo de grado. En cuanto al

contenido, se sigue lo indicado en la sección decimosexta, y, en cuanto a la forma, lo

mencionado en la Guía para presentar avances, sección quinta. Los capítulos que debe

contener el trabajo de grado son:

1. Resumen/Abstract

2. Título del proyecto

3. Introducción

4. Definición del problema

5. Estado del arte

6. Glosario de términos

7. Justificación

8. Objetivos:

8.1. General

8.2. Específicos

9. Requerimientos

Page 30: Como Escribir Documentos Tecnicos de Ingenieria v13

10. Diseño global

11. Diseño detallado

12. Implementación

13. Pruebas

14. Manuales de usuario

15. Resultados

16. Discusión

17. Conclusiones

18. Referencias documentales

19. Anexos

2.1.5 Documento final del auxiliar de investigación

El auxiliar de investigación desarrolla una serie de actividades de apoyo en los

proyectos institucionales de investigación. Esas actividades se documentan y, al final de su

trabajo, hace una presentación formal de sus realizaciones a los investigadores del grupo.

Una vez que se ha presentado el trabajo como auxiliar de investigación, se hacen

los ajustes finales solicitados por el investigador principal y los demás profesores

investigadores del grupo de investigación, y se entrega el documento final. El formato del

trabajo final del auxiliar de investigación no difiere del que se sigue en el trabajo de grado

y se pueden seguir las indicaciones indicadas para éste en el numeral anterior. Sin

embargo, su estructura es más corta y el documento es más conciso.

Los capítulos que contiene son:

1. Resumen/Abstract

2. Título específico del proyecto

3. Introducción

4. Definición del problema

5. Glosario de términos

6. Objetivos:

6.1. General

6.2. Específicos

7. Requerimientos

8. Desarrollo

9. Resultados

Page 31: Como Escribir Documentos Tecnicos de Ingenieria v13

10. Discusión

11. Conclusiones

12. Referencias documentales

13. Anexos

2.2 Documentos de la actividad profesional

Existen otros documentos que pueden utilizarse tanto en el mundo académico

como en el laboral. Aunque la estructura de éstos escritos está definida en el primer nivel,

los detalles del índice del documento, en el segundo y tercer nivel, no están definidos. En

ese aspecto hay diferencias marcadas entre los dos tipos de manuscritos. En

consecuencia, el autor del documento debe elaborar el plan de trabajo detallado antes de

empezar a escribir.

Con este fin, Michaelson propone al autor que se haga las siguientes preguntas,

cuyas respuestas le ayudarán a establecer la ruta a seguir:

• ¿Cuáles son las ideas principales que quiere presentar en el documento?

• ¿Cuáles ideas sirven de apoyo a las principales?

• ¿Cuáles detalles se deben incluir?

• ¿En dónde debe estar el énfasis del artículo? ¿En los datos, en el diseño, en

la aplicación, en las recomendaciones, etc.?

• ¿Cuál es la longitud del documento?

• ¿Qué figuras y tablas se deben incluir?

A continuación se presentan los documentos de más uso.

2.2.1 Presentaciones orales

El ingeniero no sólo tiene que hacer trabajos y escribirlos; también tiene que

realizar presentaciones orales sobre sus trabajos en diferentes escenarios. Hace

presentaciones ante sus compañeros de clase u oficina, y expone en simposios,

seminarios, congresos y juntas directivas, por ejemplo.

Toda exposición oral debe tener una estructura. La mejor guía para su

organización es seguir el mismo orden lógico que se utiliza en los documentos escritos.

Page 32: Como Escribir Documentos Tecnicos de Ingenieria v13

Dado el breve tiempo que se asigna, normalmente, a una presentación oral, ésta

debe cumplir la función de un informe auténticamente preliminar. En consecuencia, la

estructura debe facilitar la agilidad del discurso:

1. Plantear el problema

2. Exponer la solución, sin gran detalle

3. Mostrar los resultados

4. Discurrir con las conclusiones

La estructura planteada parte del problema, pasa por la solución, muestra los

resultados y llega a las conclusiones. Eso es lo que espera escuchar una persona que

desconoce el trabajo del expositor. En cualquier caso, sin importar la estructura que se

utilice, es conveniente que al inicio de la exposición se presente la organización que tiene

la presentación.

2.2.2 Artículo de revista

Cuando se lidia con un artículo de revista hay que tener en cuenta que existe una

gran variedad de artículos para revista. Si se toma, como ejemplo, la clasificación que

hace Colciencias, se encuentran artículos diferentes, tales como:

• Artículo de investigación científica y tecnológica

• Artículo de reflexión

• Artículo de revisión

• Artículo corto

• Reporte de caso

• Revisión de tema

• Cartas al editor

• Editorial

• Traducción

• Artículo de reflexión no derivado de investigación.

• Reseña de libro

En este documento sólo se tratarán los dos casos de más interés –investigación

científica y tecnológica, y de revisión-.

Page 33: Como Escribir Documentos Tecnicos de Ingenieria v13

a. Artículo de investigación científica y tecnológica

La estructura del artículo de investigación científica y tecnológica es en esencia, la

siguiente:

1. Resumen

2. Introducción

3. Desarrollo

4. Conclusiones

5. Referencias documentales

La estructura es muy simple, pero sólo presenta el primer nivel; hay que

profundizarla hasta el tercer nivel para conocer mejor el mapa de ruta. En este sentido, la

propuesta de Michaelson, numeral 2.2 anterior, ayuda a aclarar el camino, pues, después

de analizar sus preguntas, se puede hacer un primer borrador de la tabla de contenido

que sirva de guía al autor.

En el capítulo sexto, Guía para elaborar un artículo de revista, se encuentra

información complementaria al respecto.

b. Artículo de revisión

A diferencia del artículo científico y tecnológico, no hay una estructura básica

preestablecida para los artículos de revisión: hay que definirla. Ésta se organiza teniendo

en cuenta que su alcance quede bien específicado y que sus partes encajen correctamente

dentro de un orden lógico. Su estructura puede tener las siguientes secciones:

1. Introducción: donde se establece el problema que da origen al trabajo y sus

objetivos

2. Metodología: de búsqueda, recuperación y selección de los estudios

primarios

3. Desarrollo: donde se evalúan y discuten las diferencias de las fuentes

primarias

4. Conclusiones

Estos apartados se complementan con el resumen y las referencias documentales.

Page 34: Como Escribir Documentos Tecnicos de Ingenieria v13

Sin embargo, hay que profundizar este plan de trabajo para fijar una ruta más

detallada que cambiará, sin duda, durante el proceso, pero que servirá como punto de

partida. Esto aplica especialmente al capítulo de desarrollo; no obstante, abarca a todas

las secciones del artículo.

En el capítulo séptimo, Guía para elaborar un artículo de revisión, se encuentra

información complementaria al respecto.

Page 35: Como Escribir Documentos Tecnicos de Ingenieria v13

3. GUÍA PARA PRESENTAR AVANCES

Este apartado se utiliza para escribir documentos de avance, por lo que es

indispensable, establecer previamente el formato a seguir.

Existen varios formatos de estandarización, con distintas orientaciones y filosofías

como IEEE, APA, MLA, Chicago, Harvard, entre otros; también se habla de modelos y

tendencias –oriental y occidental- cada una con sus ventajas y desventajas. Ante este

panorama, y considerando las diferentes opciones existentes, se buscó seleccionar un

estándar de documentación a utilizar en ingeniería, que tuviera en cuenta las dimensiones

y alcances de los proyectos de esta disciplina. Entre las diferentes opciones, se optó por el

formato que plantea el MLA Handbook [Gibaldi, 1999], pues es el que más se acomoda a

los documentos de uso descritos en ingeniería; se utilizará en todos los escritos, a no ser

que se diga algo diferente.

Para utilizar el formato borrador, el autor debe conocer tanto la estructura del

documento final como los contenidos a desarrollar en cada una de sus secciones; también

debe tener presentes las normas de calidad, pues, aunque esta es una guía para escribir

avances, siempre se tiene presente que se escribe como si este documento intermedio

fuera la versión final.

Otra ventaja que se obtiene al utilizar un formato borrador bien definido, es que

todos los integrantes de un proyecto pueden escribir por separado sus documentos para

ensamblarlos posteriormente sin dificultades.

A continuación se presenta el formato a seguir para iniciar a elaborar cada uno de

los manuscritos.

3.1 Encabezado

Autor:

Para:

Nombre del proyecto o del curso:

Page 36: Como Escribir Documentos Tecnicos de Ingenieria v13

Fecha:

3.2 Alcance

Hay que hacer una distinción entre los documentos oficiales de un proyecto, que,

normalmente, están bien definidos para cada etapa y tienen contenidos mínimos bien

especificados. Esos documentos utilizan plantillas específicas que contienen más

información relacionada con el proyecto: la etapa pertinente, la versión, etc. Para llegar a

esos escritos oficiales existen unos intermedios, como pueden ser los informes de avance,

que no requieren necesariamente ser tan elaborados, pues están sujetos a revisiones

hasta que se llega al documento que se considera definitivo.

Esta plantilla sirve para la elaboración de esos manuscritos intermedios –por no

llamarlos de borrador-. El formato modelo que se sigue es el planteado por el MLA

Handbook [Gibaldi, 1999, 103-110] con algunas adaptaciones para el entorno de los

documentos de ingeniería.

3.3 Papel

Se utilizará papel blanco tamaño carta.

3.4 Márgenes

Se utilizará un margen estándar de 2.5 cm en todos los lados –arriba, abajo,

izquierda y derecha-.

Por otra parte, la primera línea de cada párrafo tiene sangría de 1.25 cm para

destacar que se inicia un nuevo párrafo.

Las listas que requieran sangría se inician a 1.6 cm.

3.5 Espaciado

Se utilizará un espaciado uniforme de una y media líneas sin importar que se trate

de títulos, encabezados, notas y bibliografía.

Page 37: Como Escribir Documentos Tecnicos de Ingenieria v13

3.6 Títulos

Éste tipo de documentos no requiere de páginas separadas para el título. En su

lugar, se inicia la primera página con las siguientes líneas:

• Nombre de los autores. Si son varios los autores, éstos se separan por

punto y coma

• Nombre del profesor y función que desempeña en el trabajo

• Nombre del proyecto o del curso

• Fecha de elaboración

Cada una de estas líneas se inicia sobre el borde del margen izquierdo; no tienen

sangría.

A continuación se centra el título del documento en la siguiente línea. Se utilizan

mayúsculas en los títulos de primer nivel, porque hacen que el título resalte a la vista.

Los capítulos –títulos de primer nivel- se pueden numerar con números romanos o

arábigos. Los títulos de otros niveles van en minúsculas y utilizan números arábigos para

su numeración.

3.7 Encabezamiento y numeración de las páginas

El encabezamiento se inicia a 1.3 cm. Contiene dos datos, a saber:

• Nombre del autor o número de la propuesta inicial (PI-XXX), si el trabajo de

grado ya tiene número; contra el margen izquierdo

• Número de la página y número total de páginas del documento; contra el

margen derecho

Estos datos van en una sola línea alineada entre los dos márgenes, e identifican a

todas las páginas de un documento.

3.8 Tablas y figuras

Todas las tablas y figuras del documento deben estar numeradas e identificadas.

Las tablas se numeran en la parte superior; las figuras en la parte inferior. En ambos

casos se utilizan números arábigos para su identificación.

Page 38: Como Escribir Documentos Tecnicos de Ingenieria v13

Para diferenciar el nombre de las tablas y figuras del resto del texto, se utiliza un

tamaño de letra menor. A veces, también, se puede utilizar otro tipo de letra.

La identificación de las tablas y figuras se centra.

Si se hace necesario citar la fuente de la tabla, o si deben hacerse aclaraciones –

notas- éstas van a continuación de la tabla y utilizan un tamaño de letra más pequeño que

la utilizada para su numeración.

3.9 Correcciones e inserciones

Todo documento debe ser leído y corregido antes de entregarlo al destinatario.

El uso de un espacio y medio entre líneas permite que se puedan hacer

correcciones entre ellas –siempre arriba de la línea correspondiente-, para evitar hacerlas

en los márgenes. Estas correcciones las harán, normalmente, el director del proyecto, los

asesores, los jurados y los profesores.

3.10 Formato

Este capítulo es un ejemplo de cómo utilizar la plantilla. Se notará que la primera

línea de cada párrafo tiene sangría. Esto permite identificar cuándo comienza un nuevo

párrafo; por tanto, no es necesario –ni tampoco aceptable- que se deje un renglón vacío

entre párrafos.

En el segundo párrafo se inicia una nueva idea del documento. También se notará

que el espacio entre renglones tiene espaciado de una y media líneas. Este espaciado

facilita la lectura, y si es del caso, permite hacer correcciones a mano entre las líneas.

Cuando se usa espaciado simple no es posible hacer correcciones entre las líneas y, por

tanto, se utilizan los bordes del papel.

En tercer lugar, se está utilizando como tipo de letra tahoma 11. En el ejemplo

anterior se colocó ese nombre en itálicas. Nótese que esta forma de resaltar una palabra

es práctica común cuando se trata de palabras de idiomas diferentes al español, siempre y

cuando que no sean de uso común; por ejemplo, si se habla de software o hardware, no

es necesario resaltarlas dentro del texto pues su uso ya es aceptado en español.

Page 39: Como Escribir Documentos Tecnicos de Ingenieria v13

Se utiliza papel tamaño carta con márgenes de 2.5 centímetros en todos los lados.

Además, se utiliza la zona de encabezados para identificar el documento: el nombre del

autor y la cantidad de páginas que contiene. Se utiliza letra más pequeña (tahoma 9 en

este ejemplo).

Es costumbre universal que se numere e identifique cada figura, como se muestra

en la figura 2.1. Éstas se numeran e identifican abajo y se centran. Por otra parte, el

tamaño de la letra del pie es menor al del texto común. En el ejemplo se ha utilizado

tahoma 9.

Fig. 2.1 Logotipo de la Universidad El Bosque

Las tablas también deben numerarse e identificarse, pero éstas se numeran e

identifican en el encabezado. También se suele utilizar un tamaño de letra menor a la del

texto común. A veces, algunos utilizan no solamente el tamaño de la letra diferente sino

también un tipo de letra diferente, lo que también es aceptable. Sin embargo, lo

importante es que se sea consecuente con la decisión en todo el documento. En la tabla

2.1, se puede ver un ejemplo.

Tabla 2.1 Tipos de letra y tamaños a utilizar

TIPOS DE LETRA

En el texto común: Tahoma Tamaño: 11

En el pie de las figuras: Tahoma Tamaño: 9

En el encabezado de las tablas: Tahoma Tamaño: 9

Dentro de las tablas: Times New Roman Tamaño: 11

Page 40: Como Escribir Documentos Tecnicos de Ingenieria v13

En las notas aclaratorias de las tablas: Times New Roman Tamaño: 8

En el encabezado: Tahoma Tamaño: 9

3.11 Estilo

El estilo es algo propio de cada persona y, aunque existen cursos y manuales, se

aprende, normalmente, leyendo buena literatura. No obstante, aquí se darán algunas

pautas muy generales, tales como:

• Se recomienda no escribir en primera persona. Es costumbre que, en

ingeniería, se trate de utilizar un estilo impersonal. Ejemplo: “…pensamos

que esta forma de diseño es…”, se debería cambiar por: “…se piensa que

esta forma de diseño es…”

• Tampoco se recomienda un estilo farragoso en el que los párrafos son casi

interminables y no se usan, o se usan muy poco, los puntos y coma (;) o

los puntos y seguido (.). Con este estilo es muy difícil capturar bien las

ideas. Es utilizado por algunos grandes escritores, pero en los documentos

técnicos se quiere, ante todo, no perder la claridad de las ideas.

• En contraposición al estilo anterior se ha tratado de imponer el estilo

propuesto por George Orwell a los escritores ingleses: “el texto debe ser

como una hoja de cristal”. Se propone que la prosa sea fácil y transparente.

Ese estilo ha tratado de llevar a que se utilicen frases muy cortas y que no

se empleen, o se lo haga muy poco, puntos y coma (;).

• Existe un estilo intermedio, que le da elegancia a la prosa sin ser

ininteligible. Es el estilo de los grandes prosistas irlandeses para quienes el

inglés es una lengua extranjera: su lengua materna es el gaélico, lengua

extremadamente evasiva en la que no es posible decir cosas directas.

Mientras el inglés va directo al grano, la forma de escribir de los irlandeses

es oblicua. Como dice John Banville: “Esa tensión, nacida a mediados del

siglo XIX, cuando dejamos de hablar gaélico y adoptamos el inglés del

imperio, generó un lenguaje nuevo y potente. El lenguaje de Wilde, Yeats,

Page 41: Como Escribir Documentos Tecnicos de Ingenieria v13

Shaw, Joyce, Beckett, distinto del inglés de Inglaterra, Estados Unidos o

Australia”.

Entre los muchos libros existentes en español, puede ser útil la lectura de La cocina

de la escritura [Cassany, 1993]. Es un libro que contiene muchos ejemplos fáciles de

entender, aunque hay que destacar que su tendencia es el tipo de escritura que pregona

Orwell.

En conclusión, se recomienda un estilo intermedio en que haya mucha claridad en

las ideas y el texto sea legible. Con este fin se recomienda leer buenos libros, de buenos

escritores, cuyo estilo pueda servir de ejemplo: es la forma más agradable de adquirir un

estilo.

3.12 Ortografía

No se debe perder de vista que se está escribiendo en español. Por consiguiente, la

ortografía será la de uso en español. Aquí se recomienda, a los que estén interesados, que

adquieran y lean la Ortografía de la lengua española, aparecida en 1999 [RAE, 1999],

www.rae.es. Es un libro de fácil lectura, avalado por todas las Academias de la Lengua

Española.

Otro documento sencillo sobre el mismo tema es el elaborado por el profesor

Alfredo Duplat [Duplat, 2006]. Para aquellos que no dispongan de medios para adquirir la

Ortografía de la RAE, este puede ser un sustituto recomendable; además, no tiene costo

alguno.

Cabe destacar que, por influencia de otros idiomas, algunos tratan de escribir con

ortografías de aquellos. Por ejemplo, se nota una gran tendencia a escribir muchas

palabras en mayúsculas en forma innecesaria. Así, a manera de ejemplo, en la Facultad de

Ingeniería Electrónica, la gran mayoría de los profesores son ingenieros (no Ingenieros),

aunque el título lo hayan adquirido en una Facultad de Ingeniería.

La información de la RAE se encuentra en su página web: www.rae.es. Aquellos

que no quieran, o no necesiten, comprar el libro de Ortografía, deberían, al menos, correr

el corrector de ortografía al final del documento: así eliminarían algunos errores.

Page 42: Como Escribir Documentos Tecnicos de Ingenieria v13

En forma complementaria, es conveniente tener a la mano y leer la Nueva

gramática de la lengua española, aparecida en 2009 (RAE, Espasa, 2009). Es más común

de lo deseable que muchos estudiantes de ingeniería utilicen formas gramaticales del

inglés; parece que no leyeran libros en español. Una lectura rápida, sobre todo al segundo

tomo –sintaxis- les recordará las formas gramaticales de uso apropiado en español.

Regresando al punto inicial del formato, usted habrá notado que existe un título

general del documento (capítulo) y doce apartados, a saber:

• PLANTILLA GUÍA PARA PRESENTAR AVANCES DEL TRABAJO DE GRADO

• Encabezado

• Alcance

• Papel

• Márgenes

• Espaciado

• Títulos

• Encabezamiento y numeración de las páginas

• Tablas y figuras

• Correcciones e inserciones

• Formato

• Estilo

• Ortografía

El primer nivel se ha centrado y se ha puesto en mayúsculas; los parágrafos se han

alineado contra el margen izquierdo y van en minúsculas. También se pueden centrar y no

numerarlos, pero, si el documento es extenso, es más conveniente numerar los títulos y

subtítulos. Lo importante es que se use un estilo consistente durante todo el documento.

Finalmente, cuando el documento adquiere cierta extensión (más de 10 páginas),

es conveniente agregarle la Tabla de Contenido que contenga los títulos hasta de tercer

nivel y los números de páginas correspondientes en que se encuentra la información.

Page 43: Como Escribir Documentos Tecnicos de Ingenieria v13
Page 44: Como Escribir Documentos Tecnicos de Ingenieria v13

4. GUÍA PARA HACER REFERENCIAS DOCUMENTALES

Aunque pueda parecer un asunto secundario, la búsqueda y recuperación de

información es el punto de partida de un proyecto. Sea cual sea el problema a solucionar,

nunca se parte de cero; hay que mostrar lo que ya han hecho otros, las soluciones

similares que existen, las desventajas que tienen y, si ya existe una solución y no tiene

inconvenientes, explicar por qué se debe desarrollar este proyecto: mostrar cómo se

podrían hacer mejoras. [DCU, Student Guide to Technical Report Writing,

http://mecheng.dcu.ie/reports/layout.htm 26 de diciembre, 2009].

La documentación de referencia en ingeniería sirve para revelar que han hecho

otros anteriormente. Como dice Michaelson [1990]: “la literatura citada le da al ingeniero

la oportunidad de mostrar que sus innovaciones y mejoras, con sus métodos y resultados,

difieren de las soluciones anteriores ante problemas similares”. La lista de referencias es

una excelente fuente de información que muestra que el ingeniero está familiarizado con

los antecedentes del problema.

La información puede estar en muchas formas, tanto escrita como en formato

electrónico: libros, revistas, bases de datos, simposios, tesis, presentaciones orales,

carteles, manuales, internet, etc.

Dado que no todas las ideas, frases, figuras y tablas que aparecerán en un escrito

son del escritor, éste debe explicar cuáles fueron sus fuentes. De otra forma estará

cometiendo plagio –“copiar en lo sustancial obras ajenas dándolas como propias”, [RAE,

1970]-. Como dice Gibaldi: “El plagio, entonces, constituye un robo intelectual. Hablando

estrictamente, es más una ofensa moral y ética que legal, puesto que la mayoría de los

casos de plagio no violan los derechos de autor”, [1999, 30].

El plagio no siempre es intencional. Es una costumbre adquirida por la mala

formación en los colegios, dónde los estudiantes se acostumbraron a realizar

investigaciones copiando enciclopedias, libros y páginas de internet, palabra por palabra,

sin que sus profesores les indicaran la falta que estaban cometiendo. Cuando llegan a la

universidad continúan con esa mala costumbre.

Page 45: Como Escribir Documentos Tecnicos de Ingenieria v13

Para evitar el plagio es necesario tomar notas de las fuentes que se han

consultado, incluyendo toda la información que facilite encontrar las obras citadas. Las

citas pueden ser de tres tipos: resúmenes, parafraseadas y textuales; por tanto, las notas

deben incluir toda esa información. Las notas se pueden tomar en forma manual, con

apoyo electrónico o mediante una combinación de ambas. Eco [2006, 129-149] presenta

ejemplos muy claros sobre el uso de fichas bibliográficas, temáticas y de citas, entre otras,

como respaldo a las notas necesarias en el momento de redactar el documento final. Esas

fichas se elaboran, normalmente, en cartulinas, que pueden ordenarse en el momento de

escribir el manuscrito y la lista de referencias. También existen programas de computador

orientados a la organización bibliográfica que ayudan a ordenar las notas. Sin embargo, en

la vida real se utiliza una mezcla de ambas herramientas. Empero esto requiere disciplina:

si no se hace bien se perderá tiempo precioso, en el momento de hacer las citas,

[Monash University Library, http://www.lib.monash.edu.au/tutorials/citing/ieee.html],

[Gibaldi, 28-30].

Pero en el momento de hacer citas es donde más errores se cometen en un

escrito. Por una parte, se tiene la tendencia a citar de oídas sin haber leído los

documentos originales, sin considerar que las referencias de segunda mano no son

confiables; es necesario leer la información original para que las citas sean correctas. Por

otra parte, no hay acuerdo entre los editores en cuanto a la información requerida para la

literatura citada; ante esas diferencias los autores se confunden y acaban citando o

suministrando información incompleta o inapropiada. Aquí se sugiere consignar toda la

información de los documentos de referencia para que cualquier persona interesada la

pueda encontrar; es más fácil suprimir información que buscarla de nuevo para

complementar los datos que pida un editor.

También existe otro error relacionado con la información pertinente; habitualmente

se trata de atiborrar al lector con citas irrelevantes e innecesarias. En este sentido Day

[2003] sugiere enumerar solo las obras importantes publicadas; evitar las referencias a

datos no publicados, obras en prensa, resúmenes, tesis y otros materiales de importancia

secundaria. Sugiere, si es esencial, añadirla como nota de pie de página.

Page 46: Como Escribir Documentos Tecnicos de Ingenieria v13

4.1 Tipos de estilos de citas y referencias

Existen dos métodos básicos de hacer citas: autor-fecha y numérico, aunque hay

muchas variaciones o estilos. Mackerle menciona que existen al menos tres estilos de

citación y más de 100 de referencia que se utilizan comúnmente [Jaroslav Mackerle,

Scientific Papers, their publishing and presentations, Linköping Institute of Technology,

Linköping, Sweden, 2000].

Los estilos de citación se pueden agrupar en tres tipos: nombre-año; numérico-

alfabético; y por orden de mención. Veamos sus diferencias.

4.1.1 Sistema nombre-año

Implica citar el nombre del autor y el año de publicación; es el estilo que utiliza

Harvard. Tiene una gran ventaja para el escritor pues las referencias, al no estar

numeradas, pueden agregarse o suprimirse fácilmente; “Gibaldi (1999)” seguirá siendo lo

mismo sin importar cuánto se modifique la lista. Sin embargo, presenta inconvenientes

para el lector pues lo distrae cuando existen varias citas en el mismo párrafo; más aún, si

los documentos están escritos por varios autores.

Ejemplo:

En el texto Referencias

• Gibaldi (1999) recomienda… 1. Eco, U. Cómo se hace una tesis…2004 • En forma minuciosa (Gibaldi, 1999)… 2. Gibaldi, J. MLA Handbook for Writers of…1999

3. Michaelson, H. How to Write and

Publish…1990

4.1.2 Sistema numérico-alfabético

Se cita por el número correspondiente en una lista; la lista de referencia se

organiza en orden alfabético según los apellidos de los autores. Es agradable para el

lector, pues los números no lo distraen, pero las citas temáticas aparecen en desorden.

Además, es engorroso para el escritor, pues las modificaciones de la lista lo obligan a

actualizar los números de las citas.

Ejemplo:

Page 47: Como Escribir Documentos Tecnicos de Ingenieria v13

En el texto Referencias

• En 1999 Gibaldi (2) recomienda… 1. Eco, U. Cómo se hace una tesis…2004 • En forma minuciosa (2)… 2. Gibaldi, J. MLA Handbook for Writers of…1999

3. Michaelson, H. How to Write and

Publish…1990

4.1.3 Sistema por orden de mención

Las referencias se citan numéricamente en el orden en que aparecen en el escrito;

es decir, la lista de referencias se organiza por el orden de citación de los documentos. Es

el estilo de Vancouver. No distrae a los lectores y les gusta porque pueden acudir

fácilmente a la lista de referencias. No es bueno para los autores porque los obliga a

actualizar la lista como consecuencia de la adición o supresión de referencias y, por ende,

a actualizar las citas.

Ejemplo:

En el texto Referencias

• En 1999 Gibaldi (1) recomienda… 1. Gibaldi, J. MLA Handbook for Writers of…1999 • En forma minuciosa (1)…

4.2 Estilos más recomendados

Es muy común que las universidades recomienden diferentes estilos según el área

del conocimiento. Así, por ejemplo, la Universidad de Monash sugiere los siguientes:

• AIP: American Institute of Physics

• APA: American Psychological Association

• Chicago: notas-bibliografía

• Harvard: autor-fecha

• IEEE: Institute of Electrical and Electronics Engineers

• MLA: Modern Language Association

• Turabian: con base en el estilo de Chicago

• Vancouver: numérico, para publicaciones biomédicas

Page 48: Como Escribir Documentos Tecnicos de Ingenieria v13

Sin embargo, cuando se le solicitó a las diferentes unidades académicas que

seleccionaran el estilo que considerasen más apropiado, se obtuvo la siguiente respuesta:

Departamento Estilo recomendado

Ingeniería Química Usar cualquier estilo en forma consistente

Ingeniería Civil Harvard

Ingeniería Eléctrica y de Sistemas IEEE

Ingeniería Mecánica Usar cualquier estilo en forma consistente

Ingeniería de Materiales Estilo del Journal of Materials Science

Llama la atención la respuesta de los departamentos de Ingeniería Química y de

Ingeniería Mecánica, pues indica que se puede usar cualquier estilo siempre y cuando que

se utilice en forma consistente. Sin embargo, se crea un pequeño problema: los

correctores de los trabajos deberían estar familiarizados con los diferentes estilos.

A continuación se analizan someramente los estilos de la MLA, APA e IEEE.

4.2.1 Estilo del MLA

Las citaciones se hacen dentro del texto utilizando paréntesis según la lista de

referencias alfabética que aparece al final del documento [Gibaldi, 114-117]. Dentro de los

paréntesis se señala al autor y la página o páginas de donde se extrajo la cita: (autor

página). La siguiente frase, es un ejemplo típico del estilo del MLA:

“Así, el presente contiene todo lo que existe o subsiste: el presente contiene todo”

[Comte-Sponville 58].

La cita [Comte-Sponville 58] le dice al lector que la frase se encuentra en la página

58 de un documento cuyo autor se llama Comte-Sponville. Si el lector quiere saber más de

esa fuente, debe ir a la lista de documentos referenciados, donde, bajo el nombre Comte-

Sponville, tendrá la siguiente información.

Comte-Sponville, Andrè. ¿Qué es el tiempo? Primera edición. Barcelona: Andrés

Bello, 2001.

Page 49: Como Escribir Documentos Tecnicos de Ingenieria v13

Esta entrada en la lista de documentos citados dice que Comte-Sponville es el

autor, la obra es ¿Qué es el tiempo?, es la primera edición y se imprimió en Barcelona.

El estilo de citación del MLA contiene sólo la información necesaria, que les facilite

a los lectores encontrar la fuente dentro de la lista de referencias. Así, si el nombre del

autor apareciese dentro del texto, la cita sólo contendría el número de la página: “(58)”.

En el estilo de la MLA, una entrada a la lista de referencias tiene las siguientes

características:

• El nombre del autor, que sigue al apellido, va completo

• Cada palabra importante del título va en mayúsculas (esto aplica en

lenguajes como el inglés)

• El nombre completo del editor va abreviado

• La primera línea de la entrada va contra el margen izquierdo; las demás

tienen sangría francesa

• La fecha va al final

Este estilo le informa a los lectores quienes fueron los autores citados.

4.2.2 Estilo del APA

Los diferentes estilos de documentación tratan de responder a las diferentes

disciplinas del conocimiento. En consecuencia, en las ciencias, donde la fecha de la

investigación es crucial, la fecha de publicación es relevante.

Para el ejemplo del numeral anterior, la cita, en el estilo de la American

Psychological Association (APA), queda así [http://www.apastyle.org]:

“Así, el presente contiene todo lo que existe o subsiste: el presente contiene todo”

(Comte-Sponville, 2001, p.58)

La lista de referencias es alfabética. La entrada del ejemplo anterior, en la lista de

referencias, quedaría como:

Comte-Sponville, A. (2001). ¿Qué es el tiempo? Barcelona: Editorial Andrés Bello.

Page 50: Como Escribir Documentos Tecnicos de Ingenieria v13

En el estilo de la APA, una entrada a la lista de referencias tiene pequeñas

diferencias con respecto a la de la MLA:

• El nombre del autor, que sigue al apellido, sólo lleva sus iniciales

• La fecha sigue al nombre del autor

• Sólo la primera letra del título va en mayúsculas (esto aplica en idiomas

como el inglés)

• Se suministra el nombre completo del editor

• La primera línea de la entrada va contra el margen izquierdo; las demás

tienen sangría francesa

A continuación se muestra un ejemplo real de una lista de referencias elaborada

con el estilo APA.

Charles, S. T., Mather, M., & Carstensen, L. L. (2003). Aging and emotional memory: The forgettable nature of negative images for older adults. Journal of Experimental

Psychology: General, 132, 310–324. doi:10.1037/0096-3445.132.2.310 Chow, T. W., & Cummings, J. L. (2000). The amygdala and Alzheimer’s disease. In J. P.

Aggleton (Ed.), The amygdala: A functional analysis (pp. 656–680). Oxford, England: Oxford University Press.

Davis, M., & Whalen, P. J. (2001). The amygdala: Vigilance and emotion. Molecular

Psychiatry,6, 13–34. doi:10.1038/sj.mp.4000812

4.2.3 Estilo del IEEE

Las referencias se numeran en el orden en que se van haciendo las citas dentro del

texto. Si una misma referencia se cita posteriormente, entonces se utiliza el mismo

número de entrada correspondiente a la primera vez [IEEE_auinfo07].

La lista de referencias suministra todos los detalles de cada una de las referencias

citadas en del texto. La lista sigue el orden de citación; no es alfabética.

El ejemplo del numeral 4.2.1, la cita, en el estilo de la IEEE, queda así:

“Así, el presente contiene todo lo que existe o subsiste: el presente contiene todo” [1].

En el estilo de la IEEE, una entrada a la lista de referencias tiene las siguientes características:

Page 51: Como Escribir Documentos Tecnicos de Ingenieria v13

• Sólo se usan las iniciales del nombre del autor, que van primero; luego viene el apellido. Se nombra a todos los autores. También puede ir el nombre de una organización

• Sigue el título en itálicas

• Todas las palabras relevantes del título van en mayúsculas (esto aplica en lenguajes como el inglés)

• Sigue el número de la edición (si no es la primera)

• Ciudad en que se publicó, seguida de dos puntos

• Se suministra el nombre completo del editor

• Año de publicación

• La primera línea de la entrada va contra el margen izquierdo; las demás tienen sangría francesa

En consecuencia, la entrada del ejemplo anterior quedaría como:

A. Comte-Sponville, ¿Qué es el tiempo?, Barcelona: Editorial Andrés Bello, 2001.

A continuación se muestran unos ejemplos extraídos del documento

[IEEE_auinfo07, p 4].

Libros:

[1] G. O. Young, “Synthetic structure of industrial plastics,” in Plastics, 2nd ed., vol. 3, J.

Peters, Ed. New York: McGraw-Hill, 1964, pp. 15–64.

[2] W.-K. Chen, Linear Networks and Systems. Belmont, CA: Wadsworth, 1993, pp. 123–

135.

Revistas:

[3] J. U. Duncombe, “Infrared navigation—Part I: An assessment of feasibility,” IEEE

Trans. Electron Devices, vol. ED-11, pp. 34–39, Jan. 1959.

[4] E. P. Wigner, “Theory of traveling-wave optical laser,” Phys. Rev., vol. 134, pp. A635–

A646, Dec. 1965.

[5] E. H. Miller, “A note on reflector arrays,” IEEE Trans. Antennas Propagat., to be

published.

Artículos de conferencias (publicados):

Page 52: Como Escribir Documentos Tecnicos de Ingenieria v13

[6] D. B. Payne and J. R. Stern, “Wavelength-switched passively coupled single-mode

optical network,” in Proc. IOOC-ECOC, 1985, pp. 585–590.

Artículos de conferencias (no publicados):

[7] D. Ebehard and E. Voges, “Digital single sideband detection for interferometric

sensors,” presented at the 2nd Int. Conf. Optical Fiber Sensors, Stuttgart, Germany,

Jan. 2-5, 1984.

Estándares/Patentes:

[8] G. Brandli and M. Dick, “Alternating current fed power supply,” U.S. Patent 4 084 217,

Nov. 4, 1978.

Reportes técnicos:

[9] E. E. Reber, R. L. Mitchell, and C. J. Carter, “Oxygen absorption in the Earth’s

atmosphere,” Aerospace Corp., Los Angeles, CA, Tech. Rep. TR-0200 (4230-46)-3,

Nov. 1968.

4.3 Estilo propuesto

El estilo a utilizar debe responder a las necesidades de los lectores y de los

escritores. La selección de los estilos de citación y de construcción de la lista de

referencias se hará por separado, para mayor claridad.

4.3.1 Estilo de citación

En cuanto al estilo de citación es preferible utilizar los corchetes [] que emplea la

IEEE, pues se diferencian de los paréntesis () que se utilizan comúnmente para hacer

aclaraciones. El contenido debe incluir: la obra citada, para lo cual se prefiere el sistema

numérico, dado que molesta menos al lector; y la página o páginas donde se encuentra la

cita, información utilizada tanto en los estilos de la MLA como de la APA. Quizás quedaría

faltando el año de publicación, pues este dato ayuda en el momento de seleccionar las

fuentes; empero, tanta información distrae al lector. En consecuencia, el modelo de

citación queda así: [número del documento, página(s) citada(s)], donde documento se

refiere al orden de citación de los documentos y página(s) se refiere a la página exacta de

donde se extractó la cita. Esa forma de hacerlo facilita el trabajo a los lectores, pues en un

Page 53: Como Escribir Documentos Tecnicos de Ingenieria v13

documento grande, un libro, por ejemplo, es difícil encontrar la cita. En consecuencia, si el

lector quiere constatar o profundizar en la fuente, se le facilita el trabajo.

La siguiente frase, es un ejemplo típico del estilo propuesto:

“Así, el presente contiene todo lo que existe o subsiste: el presente contiene todo”

[1, 58].

La cita [1, 58] le dice al lector que la frase se encuentra en la página 58 del

documento número uno (1) de la lista de referencias. Si el lector quiere saber más de esa

fuente, debe ir a la lista de documentos referenciados, donde, bajo la entrada número uno

(1), encuentra la siguiente información.

Comte-Sponville, Andrè. (2001) ¿Qué es el tiempo? Primera edición, Barcelona:

Editorial Andrés Bello.

4.3.2 Estilo de la lista de referencias

Todos los documentos citados que aparecen en la documentación referenciada

deben tener toda la información necesaria para que el lector los pueda conseguir. Así un

libro contiene tres partes principales: Nombre del autor, título del libro e información de

publicación.

Donde:

• Nombre del autor: aparece primero el apellido, una coma, después los

nombres y termina en punto y seguido.

Los apellidos y nombres del autor aparecen como se encuentran en la

página del libro, no en la cubierta; no se aceptan abreviaciones.

En general, se omiten los títulos, afiliaciones y grados de los autores.

• Título del libro: se registra el título del libro como aparece en la

carátula, incluyendo cualquier subtítulo.

El título se escribe en cursiva; la primera palabra comienza con

mayúscula inicial y las demás pueden ir en minúscula, a no ser que sean

nombres propios.

El título termina con un punto y seguido.

Page 54: Como Escribir Documentos Tecnicos de Ingenieria v13

• Información de publicación: en general se suministra el número de la

edición, la ciudad donde se publicó, el año de publicación, y la editorial.

Los datos se toman directamente del libro.

La edición y la ciudad de publicación se separan por comas.

Después de la ciudad de impresión vienen dos puntos seguidos y luego

sigue el nombre de la editorial.

Existe información adicional que aparece en la página de derechos reservados.

En cuanto al estilo de la lista de referencia, es preferible el sistema de numeración

secuencial según vayan apareciendo las citas en el documento. Cada documento se

numera a medida que surge en el texto; la primera cita que se hace corresponde al primer

documento citado, [1]; la segunda al siguiente documento, [2]; y, así sucesivamente.

Cada entrada en la lista de referencias tendrá el siguiente orden:

• Apellido y nombre del autor; nombre completo. Similar al estilo del MLA

• Fecha de publicación, similar al estilo de la APA

• Título del documento

• Número de edición

• Ciudad de impresión

• Editor

En cada entrada a la lista de referencia se utilizará el apellido y el nombre

completo del autor, a pesar de que dentro de los distintos estilos cobra cada vez más

fuerza la intención de identificar a los autores con apellido e iniciales de los nombres; esta

es una tendencia de las revistas norteamericanas. Esta exigencia de los editores

norteamericanos no es muy amable con los lectores quienes desearían conocer el nombre

de pila de los autores citados. Por otra parte, Gibaldi (1999) utiliza apellidos y nombres

completos, y Eco (1996) considera que esa costumbre es un error. En consecuencia, se

utilizarán, en lo posible, los nombres completos de los autores.

Page 55: Como Escribir Documentos Tecnicos de Ingenieria v13

La primera línea de cada entrada va contra el margen izquierdo y las demás con

sangría francesa. Así, la entrada del ejemplo anterior queda en esta forma:

Comte-Sponville, Andrè. (2001) ¿Qué es el tiempo? Primera edición, Barcelona:

Editorial Andrés Bello.

No obstante, independientemente del estilo que se propone, el autor debe

acomodarse al que exija el editor en cada caso (del trabajo de grado, del libro, de la

revista, de la organización del simposio, u otro). Empero, dentro de la Facultad de

Ingeniería Electrónica de la Universidad El Bosque, se utilizará el estilo propuesto

anteriormente.

En conclusión, esta forma de citación, [documento, página], simplifica el proceso

de elaboración del documento y aumenta la precisión referente a las fuentes.

A continuación se dan algunos ejemplos sobre la forma de llenar la lista de

referencias.

4.3.3 Información de los libros

Todos los documentos citados que aparecen en la documentación referenciada

deben tener toda la información necesaria para que el lector los pueda conseguir.

Ejemplos:

Gibaldi, Joseph. (1999). MLA Handbook for Writers of Research Papers. 5th ed., New

York: The Modern Language Association of America.

Zilahy, Lajos. (1970). Las cárceles del alma. Buenos Aires: Plaza & Janés S.A.

En el segundo ejemplo se observa que no hay número de edición. En este caso se

trata de la primera; esta forma es tácita cuando sólo existe la primera edición.

En algunos casos es muy importante el traductor; en ese caso se agrega.

Brodsky, Joseph. (2006). Menos que uno: Ensayos escogidos. Trad. Carlos Manzano. 2006,

Madrid: Editorial Siruela.

Page 56: Como Escribir Documentos Tecnicos de Ingenieria v13

A veces se cita sólo un capítulo de un libro. En este caso va primero el título del

capítulo y a continuación el título del libro.

Primo Yúfera, Eduardo. (1994). Conceptos fundamentales sobre la investigación científica

y tecnológica: Introducción a la investigación científica y tecnológica. Madrid:

Alianza Editorial.

Cuando los autores son dos, se escriben los nombres de ambos.

Kline, S., and Rosenberg, N. (1986). An Overview of Innovation en The Positive Sum

Strategy: Harnessing Technology for Economy Growth. Ralph Landau y Nathan

Rosenberg (ed.), Washington: National Academy Press.

Si el número de autores es mayor a dos, se escribe el primero y luego las palabras

et alli –y otros-.

Gibbons, Michael et al. (1994). The New Production of Knowledge: The Dynamics of

Science and Research in Contemporary Societies. New York: Sage Publications.

Citar un libro electrónico (e-book) que se encuentra en una base de datos.

Salkintzis, Apostolis K. (2004). Mobile Internet: enabling technologies and services.

[Online]. Disponible: http://www.engnetbase.com/books/1253/1631_fm.pdf

Citar un libro electrónico (e-book) que se encuentra en internet.

Guruswami, Venkatesan. (2004). List decoding of error-correcting codes: winning thesis of

the 2002 ACM doctoral dissertation competition (Lecture Notes in Computer

Science). (2nd ed.) [Online]. 3282. Disponible: http://portal.acm.org/3540240519.pdf

4.3.4 Información de las revistas

Cuando se trata de citar artículos de una revista, la información tiene el siguiente

orden:

Page 57: Como Escribir Documentos Tecnicos de Ingenieria v13

Nombre del autor, título del artículo e información de publicación.

Donde:

• Nombre del autor: sigue los mismos principios utilizados en los libros.

• Título del artículo: va entre comillas. Sigue los demás principios indicados

para los libros.

• Información de publicación: después del nombre del artículo, sigue el

nombre de la revista, el número del volumen, el año de publicación, dos

puntos, las páginas inicial y final y se termina con punto aparte.

Ejemplos:

Escobar Roa, Juan Miguel. (2006). “Aplicaciones virtuales en biomedicina”, FIElectrónica,

Bogotá, Vol. 1, pp. 43-49.

García, Arlina y León, Daniel. (2006). “Matlab en tiempo real”, FIElectrónica”, Bogotá,

Vol. 1, pp. 79-84.

Kalenatic, Dusko et al. (2008). “Localización de una plataforma de Cross Docking en el

contexto de logística focalizada utilizando distancias euclidianas”, Ciencia e

Ingeniería Neogranadina, Bogotá, Vol. 18-1, pp. 17-34

Sabogal Gómez, Ernesto. (2007). “Cómo pasar de proyectos de grado a líneas de

investigación”, FIElectrónica, Bogotá, Vol. 2, pp. 17-23.

Si la revista no es muy conocida, se recomienda mencionar la ubicación de la

misma.

Si aparece una entrada a la lista de referencias, como en el ejemplo siguiente, la

falta de los nombres completos del autor y de las páginas exactas del artículo, indican que

se está citando de oídas, es decir, que el texto no se tiene a la mano.

Sung, C.S. and Song, S.H. (2003). “Integrated service network design for a cross-docking

supply chain network”, The Journal of the Operational Research Society, 54, No. 12.

Page 58: Como Escribir Documentos Tecnicos de Ingenieria v13

Citar un artículo de revista en internet (e-journal).

Fulda, J.S. (2000, Mar.). “The Internet as an engine of scholarship”. ACM SIGCAS

Computers and Society. [Online]. 30 (1), pp. 17-27. Disponible:

http://doi.acm.org/10.1145/572217.572222

4.3.5 Información de artículos de conferencia

Cuando se trata de citar artículos de una conferencia o simposio, la información tiene el siguiente orden:

Nombre del autor, título del artículo e información de publicación.

Donde:

• Nombre del autor: sigue los mismos principios utilizados en los libros.

• Título del artículo: va entre comillas. Sigue los demás principios indicados para los libros.

• Información de publicación: después del nombre del artículo, sigue el nombre de la conferencia, el editor si está disponible, el lugar y fecha de publicación, dos puntos, las páginas inicial y final y se termina con punto aparte.

Ejemplos:

Cookson, A. H. and Pedersen, B. O. (1979). "Thermal measurements in a 1200kV

compressed gas insulated transmission line", Seventh IEEE Power Engineering

Society Transmission and Distribution Conference and Exposition, 1979, pp. 163-

167.

Un artículo de conferencia sobre internet (e-Conference paper).

Mckey, Julia C. et al. (2009). “Effects on time-varying magnetic fields and parametric

resonance conditions on circulatory and microcirculatory parameters using healthy

and spontaneously hypertensive rats”, BIOEM 2009 DAVOS, Davos, Switzerland, 2-

4. Disponible: http://www.bioem2009.org, (acceso el 28 de diciembre de 2009).

Page 59: Como Escribir Documentos Tecnicos de Ingenieria v13

4.3.6 Información de documentos citados por internet

Otra fuente común es internet. En este caso la información es la siguiente:

Nombre del autor, año de publicación del documento, título e información de

publicación.

Donde:

• Nombre del autor: sigue los mismos principios de los libros.

• Año de publicación: va entre paréntesis.

• Título: sigue los mismos principios de los libros.

• Información de publicación: dirección electrónica completa entre paréntesis

triangulares, fecha de consulta y número de páginas del documento en esa

dirección.

Ejemplos:

Elhedhli, Samir y Goffin, Jean-Louis. (2004). “The integration of an interior-point cutting

plane method within a branch-and-price algorithm”, Mathematical Programming

100, No. 2 (June), pp.267-294, Disponible: http://www.proquest.com/, (acceso en

abril 3 de 2008).

Mckey, Julia C. et al. (2009). “Effects on time-varying magnetic fields and parametric

resonance conditions on circulatory and microcirculatory parameters using healthy

and spontaneously hypertensive rats”, BIOEM 2009 DAVOS, Davos, Switzerland, 2-

4. Disponible: http://www.bioem2009.org, (acceso el 29 de diciembre de 2009).

Con las fuentes encontradas en internet se debe tener cuidado para garantizar su

credibilidad.

4.3.7 Información de otras fuentes

Existe otra gran variedad de fuentes. Sin embargo, las más utilizadas son libros,

revistas, conferencias e internet. Para un mayor conocimiento sobre como citar casos

especiales u otras fuentes, se sugiere consultar el capítulo cuarto del MLA Handbook

(Gibaldi, 1999), Documentation: Preparing the List of Works Cited.

Page 60: Como Escribir Documentos Tecnicos de Ingenieria v13

4.3.8 Información de la lista de referencias

La lista de documentos citados va al final del documento. Desde el punto de vista

formal, es conveniente que el listado tenga sangría francesa, pues de esa forma es más

legible la información.

Ejemplo:

1) Gibaldi, Joseph. (1999). MLA Handbook for Writers of Research Papers. 5th ed., New

York: The Modern Language Association of America.

2) Zilahy, Lajos. (1970). Las cárceles del alma. Buenos Aires: Plaza & Janés S.A.

3) Primo Yúfera, Eduardo. (1994). Conceptos fundamentales sobre la investigación

científica y tecnológica: Introducción a la investigación científica y tecnológica.

Madrid: Alianza Editorial.

4) Kalenatic, Dusko et al. (2008). “Localización de una plataforma de Cross Docking en el

contexto de logística focalizada utilizando distancias euclidianas”, Ciencia e

Ingeniería Neogranadina, Bogotá, Vol. 18-1, pp. 17-34

5) Sabogal Gómez, Ernesto. (2007). “Cómo pasar de proyectos de grado a líneas de

investigación”, FIElectrónica, Bogotá, Vol. 2, pp. 17-23.

6) Mckey, Julia C. et al. (2009). “Effects on time-varying magnetic fields and parametric

resonance conditions on circulatory and microcirculatory parameters using healthy

and spontaneously hypertensive rats”, BIOEM 2009 DAVOS, Davos, Switzerland,

2-4. Disponible: http://www.bioem2009.org, (acceso el 28 de diciembre de 2009).

7) Elhedhli, Samir y Goffin, Jean-Louis. (2004). “The integration of an interior-point

cutting plane method within a branch-and-price algorithm”, Mathematical

Programming 100, No. 2 (June), pp.267-294, Disponible:

http://www.proquest.com/, (acceso en abril 3 de 2008).

Page 61: Como Escribir Documentos Tecnicos de Ingenieria v13

5. DOCUMENTACIÓN

La documentación es un proceso inherente en algunas de las actividades humanas.

Cualquier entidad que desarrolle productos, servicios o procedimientos debe

documentarlos. En este sentido, los grupos de investigación universitarios son conocidos

como fábricas de producir documentos. Las empresas oficiales o privadas que se dedican

a la investigación, desarrollo e innovación –I+D+i- también son productoras de artículos.

En la orilla opuesta, las empresas o entidades que requieren productos o servicios deben,

igualmente, escribir sus necesidades.

Un equipo de investigación académico está conformado como se muestra en la

figura 5.1 [Álvaro Rendón].

Figura 5.1 Estructura del equipo de investigación

Empero el grupo de investigación debe relacionarse con su entorno social. Así, en

la figura 5.2 se puede ver un esquema que señala las actividades de un grupo de

investigación. Por el lado izquierdo, insumos, busca información sobre el conocimiento

existente, científico o tecnológico, como base sólida para iniciar cualquier proyecto que

solucione el problema específico que tiene entre manos. Por el lado derecho, resultados,

Page 62: Como Escribir Documentos Tecnicos de Ingenieria v13

produce documentos como consecuencia de los procesos y actividades para solucionarlo

que, en algunos casos, ayudan a actualizar la base de datos del conocimiento existente.

Figura 5.2 Interacciones del equipo de investigación

La documentación del proyecto se inicia con la búsqueda del estado del arte en el

tema objeto; continúa con el objetivo y requerimientos que delimitan el producto final;

sigue el diseño, la implementación, las pruebas y los manuales del producto; y se finaliza

con los resultados, la discusión y las conclusiones. Cada una de esas fases conlleva

documentos específicos que son elaborados por el grupo encargado del proyecto.

Los productos generados en cualquier proyecto deben estar documentados, pues

de otra forma no podrían ser repetidos ni actualizados. Existe un principio que dice: un

proyecto es igual a su documentación. Ésta es independiente de la gente, pues el personal

de un proyecto cambia; entra y sale del mismo durante su ciclo de vida. Por ende, la

metodología de documentación debe ser precisa y estandarizada para que los nuevos

miembros del proyecto se integren rápidamente y encuentren toda la información de las

actividades realizadas anteriormente.

La documentación debe permitir conocer todos los detalles de un producto, y

facilitar su producción y los cambios relacionados con su mantenimiento. Sin embargo, el

Page 63: Como Escribir Documentos Tecnicos de Ingenieria v13

estandarizar está casi siempre ligado con la idea de truncar la creatividad de los

desarrolladores; así que, la documentación de los proyectos no es la tarea más grata para

un ingeniero en nuestro medio. Por esto, se les debe formar en la universidad, mostrarles

las bondades de tener productos bien documentados y resaltar las falencias de aquellos

que no lo son. En consecuencia, al planear el desarrollo de un producto se deben anticipar

los esfuerzos y recursos necesarios para poder documentarlo; crear la cultura de la

escritura como parte integral de su desarrollo.

A continuación se muestran, en forma general, la clasificación y los tipos de

documentos que se producen en un proyecto en las diferentes etapas de su ciclo de vida.

5.1 Clasificación de la información

En su clasificación prima el contenido, no la fase del desarrollo cuando se genera.

En este sentido se tienen las siguientes clases de documentación:

• Preliminar o de planeación, que sirve para concretar el anteproyecto

• Diseño de alto nivel, que sirve para definir la forma como se satisfacen las

necesidades planteadas; se analizan alternativas y se selecciona la más

conveniente

• Diseño detallado software, que se refiere al detalle del diseño llegando

hasta el nivel de funciones

• Diseño detallado hardware, que describe el diseño detallado del hardware

llegando hasta el nivel de tarjetas

• Implementación software, que reseña la realización concreta del software

según los objetivos señalados en los diseños de alto nivel y detallado

• Implementación hardware, que se refiere a la realización concreta del

hardware según los objetivos señalados en el diseño de alto nivel y

detallado

• De pruebas, que describe las pruebas a realizar sobre las partes o sistemas

diseñados para asegurarse de la calidad de los mismos

• Del cliente, que le indica cómo utilizar el producto desarrollado

• De programación y control, que sirve para organizar y controlar la marcha

del proyecto

Page 64: Como Escribir Documentos Tecnicos de Ingenieria v13

En forma esquemática se pueden asociar las clases de documentación con las

etapas de desarrollo, como se muestra en la figura 5.3.

5.2 Clasificación y descripción de los tipos de documentos

5.2.1 Documentación de planeación

A. Propuesta inicial

La propuesta inicial antecede al anteproyecto. Su función es la aprobación

oportuna de la proposición –idea fundamental- del proyecto a desarrollar. Contiene el

título, una descripción general del problema, la justificación, los objetivos y los recursos

necesarios.

B. Anteproyecto

Define el problema a tratar, lo delimita y lo relaciona con el estado del arte.

Concreta los objetivos, requerimientos técnicos, metodología y actividades, recursos,

tiempos de entrega, costo estimado, cronograma general de actividades y compromisos

de las partes.

5.2.2 Documentación de diseño global

A. Objetivos de desarrollo

Es la propuesta técnica, elaborada a partir del anteproyecto. Presenta alternativas de

desarrollo que incluyen el diseño global y las interfaces externas, y selecciona una a partir

de los aspectos técnico, económico y de tiempo de ejecución.

B. B. Arquitectura del sistema

Presenta la descomposición del sistema en subsistemas, tanto de tipo hardware como

software.

Page 65: Como Escribir Documentos Tecnicos de Ingenieria v13

ETAPAS DE DESARROLLO

Diseño Global

Diseño Sw Diseño HWDiseño

Detallado

CLASES DE DOCUMENTACIÓN

PLANIFICACIÓN Y CONTROL

Propuesta Inicial y Anteproyecto

Diseño Global

Revisiones

Pruebas Cliente

Planeación

Integración y Pruebas

Impl. Sw Impl. HwIntegración y Pruebas

Implem

entación

Cliente

Fig. 5.3. Documentación versus etapas de desarrollo de un proyecto

5.2.3 Documentación de diseño detallado

A. Especificación funcional

Es la base para el desarrollo de cada módulo, hardware o software. Presenta las

funciones a realizar, sin entrar en la construcción de las mismas.

También considera los requisitos de las interfaces, indicando sus funciones y

módulos que relaciona.

B. Diagrama esquemático general

Integra los diagramas funcionales de cada uno de los módulos separados; se

desarrolla a partir de la arquitectura de módulos del diseño global.

Page 66: Como Escribir Documentos Tecnicos de Ingenieria v13

C. Diseño industrial

Es la base para la terminación del producto: tipo de materiales, tamaño, seguridad,

operatividad, disipación de calor, cableado, etc.

5.2.4 Documentación de implementación

A. Software

• Descripción detallada de los módulos.

Presenta los detalles de implementación de cada módulo o parte. Incluye las

descripciones de los datos que maneja, las secuencias de trabajo y los mecanismos

utilizados.

• Listado de programa fuente

Es el conjunto de líneas de cada programa fuente.

B. Hardware

• Descripción detallada de los módulos

Muestra los detalles de implementación de cada módulo o parte. Incluye las

descripciones de los datos que maneja, las secuencias de trabajo y los mecanismos

utilizados.

• Esquemas eléctricos

Es el esquema de cada circuito eléctrico; permite examinar las conexiones entre los

diferentes elementos del mismo. Se realiza para cada tarjeta de circuitos impresos

con sus componentes, pero se pueden agrupar varias si constituyen una unidad.

La identificación de los componentes debe corresponder con la lista de partes y el

esquema de montaje.

• Esquema de montaje

Es un plano que indica la instalación física de los componentes en una tarjeta de

circuitos impresos. Los detalles o notas para el montaje deben aparecer en este

plano.

La identificación de los componentes debe corresponder con el esquema eléctrico y

la lista de partes.

Page 67: Como Escribir Documentos Tecnicos de Ingenieria v13

• Lista de partes

Es el documento donde aparecen registradas todas las partes necesarias para

construir el módulo o conjunto. Debe incluir el número de ítem, su descripción,

unidad, cantidad y referencia.

• Plano de cableado

Plano que indica entre qué puntos se conectan los hilos de un módulo o conjunto.

Se refiere a cables con conectores, cajas, bastidores o unidades en las que el

cableado sea una parte importante.

• Plano de circuitos impresos

Contiene la documentación con todas las artes y notas necesarias para construir

cada tarjeta de circuitos impresos. Contiene el recorrido de las pistas, huecos,

características del material y demás datos de fabricación.

5.2.5 Documentación de pruebas

A. Especificación de pruebas

Especifica el tipo de pruebas a realizar sobre las partes, módulos, conjuntos o

sistemas, sin indicar la forma concreta de realizarlas.

B. Casos de prueba

Define las pruebas concretas a realizar para comprobar los requerimientos de las

partes, módulos y conjuntos del sistema.

5.2.6 Documentación del cliente

Se entiende como cliente al destinatario de la aplicación.

A. Manual de instalación

Define los procedimientos detallados para la instalación. Incluye herramientas,

equipos de prueba y procedimientos.

B. Manual de operación

Contiene los procedimientos donde se describe cómo realizar el trabajo diario para

hacer que el sistema cumpla con los requisitos de operatividad.

Page 68: Como Escribir Documentos Tecnicos de Ingenieria v13

C. Descripción detallada del sistema

Es el documento final que muestra los resultados del proyecto. Describe en detalle

el sistema incluyendo sus facilidades, funcionalidad hardware y software, requerimientos

ambientales, capacidades y posibilidades de ampliación, si las tiene.

5.2.7 Documentación de planificación y control

A. Plan de desarrollo

Es el plan maestro de trabajo para los diferentes organismos y personas que

intervienen en el proyecto. Señala objetivos, fechas y responsabilidades.

B. Herramientas de desarrollo

Describe las herramientas hardware y software que se utilizarán en el desarrollo

del proyecto

C. Plan de integración

Contiene las reglas para construir los subsistemas hardware y software, y su

integración (a partir de los módulos implementados previamente).

D. Plan de pruebas

Contiene la información sobre la planificación de las pruebas a realizar, los recursos

necesarios, la disponibilidad de herramientas y los equipos.

5.3 Documentación relacionada con las opciones de grado

Al final de sus estudios los estudiantes de ingeniería tienen dos alternativas de

grado: elaborar un trabajo de grado o participar como auxiliares en un proyecto

institucional de investigación. Estas alternativas promueven la formación de los

estudiantes en actividades de I+D; en cualquier caso, deben documentar su trabajo.

5.3.1 Trabajo de grado

Otorga a los estudiantes la oportunidad de aplicar conocimientos adquiridos en su

carrera para capacitarlos mejor en su desempeño profesional; los pone en contacto con

problemas de su especialidad para que colaboren en su planteamiento y/o en la búsqueda

de soluciones.

Los temas se originan en:

Page 69: Como Escribir Documentos Tecnicos de Ingenieria v13

• Las líneas de investigación que les presentan cuestiones de interés dentro

de sus objetivos.

• Las empresas, donde trabajan los estudiantes, que desean que éstos les

presenten soluciones a problemas concretos propios de su operación,

mantenimiento, procesos, y productos o servicios que ofrezcan a sus

clientes.

• Ideas innovadoras de los estudiantes que desean crear empresas propias.

Empero, ante todo, debe destacarse que el trabajo de grado es un campo de

simulación del ejercicio profesional. En general, el estudiante trabajará en una entidad que

requiere bienes o servicios para realizar su misión, o en una empresa que produce bienes

o servicios. Una clasificación más general de las firmas revela que en esencia existen tres

clases: las que tienen como función generar bienes y servicios; las empresas

comerciales/estatales que requieren bienes y servicios para su operación normal; y las que

dictan políticas o regulan la operación y competencia de un sector productivo.

Durante su ejercicio profesional un ingeniero puede trabajar indistintamente en

cualquiera de ellas; es más, puede ofrecer sus servicios a las tres en diferentes épocas de

su vida profesional. En consecuencia, es preciso mirar con detenimiento la relación entre

las empresas que requieren y las que generan bienes o servicios; es decir, explicar de

manera somera el proceso licitatorio. La figura 5.4 muestra las principales etapas de ese

trato, que puede desglosarse así:

1. Una empresa que requiere bienes/servicios para desarrollar su actividad

principal debe iniciar un proceso interno que arranca con:

a. La definición del problema interno que afecta su operación

b. El convencimiento de que requiere nuevos bienes/servicios para

mejorar su operación y crear un proyecto con este fin

c. La definición de los objetivos general y específicos del proyecto

d. La generación de los requerimientos técnicos –características técnicas y

valores- que aterricen los objetivos. Es decir, elaborar el capítulo técnico

de los pliegos de condiciones de una licitación pública o privada

Page 70: Como Escribir Documentos Tecnicos de Ingenieria v13

2. Con esos requerimientos –pliegos- solicita ofertas en forma pública o privada

3. Las empresas generadoras de bienes y servicios interesadas reciben la

solicitud, la analizan y la contestan; hacen ofertas técnicas que cumplan con los

requerimientos. Esas ofertas incluyen, habitualmente, el diseño global

4. La empresa solicitante, que inició el proceso licitatorio, analiza las ofertas y

selecciona la mejor. Da aviso a todos los participantes y elabora un contrato

con la firma ganadora

5. El oferente, empresa generadora de bienes y servicios, inicia el desarrollo del

producto solicitado –diseño, implementación, pruebas y documentación-, y,

cuando termina, avisa al solicitante para que realice las pruebas de aceptación

6. El solicitante hace las pruebas de aceptación del producto con base en los

requerimientos técnicos establecidos. Si son satisfactorias acepta el producto;

si no, le avisa al ofertante que debe hacer las modificaciones necesarias para

cumplir con todas las especificaciones técnicas del contrato

7. Si el proceso de pruebas fue satisfactorio se pone en marcha el producto; esta

actividad se hace en forma conjunta. La empresa solicitante recibe toda la

documentación de desarrollo del proyecto

8. Con la puesta en marcha se inicia la fase de operación del producto que,

normalmente, está a cargo del solicitante

9. Cuando se hallen problemas de operación tanto por incumplimiento de los

requerimientos contratados inicialmente como por la necesidad de incluirle

Page 71: Como Escribir Documentos Tecnicos de Ingenieria v13

nuevas prestaciones al producto, se le solicita a la empresa oferente el servicio

de mantenimiento. Es decir, se inicia de nuevo el proceso, pero con un solo

ofertante. Este servicio puede dar pie a un nuevo contrato y a nueva

documentación

El trabajo de grado involucra a los estudiantes en este proceso. La propuesta inicial

y el anteproyecto, fases de planeación, responden al punto uno (1). La solicitud de ofertas

corresponde al punto dos (2). La recepción de la solicitud de ofertas, análisis de

requerimientos y diseño global, pertenecen a la oferta, punto tres (3). El análisis de las

ofertas recibidas, la selección del ganador y el contrato, se relacionan con el punto cuatro

(4). El diseño detallado, implementación, pruebas, documentación –incluyendo los

manuales- hacen parte del punto cinco (5). Las pruebas de aceptación hacen parte del

punto seis (6). Y la puesta en operación corresponde al punto siete (7).

Los puntos ocho (8) y nueve (9) no se presentan en el trabajo de grado, pues

exceden los objetivos del mismo.

Así que, el trabajo de grado simula el proceso licitatorio entre empresas que

necesitan bienes y servicios y aquellas que los generan. En el primer caso, se prepara a

los estudiantes para hacer el capítulo técnico de una licitación, solicitar ofertas, recibirlas y

analizarlas, y efectuar las pruebas de aceptación del bien o servicio solicitado. En el otro

caso, el estudiante se prepara para recibir pliegos de licitaciones, analizarlos, y presentar

ofertas; y, posteriormente, diseñar, implementar, probar y documentar los productos

solicitados.

Page 72: Como Escribir Documentos Tecnicos de Ingenieria v13

Fig. 5.4 Relaciones entre empresas generadoras de bienes y/o servicios y aquellas otras que necesitan bienes

y/o servicios

5.3.2 Auxiliar de investigación

Los proyectos institucionales de I+D+i permiten acometer proyectos más

ambiciosos que se fundamenten en la certeza de la aplicabilidad de los conocimientos

Page 73: Como Escribir Documentos Tecnicos de Ingenieria v13

elaborados y en la utilidad de los resultados de la investigación aplicada o de la

investigación básica dirigida. Los resultados utilizables se concretan generalmente en

prototipos de laboratorio, algoritmos y documentos descriptivos, que, a pesar de la certeza

absoluta de su funcionamiento, dejan margen de incertidumbre con respecto a su

viabilidad y factibilidad.

Por otra parte, estos proyectos pueden tener como propósito la obtención de

materiales, dispositivos o sistemas ajustados a especificaciones concretas y susceptibles

de producción industrial.

En ese ámbito, los estudiantes pueden participar como auxiliares en los proyectos

de investigación institucionales que hacen parte de las líneas de investigación.

Sus actividades se relacionan especialmente con la búsqueda y la recuperación de

información del área del conocimiento ligada al problema de investigación por resolver. En

ese proceso deben adquirir habilidades para reducir la cantidad de información, y hacerla

más pertinente al problema objeto. El siguiente paso es revisar los documentos obtenidos

y analizar su uso y aplicabilidad en el contexto del proyecto de investigación.

Los auxiliares de investigación también participan en la elaboración de artículos de

revisión de un tema específico. Asimismo, pueden participar en el diseño, la

implementación y las pruebas de algunas partes del proyecto.

Page 74: Como Escribir Documentos Tecnicos de Ingenieria v13

6. CÓMO HACER PRESENTACIONES ORALES

El ingeniero no sólo tiene que hacer trabajos y escribirlos; también tiene que

realizar presentaciones orales sobre sus trabajos en diferentes escenarios, ya sea como

estudiante o como profesional. Como estudiante hace presentaciones ante sus

compañeros de clase y, además, sustenta su trabajo de grado; como profesional expone

en simposios, seminarios, congresos y juntas directivas, por ejemplo.

Pero dado que no recibe formación explícita para llevar a cabo presentaciones

orales entonces toma como ejemplo a sus profesores; de algunos aprende algo y de otros

sólo “perpetúa errores comunes y no logra el mejor provecho de sus intervenciones”

[Roselli, 1992, 1].

En este apartado se describen algunos principios básicos que se deben tener en

cuenta tanto para presentar sus trabajos en la universidad como para hacer sus

exposiciones durante el ejercicio profesional. Sin embargo, estos principios deberán

ajustarse a la personalidad del conferenciante y al evento donde hará su presentación

[Day, 1996, 140-143; Michaelson, 1990, 148-156; y Roselli, 1992, 31-38].

6.1 Diferencias entre lo escrito y lo oral

Ante todo, para preparar una conferencia, se debe ser consciente de las diferencias

básicas entre lo escrito y lo oral.

En primer lugar, debe tenerse en cuenta que un oyente aprende en forma más

lenta que un lector, ya que la cantidad de detalles que se puede asimilar en forma oral es

bastante menor, comparada con la que se puede absorber en forma escrita, pues el lector

tiene libertad para hojear el material, detenerse en los puntos que más le llaman la

atención, consultar diccionarios u otras obras, fijar su ritmo de lectura. De esta manera, si

no entiende una parte puede retomar el párrafo o capítulo y releerlo hasta comprenderlo.

Además, lo puede hacer en el sitio y en el momento deseado. Empero, en una conferencia

se depende del expositor: no se tiene tiempo de repeticiones. Si el oyente se distrae se

pierde información que ya no se podrá capturar; tampoco se pueden hacer consultas.

Asimismo, la cantidad de detalles es muy diferente. En los documentos escritos

aparecen todos los detalles del trabajo que, por el contrario, no pueden ni deben tener

Page 75: Como Escribir Documentos Tecnicos de Ingenieria v13

cabida en las filminas de una conferencia: ni por tiempo ni por espacio. De ahí la

importancia de extractar adecuadamente el tema que se presentará en la conferencia,

siempre pensando a quién va dirigido y qué se desea obtener. Los datos que son

importantes para el expositor no lo son, a veces, para el auditorio; por eso hay que saber

qué se espera de lo que se informa.

Por otra parte, en los documentos escritos no se tiene contacto directo con el autor

mientras que en la presentación oral sí. Entonces la personalidad del expositor influye en

forma más directa en una conferencia (a favor o en contra). Además, la manera de hablar

comunica al auditorio ciertas impresiones que no se detectan en un escrito; por ejemplo,

la inflexión de la voz permite enfatizar las ideas en otra forma. Por lo demás, la audiencia

responde en forma directa ante la actitud entusiasta o aburrida del conferenciante.

Adicionalmente, la actitud de la audiencia realimenta al disertante. Así, si éste los

nota entusiasmados podrá ir más lento y suministrar más explicaciones, pero si los nota

aburridos deberá aligerar el ritmo y terminar cuanto antes.

6.2 Estructura

Toda presentación oral debe tener una estructura. La mejor guía para organizar

una presentación verbal es seguir el mismo orden lógico que se utiliza en los documentos

escritos. Así que, para un trabajo de grado se arranca del resumen y se complementa con

algunos apartes de la introducción, a saber:

• Se presenta el problema

• Se muestra el objetivo general y su alcance; de ser necesario se incluyen

los principales objetivos específicos

• Se explica cómo se resolvió el problema; se describe la alternativa

seleccionada conjuntamente con la tecnología empleada

• Se muestran los resultados logrados

• Se incluyen las conclusiones más importantes del trabajo

• Se resalta la contribución del proyecto a la solución del tema planteado

Para un trabajo en el ejercicio profesional se sigue una estructura abreviada del

paper teniendo en cuenta que los simposios, congresos, seminarios, etc., no son

publicaciones primarias. Allí se plantean ideas nuevas; también se especula. Como dice

Page 76: Como Escribir Documentos Tecnicos de Ingenieria v13

Day (1996, 128): “Una comunicación a una conferencia debe cumplir la función de un

informe auténticamente preliminar; debe presentar y fomentar la especulación…Las

conferencias mismas sirven de foro para presentar las ideas más recientes”. En

consecuencia, la estructura debe facilitar la agilidad del discurso:

• Se plantea el problema

• Se expone la solución, sin gran detalle

• Se muestran los resultados

• Se discurre con las conclusiones

La estructura planteada parte del problema, pasa por la solución y llega a las

conclusiones. Eso es lo que espera escuchar una persona que desconoce el trabajo del

expositor.

En cualquier caso, sin importar la estructura que utilice, es conveniente que al

iniciar la exposición presente la estructura que tiene la presentación. No hacerlo es

mantener al público en suspenso como en una película de misterio, con el riesgo de que el

espectador pierda interés.

6.3 Cómo prepararse

Existen tres formas clásicas de hacer una presentación oral: leer el documento

preparado para ese fin; utilizar un conjunto de tarjetas de apoyo; o utilizar ayudas visuales

para hacer la exposición. La primera forma casi se descarta de entrada, pues el auditorio

no está compuesto de personas limitadas. Para una presentación de ingeniería, la forma

más natural es la tercera, ya que los documentos de ingeniería dependen normalmente de

figuras, tablas y fotografías que destacan los puntos básicos y, en consecuencia, los

ingenieros se sienten más cómodos en ese ambiente. [Roselli, 1992, 31-32; y Michaelson,

1990, 150-152].

Durante la preparación el conferenciante debe combinar tanto los intereses propios

como los de los organizadores de la conferencia y los de la audiencia. El expositor debe

ajustar sus propósitos a este marco de referencia independientemente del tipo de trabajo

que presente –descripción de un sistema, solución de un problema, aplicaciones de una

tecnología, etc.-. De la empatía que logre con la audiencia dependerá el éxito de la

conferencia.

Page 77: Como Escribir Documentos Tecnicos de Ingenieria v13

6.3.1 Ayudas audiovisuales

Las ayudas visuales son fundamentales al ser lo único que ven los asistentes

(además del expositor). Por ende, se debe planear bien la selección de figuras, tablas y

fotografías especialmente preparadas para la presentación. Se debe evitar la utilización de

diapositivas de entretenimiento o con efectos especiales que distraigan a los asistentes

alejándolos del propósito principal. La exposición oral alrededor de las diapositivas exige

que la presentación de éstas esté más ligada, que se utilicen más conectores para

relacionarlas entre sí –la anterior con la presente o con la que sigue-. Por ejemplo, en

contraste con la figura anterior…en ésta se destaca…; en esta tabla se muestra…mientras

que en la siguiente…, etc. El uso de conectores ayuda a mantener la atención de la

audiencia.

Hay que ser muy cuidadosos con el orden de las diapositivas; éstas deben unir los

temas que se expondrán en forma secuencial. Además, deben ser simples y claras y estar

preparadas especialmente para la exposición. El tamaño de letra debe ser grande para

que la audiencia más lejana pueda leerlas fácilmente. Por otra parte, es aconsejable no

utilizar mayúsculas corridas pues su lectura toma más tiempo.

En este sentido Roselli [1992, 36] propone una regla sencilla: 7 por 7. “El texto no

debe sobrepasar los siete renglones, ni debe haber más de siete palabras por renglón”.

Igualmente Roselli [1992, 35] resalta: “la ayuda audiovisual más importante en

toda la conferencia es…¡usted! Su actitud, sus movimientos, mímica, gesticulación,

contacto visual, el énfasis y la entonación de sus palabras, son armas más poderosas que

cualquier video”. Sin embargo, aunque esto es muy importante, no debe cambiar su forma

de ser. Con la ayuda de una grabadora o de unos pocos amigos [ver numeral 6.3.4] usted

puede reconocer algunos de sus defectos y tratar de corregirlos, pero en esencia, debe

seguir siendo usted mismo.

Para preparar las ayudas visuales se utilizan herramientas profesionales que

apoyan su elaboración; entre las más utilizadas están Power Point, Word, Excel, y Project,

aunque existen otras.

Asimismo, es común utilizar señaladores y micrófonos para ayudarse en la

exposición, pero se deben utilizar apropiadamente; por ejemplo, se debe aprender a

encender y apagar el micrófono, a mantenerlo a una distancia fija para que el sonido se

ajuste al tamaño de la sala y no esté variando constantemente. Si el micrófono se puede

Page 78: Como Escribir Documentos Tecnicos de Ingenieria v13

desprender de su soporte debe instruirse sobre su uso, pues facilita la separación del atril

para moverse libremente por el escenario; empero no lo utilice para señalar.

Por su parte, el señalador sirve para resaltar el aspecto de la diapositiva

relacionado con la exposición, pero su uso se debe limitar a lo estrictamente necesario. No

juegue con él, pues lo convierte en un distractor.

Además, es un error apoyarse en videos largos. Éstos exigen de una exposición

más larga que les dé cabida; por ejemplo, en un seminario. Sin embargo, el empleo de

videos de corta duración que resalten en forma inmediata un punto de la exposición tiene

un gran efecto. No obstante, el uso de varios medios debe ser dinámico; la transición

entre ellos no debe dar lugar a interrumpir la dinámica de la exposición.

6.3.2 Tiempo

La duración de una presentación verbal varía según el tipo de evento. Así, por

ejemplo, el tiempo asignado para hacer una exposición en un simposio es de 20 minutos;

para sustentar un trabajo de grado es de media hora; para un seminario es de una hora.

Pero, en contraste, el tiempo asignado para presentar un proyecto ante una Junta

Directiva se limita normalmente a diez minutos.

En consecuencia, cabe hacer hincapié en que el contenido a exponer debe ser

reducido; un gran número de ideas, por muy organizadas que estén, pueden resultar

confusas si se exponen rápidamente. Por tanto, hay que ajustar la preparación de la

presentación oral al tiempo asignado.

Por ejemplo, mientras que a la sustentación se le asignan normalmente 30

minutos, un estudiante utiliza tres semestres académicos para desarrollar el proyecto. Por

ende, no se puede tratar de plasmar todo el contenido del trabajo de grado en la

presentación oral.

Para tener éxito recuerde que usted tiene algo importante que decir sobre el tema

propuesto; por tanto, trate de comunicar ese mensaje en el tiempo asignado. Pero si

usted no tiene nada importante que decir, debe declinar la invitación a la conferencia;

lamentablemente, cuando se trata de su trabajo de grado, no puede renunciar a hacer la

sustentación.

En conclusión: tenga en cuenta que no conviene llenar de detalles su presentación.

Quien desee los detalles los podrá encontrar en el documento escrito. Las ideas a exponer

deben ser pocas y concretas, presentando detenidamente los puntos principales.

Page 79: Como Escribir Documentos Tecnicos de Ingenieria v13

6.3.3 Público

Un aspecto a considerar es el público a quien va dirigida la conferencia; un error de

apreciación en este sentido puede ser fatal. La audiencia puede ser especializada en el

tema o ser más heterogénea. Si el público es diverso, la información debe ser más

general, definirse los términos empleados y explicar los conceptos difíciles.

De todas formas, el conferenciante está obligado a presentar los materiales clara y

eficazmente, de forma tal que el público pueda entender la información que se le

comunica y aprender de ella [Day, 1996, 142].

Por otra parte, existe una cortesía tácita entre los asistentes y el presentador. Si el

moderador de la conferencia no lo informa, el expositor propondrá el momento oportuno

de las preguntas: en cualquier instante o al final de su exposición. Esto depende del tipo

de evento; por ejemplo, en un simposio se hacen al final y en una sustentación se pueden

hacer en cualquier momento a partir de que el conferenciante haya hecho la presentación

del tema a tratar. Las normas de cortesía exigen que:

• El público esté silencioso y atento

• Las preguntas y respuestas sean corteses y profesionales

• El público pueda hacer preguntas o relacionar temas no tratados por el

expositor que amplíen la riqueza del debate

En el caso de la sustentación de un trabajo de grado, el público está compuesto

por estudiantes de pregrado que quieren obtener información sobre el tema, los jurados y

el director del proyecto que han leído el documento y esperan precisiones y aclaraciones al

mismo y los directivos y profesores interesados en el tema.

En resumen: el lenguaje, el nivel y los detalles de la sustentación deben prepararse

para este público.

6.3.4 Ensayos

La forma más fácil de llevar una presentación oral al fracaso es no haberla

ensayado antes; no importa que se tenga una alta experiencia como expositor. Por tanto,

una vez que se haya preparado la conferencia se debe ensayar en voz alta, en forma

individual o ante una audiencia reducida.

Una buena ayuda es utilizar una grabadora para reproducir su presentación. Es

muy diferente la percepción que se tiene de uno mismo al hablar que al escucharse a

Page 80: Como Escribir Documentos Tecnicos de Ingenieria v13

través de una grabación. Es sorprendente encontrar un lenguaje mal utilizado, impreciso,

carraspeos, muletillas, voz monótona, mala dicción, etc.

Otra excelente ayuda es reunir una pequeña audiencia con algunos de sus

compañeros de curso o de sus colegas de oficina. Así podrá:

• Controlar el tiempo de exposición para ajustarse al tiempo asignado

• Visualizar la estructura básica de la presentación

• Controlar el mensaje de las diapositivas

• Controlar el lenguaje utilizado, articular bien las palabras

• Detectar las muletillas como presentador para tratar de evitarlas

También se puede practicar frente a un espejo para observar su vocalización,

gesticulación, ademanes y manías, y evitar algunos errores.

6.4 Exposición de la conferencia

El día de la conferencia debe llegar temprano con todos sus materiales listos y

ordenados -notas, CD/USB, diapositivas, documentos de apoyo y señalador-. Debe

comprobar que toda la infraestructura de apoyo esté en orden: videobeam, bombillo de

repuesto, PC, micrófono, atril, iluminación de la sala y baño. Debe fijarse en el cableado

tendido sobre el piso y en los escalones para llegar al escenario. Esto le dará seguridad

sobre los medios a utilizar y no perderá tiempo.

Usted no puede perder la oportunidad de iniciar la presentación en el momento en

que es anunciado. Por tanto, evite los problemas de último momento. Así que averigüe

con anticipación sobre la infraestructura disponible en el sitio de exposición con el fin de

evitar la incompatibilidad entre su presentación y los recursos suministrados. Pero vaya

prevenido; es una buena práctica llevar varias versiones de su exposición –mínimo dos: la

actual y la anterior-. Además, si se le facilita, lleve su propio computador e instrúyase

sobre el procedimiento para conectar el PC y el videobeam, y practíquelo.

Cuando llegue el momento se puede experimentar miedo escénico. Esto le ocurre a

casi todo el mundo y se debe fundamentalmente al temor de no estar bien preparado para

enfrentarse a la audiencia. Pero usted preparó bien su conferencia, la ensayó previamente

y corrigió los defectos hallados; también está seguro de que tiene algo que decir y que

Page 81: Como Escribir Documentos Tecnicos de Ingenieria v13

eso es importante. Sin embargo, un poco de miedo escénico no hace daño, pues lo

mantendrá alerta.

Finalmente, al subir al escenario, mire de frente a su audiencia y muéstrese

confiado; esta actitud es contagiosa.

Vista discretamente, evite movimientos y posturas que distraigan a la audiencia.

Sea usted mismo, no actúe. Sus movimientos y su tono de voz deben ser normales pues le

ayudarán a hacer una presentación variada. Cuando presente las diapositivas no le dé la

espalda al público pues, de un lado, usted ya las conoce y, de otro, mantener el contacto

visual les da a los oyentes la impresión de que usted les está hablando directamente.

6.4.1 Lenguaje

El volumen y la entonación de la voz deben ser normales y las variaciones de

velocidad muy naturales. Esto hará que su discurso no sea tedioso sino que, por el

contrario, sea variado y haga énfasis automáticamente en los puntos que lo requieren.

Si está nervioso, inicie su conferencia en forma lenta que con el transcurso del

tiempo la velocidad se normalizará.

En conclusión, a medida que usted se compenetra con el discurso de su

presentación, instintivamente adaptará el ritmo y acomodará el tono de su voz a las

diferentes partes de su exposición. Eso lo hará de manera natural.

Asimismo, el buen uso del lenguaje lleva a evitar las muletillas, los extranjerismos y

emplear bien las palabras. También se recomienda que haga su exposición en primera

persona singular o a nombre del grupo, si existe.

6.4.2 Apertura

Ya en la conferencia hay dos puntos de vista: por un lado, el conferencista que

desea una audiencia atenta e interesada en el tema con el fin de exponer su trabajo y

resultados. Y por otro, el auditorio que confía encontrarse con un expositor claro y preciso

para aprender de él.

Cuando se inicia la presentación usted es el centro de atención de todo el

auditorio: no lo defraude. Una buena forma de empezar es ir al grano de inmediato:

definir el propósito, los puntos a desarrollar y lo que desea demostrar.

Así que una introducción debe incluir los siguientes puntos, [Roselli, 1992, 32-33]:

Page 82: Como Escribir Documentos Tecnicos de Ingenieria v13

• La presentación del expositor -por el moderador o, si éste no lo hace, por

parte suya-

• Un breve saludo

• La presentación del contenido (el tema y cómo lo va a desarrollar)

• La motivación (¿para qué sirve esto?); trate de dar ejemplos de aplicación

práctica

Por otra parte, si tuvo tiempo y concentración para escuchar las exposiciones que

le precedieron - en un simposio o en un congreso-, trate de unir su tema con lo tratado en

las conferencias anteriores.

Asimismo, haga la introducción con las luces prendidas para establecer contacto

visual con el auditorio y, al iniciar el desarrollo del tema, no apague todas las luces.

6.4.3 Curso de la conferencia

Terminada la introducción se inicia la exposición de los puntos que planificó

desarrollar. Cabe hacer hincapié en la importancia de seguir el plan trazado, de tal forma

que se note la cohesión, la secuencia y la lógica del discurso.

La secuencia de puntos por desarrollar será semejante a la que se muestra en la

figura 6.1.

Page 83: Como Escribir Documentos Tecnicos de Ingenieria v13

Fig. 6.1 Plan de la exposición

Es necesario recalcar que todos los puntos que se han mencionado en los otros

numerales de este capítulo se aplican aquí.

6.4.4 Cierre

Es la parte culminante de su intervención. Incluye los siguientes puntos:

• Avise que va a terminar

• Concluya sin agregar material nuevo

• Mencione las nuevas perspectivas del tema

En el cierre la audiencia espera el final de su exposición que puede tomar la forma

de un resumen, un análisis o de una o varias recomendaciones. Aquí tampoco debe

defraudar a su auditorio.

Cuando está cerca del final usted lo inicia con una frase como: para terminar, he

demostrado…; ahora resumiré…; o, en conclusión, recomiendo que…. Inmediatamente los

oyentes le prestarán atención: usted los ha alertado.

Page 84: Como Escribir Documentos Tecnicos de Ingenieria v13

Un final débil es fatal: no debe dar la impresión de que no tiene nada más que

decir y que sólo desea agradecer la atención prestada. Así que no dude en resumir sus

resultados más llamativos y en resaltar su significado. Sin embargo, otra forma de

terminar es reconocer las limitaciones de su diseño o de sus resultados y destacar los

aspectos aún oscuros y aquellos que deben ser estudiados o desarrollados posteriormente.

Estos comentarios honestos e ingenuos apaciguan a sus críticos [Michaelson, 1990, 154-

155].

6.4.5 Preguntas

Si su presentación termina con una sesión de preguntas y comentarios, usted está

en libertad de agregar información no presentada para aclararlas. Por lo demás, usted

debió anticiparse a algunas de éstas pues esta sesión también se practica durante los

ensayos con sus condiscípulos o compañeros de trabajo.

Esta parte de la conferencia es una realimentación a su presentación: la ausencia

de preguntas puede indicarle que su exposición no era de interés para ese público en

particular o que la saturó con demasiadas ideas para el tiempo otorgado. Por otra parte,

un buen número de preguntas puede indicar que ha sido exitosa, pero también puede

implicar que la audiencia fue receptiva pese a que su documento no sea meritorio.

Page 85: Como Escribir Documentos Tecnicos de Ingenieria v13

7. BÚSQUEDA Y RECUPERACIÓN DE INFORMACIÓN

Luego de haber precisado el problema, el ingeniero encuentra que hay que definir

las necesidades de información que permitan conocer el estado del arte de su proyecto:

¿Qué se ha hecho anteriormente? Entonces inicia los procesos de búsqueda y

recuperación de información. El primer proceso, búsqueda, es el más dispendioso de los

dos, y de él depende la calidad de la información pertinente que se allegue. El proceso se

complementa con la obtención y análisis de la información encontrada.

7.1 Búsqueda de información

La búsqueda bibliográfica responde a las necesidades de información determinadas

por el problema a resolver y tiene por objeto ubicar los documentos actualizados más

relevantes. El éxito del proceso depende de que haya una estrecha correspondencia entre

las necesidades y los resultados, para lo cual hay que precisar los criterios y exponer la

estrategia de búsqueda.

7.1.1 Definir los criterios de búsqueda

Ante todo es necesario delimitar con precisión qué es lo que se busca y cuál puede

ser el punto de partida; con este fin, se repasan los siguientes aspectos [maría pinto,

2004, www.mariapinto.es/e-coms/nece_info.htm#neinfo9]:

• Se precisa la finalidad de la información que se busca; relacionada con el

problema a resolver.

• En segundo lugar, se especifica el conocimiento que se tiene sobre el

asunto, pues rara vez se parte de cero. Dentro de un grupo de

investigación, se indaga por lo que se haya hecho al respecto, por los

documentos obtenidos de las bases del conocimiento existente o que se

elaboraron como consecuencia de proyectos anteriores, o de fases

anteriores del proyecto actual.

Page 86: Como Escribir Documentos Tecnicos de Ingenieria v13

• Consultar, también, las obras de referencia básicas como el catálogo de la

biblioteca, los diccionarios técnicos específicos del área, las memorias de los

congresos especializados, las normas técnicas.

• Paralelamente, es aconsejable consultar con los expertos en el tema. En un

ambiente académico, este es un recurso que no se debe menospreciar.

• Fijar el plan de ruta o índice de los temas y subtemas a tratar.

• Demarcar, además, el rango cronológico de la búsqueda pues es un aspecto

crucial en los proyectos relacionados con la ciencia.

• Por último, definir cuáles son los tipos de documentos de interés: libros,

tesis, artículos de publicaciones periódicas, patentes, etc. Y, en paralelo, se

debe definir el idioma de búsqueda, teniendo en cuenta que la información

que se encuentra en español no es, normalmente, ni la más actualizada ni

tampoco la más completa.

7.1.2 Formular la estrategia de búsqueda

En primer lugar, hay que definir los términos de búsqueda –palabras clave-; éstos

se pueden mezclar en una o varias frases cortas.

A continuación, se elige la herramienta de búsqueda: base de datos o internet.

Aquí se debe tener en cuenta el acceso disponible. Según la herramienta seleccionada, se

continúa con los siguientes pasos:

A. Base de datos

• Ante todo, se trata de convertir los términos de búsqueda seleccionados en

términos del lenguaje documental (tesauros) de la base de datos.

• Se interroga a la base de datos seleccionada para obtener el número de

respuestas por cada una de las palabras significativas (número de

documentos existentes).

• Se mezclan las palabras significativas mediante los operadores lógicos de

Boole (AND, OR, NOT).

• Se hacen nuevas preguntas para obtener los resultados. Si los documentos

encontrados son muy pocos o no existen, se replantea la estrategia

agregando palabras y combinándolas con los operadores lógicos. Si, por el

Page 87: Como Escribir Documentos Tecnicos de Ingenieria v13

contrario, hay demasiadas respuestas, se delimita la pregunta utilizando

otros operadores lógicos y eliminando palabras significativas.

Hay que tener en cuenta que cada base de datos tiene su propio buscador.

B. Internet

Se siguen los mismos pasos anteriores que se visualizaron para las bases de datos,

empero hay que tener en cuenta algunas características de internet, que pueden incidir en

la calidad de la información que se obtenga:

• Internet es un conglomerado gigantesco de recursos. La documentación

existente en ella es del orden de los billones de bytes.

• Siguiendo el símil de Mañas [José A. Mañas, Dpt. de Ingeniería de Sistemas

Telemáticos, E.T.S. de Ingenieros de Telecomunicación, Universidad

Politécnica de Madrid, 30 de junio, 1994], la internet se parece mucho a

una gran ciudad, donde las redes de comunicaciones proporcionan accesos

a los servicios que se ofrecen a los visitantes. Hay barrios interesantes y

barrios peligrosos; hay tiendas de barrio, supermercados y tiendas de lujo;

hay zonas que vale la pena visitar y otras que no; hay ciudades

universitarias y parques tecnológicos, etc.

• A diferencia de una ciudad, la internet se puede recorrer cómodamente

desde casa.

• La internet es abierta y voluntaria; de ahí su éxito y su debilidad. Éxito:

porque al no ser de nadie, todo el mundo la considera un poco suya y hace

aportes. Debilidad: porque tiene poco orden y la calidad no es homogénea.

Además, hay que tener en cuenta que en internet existen varios buscadores, como

Google y Copérnico, por ejemplo.

C. Ejemplo

Se supone que el proyecto a trabajar tiene como problema la posible incidencia de

las radiaciones emitidas por la telefonía celular en la salud humana, concretamente, en la

posibilidad de que produzca cáncer.

Page 88: Como Escribir Documentos Tecnicos de Ingenieria v13

También se supone, que no se tiene conocimiento al respecto y que se trata de

allegar información para conocer el estado del arte relativo al problema. Es decir, se

presume que es un macroproyecto que se quiere acometer y que su primera fase es

averiguar el estado del arte del problema mencionado.

En primer lugar, se inicia la definición de los criterios de búsqueda:

• En la biblioteca universitaria se encuentran algunos libros básicos sobre

electromagnetismo y telefonía celular que permiten aclarar los

conocimientos básicos del funcionamiento de los celulares de tercera

generación; las generaciones anteriores no interesan. De allí se extraen

datos específicos, en caso que se requiera desarrollar un simulador; empero

este no es el problema actual.

• Se busca con la Comisión Reguladora de Telecomunicaciones, CRT, la

normatividad que rige en el país y se obtiene el estudio realizado por la

Universidad Javeriana en el 2000 [Proyecto de marco regulatorio sobre los

límites de la exposición humana a campos electromagnéticos en servicios

de telecomunicaciones, CRT, Informe Final, Universidad Javeriana, agosto

30 de 2000]; este estudio se fundamentó en el documento de la ICNIRP

[Guidelines for limiting exposure to time varying electric, magnetic and

electromagnetic fields, up to 300 GHz].

• Al consultar con los profesores expertos en el tema, ellos sugieren enfocar

la búsqueda teniendo en cuenta los estudios epidemiológicos, con animales

y con células.

• Dado que es un estudio relativo a la ciencia, se considera pertinente sólo la

información de los últimos cinco años; a partir de enero de 2005.

• Además, se estima que la fuente principal serán los estudios de

investigación publicados en revistas especializadas. No obstante, en esta

primera etapa se podrán consultar otros documentos como conferencias.

Ahora se establece la estrategia de búsqueda:

• El primer paso es definir los términos de búsqueda o las palabras clave que

pueden servir para buscar la información. Rápidamente, surgen algunas

Page 89: Como Escribir Documentos Tecnicos de Ingenieria v13

como candidatas: electromagnetismo, salud, telefonía celular, radiaciones

no ionizantes, estudios epidemiológicos, estudios in vivo –con animales-,

estudios in vitro –con células- y cáncer.

• En segundo lugar, se decide utilizar la internet como herramienta de

búsqueda, pues no se conocen, en este momento, bases de datos que

tengan información al respecto. Adicionalmente, se utilizará a google como

buscador.

• El español será el lenguaje de búsqueda, aunque se espera que los

documentos que se obtengan estén en otros idiomas, especialmente en

inglés.

En la tabla 7.1 se muestran los resultados obtenidos con cada palabra primaria.

Tabla 7.1 Resultados de búsqueda por cada palabra clave

Palabra clave Resultados

Electromagnetismo 1.050.000

Salud 54.500.000

Telefonía móvil 38.100.000

Radiaciones no ionizantes 920.000

Estudios epidemiológicos 2.180.000

Estudios in vivo 2.080.000

Estudios in vitro 1.740.000

Cáncer 503.000.000

Los resultados de la tabla 7.1 indican que, aisladamente, esas palabras no dicen

mucho; es necesario acotarlas combinándolas entre sí.

Una opción es mezclar algunas palabras con telefonía celular y riesgo de tumores,

como se muestra en la tabla 7.2, primera parte, cuya cantidad de resultados ha

disminuido considerablemente, pero sigue siendo alta. En consecuencia, en la segunda

parte, se restringen los resultados sólo a los foros; se eliminan las búsquedas en videos,

noticias, blogs y libros.

Page 90: Como Escribir Documentos Tecnicos de Ingenieria v13

Tabla 7.2 Resultados de búsqueda por cada palabra clave

Palabra clave Resultados

Estudios epidemiológicos + telefonía móvil + riesgo de tumores 63.000

Estudios in vivo + telefonía móvil + riesgo de tumores 125.000

Estudios in vitro + telefonía móvil + riesgo de tumores 29.100

Estudios epidemiológicos + telefonía móvil + riesgo de tumores,

sólo en foros

34

Estudios in vivo + telefonía móvil + riesgo de tumores, sólo en foros 87

Estudios in vitro + telefonía móvil + riesgo de tumores, sólo en foros 15

Analizando los 34 y los 15 resultados en foros al considerar: estudios

epidemiológicos e in vitro, surgen algunos datos interesantes, a saber:

• Aparece citado el proyecto Interphone del que se extrae que es un proyecto

coordinado por la Agencia Internacional de Investigación sobre el Cáncer

(IARC) en el que participaron 13 países: Alemania, Australia, Canadá,

Dinamarca, Finlandia, Francia, Israel, Italia, Japón, Nueva Zelandia,

Noruega, Suecia y el Reino Unido. El proyecto empezó en el 2000 y se

enfocó especialmente en la búsqueda de cáncer en la cabeza y la nuca,

áreas de alta exposición durante las comunicaciones; se consideraron los

usuarios adultos con uso del celular en un período entre 5 y 10 años. El

estudio incluyó 6.420 casos y 7.658 de control. Se puede acceder a cada

uno de los estudios realizados. No se tiene el resultado final del estudio.

• Emerge también el proyecto Réflex, en que participaron doce laboratorios

de siete países europeos. “El proyecto buscaba llevar a cabo ensayos

intensivos, para someter in vitro a diferentes sistemas celulares humanos

aislados (fibroblastos, linfocitos, monocitos, melanocitos y células

musculares) a toda una gama de variables electromagnéticas. En una

segunda etapa, las muestras fueron sometidas a un examen atento para

observar si las radiaciones habían implicado efectos genotóxicos y

fenotípicos a nivel celular, considerados generalmente como susceptibles

de conllevar patologías cancerosas y/o neurodegenerativas”. [Réflex,

2005]. El proyecto cubrió el espacio de tiempo entre el 2000 y el 2004.

Page 91: Como Escribir Documentos Tecnicos de Ingenieria v13

• Aparecen algunas entidades relacionadas con el tema: la Organización

Mundial de la Salud, OMS, y su proyecto CEM; la Comisión Internacional

sobre la Protección contra las Radiaciones No Ionizantes, ICNIRP; el foro

de fabricantes de celulares, MMF.

• Hay estudios cuyos resultados indican que se puede producir cáncer y otros

muestran que no.

Así, de una forma rápida se han encontrado dos filones de oro: los proyectos

Interphone y Reflex directamente relacionados con el tema de estudio. Además, se han

encontrado tres entidades relacionadas con el problema: OMC, ICNIRP y MMF.

No obstante los resultados anteriores, surge una inquietud: ¿existen conferencias

internacionales recientes que traten el tema? Si se consigue información relacionada, se

podrá dar por terminada la búsqueda de información inicial. Así, se averigua si entre las

revistas de IEEE existe alguna relacionada con la búsqueda.

• Al indagar por el descriptor IEEE, Google entrega varias opciones. Llama la

atención la opción: ieeexplore.

• Al averiguar con ese descriptor se encuentran 5.300.000 resultados, pero el

segundo resultado muestra: Browse Journal & Magazines, que es

exactamente lo que se busca.

• En esa entrada se indaga por las revistas que traten el tema de biología y

se encuentran tres resultados (Computational Biology and Bioinformatics;

Engineering in Medicine and Biology, publicada por la IEEE Engineering in

Medicine and Biology Society; y Systems Biology). Se averigua más sobre

la segunda revista.

• El EMB magazine permite conocer el contenido del último ejemplar,

diciembre 2009, pero los temas tratados, títulos y resúmenes, muestran

que aunque nos acercamos no estamos bien orientados.

Sin embargo, el ejercicio anterior da una pista: ¿por qué no buscar por sociedades?

Y más concretamente, sociedades relacionadas con la biología y el electromagnetismo

(¿Bioelectromagnetics Society?):

• Al inquirir en Google se encuentran 71.800 resultados, pero al revisar la

primera página aparecen dos entradas interesantes: Bioelectromagnetics

Society, BEMS, que indica que es una organización de científicos, biólogos y

Page 92: Como Escribir Documentos Tecnicos de Ingenieria v13

físicos, médicos e ingenieros interesados en las interacciones de las

radiaciones no ionizantes con sistemas biológicos; por otra parte, también

aparece Bioelectromagnetics Society (BEMS) Proceedings, que entrega

cuatro documentos:

o Bioelectromagnetics Society and European Bioelectromagnetics

Association. Joint Meeting, 2009. Abstract Collection.

Held 14-19 June 2009, Davos, Switzerland.

o Bioelectromagnetics Society Annual Meeting. 29th 2007. Abstract

Collection.

Held 11-15 June 2007, Kanazawa, Japan.

o Bioelectromagnetics Society Annual Meeting. 30th 2008. Abstract Collection. Held 8-12 June 2008, San Diego, California.

o Bioelectromagnetics Society Annual Meeting. 28th 2006. (Abstracts). Held 11-15 June 2006, Cancun, Mexico.

Llama la atención la conferencia conjunta realizada con la Asociación Europea de

Biolectromagnetismo (EBA), pues los proyectos Interphone y Réflex han surgido por

iniciativa europea. Así que se busca ese documento y se encuentra otra joya, de una

conferencia reciente, que trata el tema objeto del proyecto. En consecuencia, ya se

dispone de información suficiente para iniciar el análisis de cada uno de sus documentos.

7.2 Recuperación de información

Una vez que se ha obtenido el listado de documentos se encuentra la disyuntiva de

separar aquellos estudios relacionados con el problema de aquellos otros que no lo están.

Empero, en este punto se dispone, normalmente, sólo de los títulos y resúmenes de los

estudios. Obtener el documento completo de cada estudio cuesta, pues la mayoría de las

revistas y bases de datos cobran por esa información. En consecuencia, se hace necesario

hacer una primera selección a partir de la información disponible, pero sin que se pierda la

información de los estudios que se dejan de lado, pues éstos se pueden necesitar más

tarde. Aquí se sugiere documentar el proceso, como se muestra en la tabla 7.3.

Page 93: Como Escribir Documentos Tecnicos de Ingenieria v13

Tabla 7.3 Selección de documentos

Título Selección Resumen Selección

Primer título Sí 1er Resumen Sí

Segundo título Sí 2º Resumen Sí

Tercer título Sí 3er Resumen No

Cuarto título Sí 4º Resumen Sí

Quinto título No 5º Resumen No

Sexto título Sí 6º Resumen No

Séptimo título Sí 7º Resumen Sí

Octavo título No 8º Resumen No

Noveno Título Sí 9º Resumen No

Décimo título No 10º Resumen No

En el ejemplo de la tabla 7.3 se supone que se tiene el título y el resumen de diez

artículos. A partir de esa información se inicia el proceso de selección de la documentación

que se requiere para conocer el estado del arte del problema objeto de estudio.

Cuando el número de artículos es grande, la primera selección se hace a partir del

título; si éste nos convence, se pasa a leer el resumen para confirmar la primera

apreciación. Si el título no convence, entonces se descarta el artículo y ya no se lee el

resumen; es un documento eliminado. En el ejemplo anterior, se muestra que a partir del

título aparecen siete documentos opcionados, sólo se descartaron tres. En el segundo

paso, se leen los resúmenes de los siete documentos que pasaron el primer filtro; a partir

de la lectura de los resúmenes se eliminan dos artículos. En consecuencia, sobreviven

cinco documentos.

En ese punto es necesario disponer de los documentos seleccionados, es decir, se

requieren los artículos completos; pero algunos de ellos tendrán un precio. Esa fue la

razón por la cual se hizo la selección anterior, pues se podría haber adquirido todos los

Page 94: Como Escribir Documentos Tecnicos de Ingenieria v13

documentos. Sin embargo, se habrían gastado recursos en cinco documentos que no son

de interés.

Si se pertenece a un medio académico, es normal, que se busque el apoyo de la

biblioteca universitaria pues es posible que algunos de los documentos estén dentro de las

colecciones de la biblioteca, en cuyo caso no se hacen erogaciones innecesarias. Por otra

parte, las bibliotecas tienen un servicio de búsqueda de artículos que ayuda a ubicarlos en

otras bibliotecas universitarias o en otras bases de datos. Así, si existen convenios

interinstitucionales, se podrán conseguir algunos artículos sin costo alguno; en los otros

casos, se obtiene información de su disponibilidad y costo.

Una vez que se han obtenido los documentos solicitados, se sigue un

procedimiento de selección rápida para conocer su mayor o menor pertinencia respecto al

problema. Es decir, con el proceso anterior, títulos y resúmenes, se descartaron aquellos

documentos que, en primera instancia, no son de interés. Empero, ahora el problema es

averiguar la mayor o menor pertinencia de los artículo completos que se han adquirido.

Con este fin, se sigue el siguiente procedimiento de lectura:

• En primer lugar, se lee la introducción de cada uno de los artículos para

constatar su pertinencia, y se descartan aquellos que no lo son.

• A continuación se leen las conclusiones de los documentos que continúan y

se señala su pertinencia.

• Finalmente, se lee el capítulo de desarrollo de los documentos

sobrevivientes.

Este proceso indica, en primer lugar, que a pesar de la selección efectuada es

posible que se hayan colado documentos no relacionados con el problema. En segundo

lugar, se pueden clasificar por su mayor o menor conformidad para proseguir con la

lectura del capítulo de desarrollo donde se encuentra la mayor cantidad de información.

Page 95: Como Escribir Documentos Tecnicos de Ingenieria v13

Tabla 7.4 Selección y prioridad de lectura de los artículos seleccionados

Título Introducción Conclusiones Desarrollo Prioridad

Primer título Sí Sí Sí Segundo

Segundo título Sí No No

Tercer título No No No

Cuarto título Sí Sí Sí Primero

Quinto título Sí Sí Sí Cuarto

Sexto título Sí Sí Sí Tercero

Séptimo título No No No

En el ejemplo de la tabla 7.4 se nota que al leer la introducción de esos siete

documentos se encuentran dos que no coinciden con las expectativas creadas y, por ende,

se eliminan. A continuación, al leer las conclusiones hay otro artículo que queda eliminado.

Finalmente, se leen completamente los artículos seleccionados y se fija su prioridad según

el problema objeto. Es decir, se trabaja primero con aquellos que llenan más las

expectativas creadas.

Al leer completamente cada artículo seleccionado, también se efectúa su análisis.

Pero este ya es tema del siguiente capítulo: Guía para analizar documentos.

Page 96: Como Escribir Documentos Tecnicos de Ingenieria v13

7. CÓMO ELABORAR UN ARTÍCULO PARA REVISTA

Al final del trabajo de grado los estudiantes de ingeniería de la Universidad El

Bosque deben entregar un artículo para la revista de ingenierías. Ahí presentan su trabajo

de grado a un público más amplio y con intereses diferentes a su director y jurados.

En este proceso los estudiantes hacen sus primeros pinos para elaborar

manuscritos con destino a una revista. Empero en su vida profesional continuarán

realizando este tipo de escritos. Por tanto, deben aprender cómo realizar un artículo para

una revista.

Ante todo deben escoger el tipo de revista en que desean publicar. Aquí se

considera el renombre de la publicación seriada y el tipo de público –lectores- a que se

destina el artículo. A continuación, se elabora el documento, se lo remite al editor, quien

lo somete al arbitraje de los pares y, si es aceptado, se publica.

Con el fin de ayudar en la selección de la revista, Colciencias (Publindex, 2008)

establece criterios para analizar la calidad de una publicación seriada: calidad científica,

calidad editorial, visibilidad y accesibilidad. Donde la calidad científica toma en cuenta: a)

La organización académico-administrativa: editor, composición y calidades del comité

editorial y del comité científico, del grupo de árbitros y de los autores; y b) La calidad de

los documentos publicados y los procesos de su evaluación y certificación. En

consecuencia, si el autor tiene posibilidad de escoger la revista de publicación, es mejor

que ésta esté indexada.

Igualmente, dentro del tipo de artículos a publicar en una revista, Colciencias

considera los siguientes:

• Artículo de investigación científica y tecnológica:

Documento que presenta, de manera detallada, los resultados

originales de proyectos terminados de investigación. La estructura

generalmente utilizada contiene cuatro apartes importantes: introducción,

metodología, resultados y conclusiones.

Page 97: Como Escribir Documentos Tecnicos de Ingenieria v13

• Artículo de reflexión:

Documento que presenta resultados de investigación terminada

desde una perspectiva analítica, interpretativa o crítica del autor, sobre un

tema específico, recurriendo a fuentes originales.

• Artículo de revisión:

Documento resultado de una investigación terminada donde se

analizan, sistematizan e integran los resultados de investigaciones

publicadas o no publicadas, sobre un campo en ciencia o tecnología, con el

fin de dar cuenta de los avances y las tendencias de desarrollo. Se

caracteriza por presentar una cuidadosa revisión bibliográfica de por lo

menos 50 referencias.

También enumera otros artículos con menos pretensiones como:

• Artículo corto

• Reporte de caso

• Revisión de tema

• Cartas al editor

• Editorial

• Traducción

• Artículo de reflexión no derivado de investigación.

• Reseña de libro

Para el caso de los estudiantes de ingeniería de la Universidad El Bosque, el

artículo tiene como destinataria a la Revista de Tecnología. Por tanto, la elección ya ha

sido hecha: se ha escogido la revista y el público destinatario. Ahora deben elaborar el

documento. Con este fin, deben conocer las normas y políticas editoriales de la revista, la

estructura del artículo, el orden de elaboración de los apartados y el contenido de cada

uno de ellos. Después vendrá la remisión al editor, su estudio y aceptación, y, finalmente,

la publicación del artículo.

Page 98: Como Escribir Documentos Tecnicos de Ingenieria v13

8.1 Normas y políticas editoriales de la revista En los números de la Revista de Tecnología aparecen sus políticas editoriales.

También existe un documento con las instrucciones para elaborar el artículo que sigue en

esencia los lineamientos del IEEE. Este documento se encuentra en la página web

http://www.sistemasunbosque.edu.co de la Universidad.

El primer paso que se debe dar es informarse sobre las políticas editoriales y las

normas que deben seguirse, pues los autores deben acogerse a lo exigido por los editores.

En esas normas se encuentran, entre otros, los tipos de documentos admitidos,

información sobre los autores, el proceso de selección por el Comité Editorial y la

evaluación y certificación del artículo por pares académicos. También existen

especificaciones técnicas que incluyen la forma de entrega, características tipográficas,

numeración, viñetas, tablas y cuadros, figuras y fotografías, referencias bibliográficas y

partes del artículo, entre otros.

El conocimiento y asimilación de toda esa información es importante para iniciar un

proceso que pueda ser exitoso. En este capítulo se hará énfasis en la estructura y

elaboración de los apartados del artículo, que según las normas editoriales debe incluir:

resumen, introducción, desarrollo temático, conclusiones y referencias bibliográficas.

8.2 Generalidades del artículo En esencia, el artículo tiene una estructura que consta de tres capítulos:

introducción, desarrollo temático y conclusiones que se complementan con un resumen y

con las referencias bibliográficas.

Ahora bien, si se compara esa estructura con la del artículo científico y con la de un

paper se nota que el artículo científico tiene una estructura de cuatro capítulos y el paper

una de tres. En el artículo científico –introducción, métodos, resultados y conclusiones- y

en el paper –introducción, desarrollo y conclusiones-. Existe cierta similitud en sus

estructuras pero hay diferencias notorias en cuanto al objetivo básico del trabajo que

soportan puesto que el artículo científico busca el avance del conocimiento; el paper tiene,

en general, más connotaciones de tipo tecnológico –aunque toca también aspectos de

investigación-. Por su parte el artículo para revista de los estudiantes de pregrado toca, en

el mejor de los casos, aspectos de innovación aunque éstos están lejos de su aplicación

industrial.

Page 99: Como Escribir Documentos Tecnicos de Ingenieria v13

En forma muy simple se puede decir que en el artículo científico, (Mackerle, 6) y

(Day, 1996, 8-46), la introducción trata del problema estudiado, los métodos indican la

forma como se estudió el problema, los resultados indican los hallazgos o resultados

obtenidos, y la discusión analiza el significado de esos resultados. Haciendo un paralelo

con la estructura del artículo para la Revista de Tecnología se puede concluir que las dos

primeras partes –introducción y métodos versus introducción y desarrollo temático- casi

coinciden, en este nivel de generalidad. Pero la estructura de la revista de ingenierías no

incluye explícitamente la sección de resultados. En consecuencia las conclusiones del

artículo para la Revista de Tecnología deben incorporar los resultados y su discusión,

cuando aplica. Así, se podría decir que éste contiene la misma información que un artículo

científico; la diferencia está en el nivel del contenido y de sus objetivos.

Si se mira más de cerca el paper (Michaelson, 1990, 31-56) se tiene que éste parte

de una introducción, continúa con la parte de desarrollo organizada, llega a la sección de

conclusiones donde realiza la discusión de los resultados. La introducción incluye el

problema, sus antecedentes y la aproximación del autor a la posible solución. Para el

orden u organización de desarrollo se escoge el tema principal que orienta a la sección

principal, que se apoyará en otras secciones menores o complementarias; aquí se halla el

grueso del trabajo. La sección de conclusiones resume los resultados y su significado

tomando en cuenta los trabajos previamente desarrollados; también presenta los aspectos

positivos y negativos del trabajo, lo que la solución puede hacer y lo que no puede hacer;

a veces se incluyen las alternativas de solución al problema de ingeniería planteado y las

razones que llevaron a la alternativa seleccionada. Si se hace una comparación con el

artículo para la revista de ingenierías se tiene, a nivel general, que la última parte del

artículo para la revista debería contener los puntos del paper para que su contenido

general fuese similar. Las diferencias –entre el paper y el artículo para la revista- estarían

también en los contenidos específicos internos y en los objetivos.

En consecuencia, se debe definir bien el contenido de cada una de las secciones

del artículo para la revista de ingenierías para ajustarlos, de tal forma que incluyan los

resultados y su discusión, cuando aplica.

En la tabla 8.1 se puede ver el resumen de los diferentes tipos de artículos.

Page 100: Como Escribir Documentos Tecnicos de Ingenieria v13

Tabla 8.1 Estructura de los diferentes tipos de artículos

Científico Paper Revista de ingenierías

Resumen Resumen Resumen

Introducción Introducción Introducción

Métodos Desarrollo Desarrollo temático

Resultados

Discusión

Referencias Bibliográficas

Referencias Bibliográficas Referencias Bibliográficas

TIPO DE ARTÍCULO

Conclusiones Conclusiones

Ahora bien, cuando el estudiante va a escribir el artículo para la revista, el trabajo

de grado ya está terminado. El objetivo de éste era el aprendizaje de una metodología

para plantear un problema y el desarrollo de su solución como parte de la formación del

estudiante para poderse graduar; el documento de grado también hace parte de esa

metodología. Sin embargo, las motivaciones para escribir el artículo para la revista son

diferentes; aquí ya se busca el reconocimiento de sus pares. Por tanto, la orientación del

documento debe ajustarse a la estructura fijada por los editores de la revista.

También debe tenerse en cuenta el público a quien va dirigida la Revista de

Tecnología: ingenieros no sólo de la Universidad El Bosque, sino de otras universidades

del país con las que se intercambian revistas académicas. El público ha cambiado; ya no

está compuesto por los jurados y el director del trabajo de grado.

Por lo tanto, al sentarse a redactar el artículo para la revista se deben tener

siempre presentes la motivación nueva y el público nuevo.

En forma complementaria, se debe notar que los diferentes apartados de la

estructura del artículo para la revista se pueden escribir en secuencia; esto se refiere al

resumen o abstract en concreto. Como el trabajo ya está terminado, ya no será lo último

que se escribe; se puede escribir de primero. De hecho al elaborar el plan de trabajo, se

escribe junto con la introducción y la tabla de contenido, antes del desarrollo temático.

Page 101: Como Escribir Documentos Tecnicos de Ingenieria v13

8.3 Contenido del artículo Ya se mencionó que la estructura del artículo contiene tres secciones: introducción,

desarrollo temático y conclusiones, que se complementan con el resumen y las referencias

bibliográficas.

Estas son las secciones principales pero no se conoce en forma explícita el

contenido interno de cada una. En consecuencia, lo primero que se debe hacer es elaborar

el plan de trabajo o tabla de contenido del artículo; su hoja de ruta. Es decir, se debe

planear la escritura del artículo.

En este punto hay que tener en cuenta que, para desarrollar el documento de

grado, los estudiantes recibieron la estructura de los distintos documentos, y se les explicó

cuál debía ser el contenido de cada uno de sus apartados. Por otra parte, se les inculcó

como parte de la metodología, que el dispositivo/sistema se desarrolla en paralelo con los

documentos. Pero ahora, al ir a redactar el artículo para la revista, sólo reciben la

estructura básica del documento y, por otra parte, el sistema ya está concluido. ¿Qué

hacer? ¿Un resumen del trabajo de grado? ¿Reescribir todo el artículo? Cualquiera que sea

el camino que se tome se debe tener presente el nuevo escenario.

Para planear el artículo se deben tener en cuenta los intereses de los lectores, los

resultados que se expondrán y su forma de presentarlos. Ese plan de trabajo, como dice

Umberto Eco (1996, 137-146), cambiará durante el proceso pero es mejor iniciar el

camino con una ruta preestablecida a no tener ninguna.

Se debe hacer hincapié en que los objetivos del trabajo de grado permanecen; son

los mismos tanto para el documento del trabajo de grado como para el artículo de la

revista. Las motivaciones para escribir el artículo cambiaron; el público también cambió.

Esas nuevas motivaciones son las que lo ayudan a reorientar la presentación del material

para sus nuevos lectores.

En general, para elaborar el plan de trabajo del artículo para una revista deben

considerarse los siguientes ítems:

• Tratar el tema en forma apropiada para ajustarse a la revista escogida.

• Limitar la longitud del artículo de acuerdo con las políticas editoriales de la

revista.

• Hacer énfasis en los criterios de la revista/editor.

Page 102: Como Escribir Documentos Tecnicos de Ingenieria v13

No existe una mejor forma de organizar el artículo. Se debe tener imaginación para

organizar la información del trabajo de grado, de acuerdo con los intereses de los lectores

y las motivaciones propias. Sin embargo, para organizar la información, trate de contestar

las siguientes preguntas propuestas por Michaelson (1990, 23):

• ¿Cuáles son las ideas principales que quiere presentar en el documento?

• ¿Cuáles ideas sirven de apoyo a las principales?

• ¿Cuáles detalles se deben incluir?

• ¿En dónde debe estar el énfasis del artículo? ¿En los datos, en el diseño, en

la aplicación, en las recomendaciones, etc.?

• ¿Cuál es la longitud del documento?

• ¿Qué figuras y tablas se deben incluir?

Después de contestar esas preguntas ya se puede hacer un primer borrador de la

tabla de contenido. Sin embargo, para que ésta le sirva de orientación debe desagregarla

hasta el tercer nivel, por lo menos; esto no es difícil, pues ya se tiene el primer nivel –la

estructura del artículo-.

La tabla de contenido ayuda a determinar el orden lógico de la información y a

aclarar el pensamiento. Esto es especialmente válido en cuanto se refiere a la sección

principal: desarrollo temático. No obstante, la tabla de contenido debe ser flexible; se

ajusta a medida que se elabora el manuscrito. El borrador inicial de la tabla de contenido

no es una camisa de fuerza, es sólo una guía.

A manera de ejemplo, una propuesta de diseño novedosa, en su momento, de un

sistema de conmutación telefónica, podría haber presentado el siguiente esqueleto de una

tabla de contenido:

RESUMEN

1. INTRODUCCIÓN

a. Tendencias de diseño del control en las centrales telefónicas

b. Necesidad de mejorar la eficiencia del sistema

Page 103: Como Escribir Documentos Tecnicos de Ingenieria v13

c. Nueva enfoque de diseño –control distribuido-

2. DESARROLLO TEMÁTICO

a. Teoría del control distribuido

i. Principio de uso de etapas múltiples

1. Uso de microprocesadores

2. Jerarquía del sistema

3. Comunicación entre etapas

ii. Subsistemas

1. Subsistema de abonados

2. Subsistema de control

3. Subsistema de señalización

iii. Límites teóricos

1. Cantidad de abonados

2. Capacidad de tráfico

3. Capacidad de rutas

b. Características de operación

i. Disminución del bloqueo interno

ii. Rutas alternativas

iii. Bloqueo limitado de abonados en caso de falla de una etapa

iv. Flexibilidad del sistema

3. CONCLUSIONES

a. Significado de los conceptos

b. Eficiencias del sistema

c. Limitaciones del diseño

d. Reducción de costos

e. Aplicabilidad

4. REFERENCIAS BIBLIOGRÁFICAS

En el esqueleto anterior se respetaron las secciones del artículo fijado por los

editores de la revista de ingenierías.

Una vez elaborado el borrador de la tabla de contenido del artículo, ya está listo

para iniciar la escritura del documento.

Page 104: Como Escribir Documentos Tecnicos de Ingenieria v13

8.4 Resumen El objetivo del Resumen es condensar el artículo. Al redactarlo, se debe tener en

cuenta que los lectores no saben nada del trabajo realizado y leen el Resumen para ver si

les interesa el documento. Es más, la mayoría de los lectores sólo leerá el Resumen. Por

tanto, éste debe considerarse como una alternativa al documento, no como una

introducción. Como dice Umberto Eco (1996, 141), un buen resumen le debe dar al lector

la sensación de conocer el trabajo sin haberlo leído.

Un Resumen debe informar, ser concreto y autosuficiente. Debe contener la

información en forma concentrada. Aquí se debe evitar la información complementaria

para exponer solo la sustancia fundamental del trabajo; esto requiere trabajo.

Un Resumen bien elaborado debe orientar a los lectores indicándoles el problema o

propósito del trabajo, explicándoles cómo se solucionó y el resultado principal del trabajo.

La solución del problema puede ser el método, la técnica de diseño, la mejora de un

dispositivo, el esquema de pruebas, etc., según el trabajo.

En el Resumen se debe utilizar un lenguaje familiar, claro y conciso que llegue en

forma directa al posible lector. Por tanto, se deben omitir las siglas y abreviaturas poco

conocidas.

Por otra parte, el tamaño del Resumen lo define el editor de la revista. Sin

embargo, éste no excede las 150 palabras e incluso puede ser más corto. Por tanto, se

debe evitar la verbosidad; cada palabra utilizada debe sopesarse cuidadosamente.

No debe olvidarse que quienes están interesados en buscar información específica

acuden normalmente a los servicios especializados de búsqueda bibliográfica, que prestan

ese servicio a partir de los resúmenes. Algunos de estos servicios lo hacen a partir de las

palabras clave y otros lo hacen a partir de todo el resumen. Por eso se recomienda incluir

máximo cinco palabras clave o descriptores primarios en el resumen que ayudarán a esos

servicios bibliográficos.

Tanto Day (1996, 28-30) como Michaelson (1990, 31-34) proponen hacer un

resumen informativo, que muestre en forma sucinta el trabajo, sin interpretaciones. Es

decir, que el resumen sea una versión reducida del artículo.

Page 105: Como Escribir Documentos Tecnicos de Ingenieria v13

En consecuencia, desde el punto de vista de ingeniería, el resumen de tipo

informativo debe contestar tres preguntas básicas:

• ¿Cuál era el problema?

• ¿Cómo se resolvió?

• ¿Qué resultados se lograron?

• E incluir la conclusión más relevante del trabajo.

Este tipo de resumen les permite a los lectores mantenerse al día en su campo de

acción sin necesidad de leer todo el documento. Pocos lectores o ninguno leerán el

documento completo porque o bien no tienen tiempo o no están interesados.

Sin embargo, para un artículo de revisión, Michaelson propone utilizar un resumen

descriptivo en cuanto a que los lectores necesitan un mapa de ruta que los oriente. (Ver

sección 3.1).

8.5 Introducción No debe confundirse con el Resumen. La Introducción es independiente de éste y

se escribe como si el Resumen no existiera.

Una de las principales dificultades que tiene el escritor del artículo es la percepción

del nivel de conocimientos de sus lectores; éste depende de la revista seleccionada para

publicar el artículo. Para llenar ese vacío se deben leer las políticas editoriales de aquella y

hojear algunos de los números más recientes para tratar de conocer a los lectores. En el

caso de la revista de ingenierías el público son los ingenieros y estudiantes de las

universidades del país con programas similares.

Sin embargo, este es un punto álgido para los escritores. Para Michaelson (1990,

37) es la sección más difícil de preparar puesto que “para los lectores con buen

conocimiento del tema, una exposición minuciosa puede parecer condescendiente e

inapropiada; para otros, menos experimentados, poca información puede hacer que el

propósito del artículo sea incierto”.

Hay que hacer hincapié en que la Introducción se escribe al menos en dos

momentos diferentes:

• Por primera vez cuando se está elaborando el plan de trabajo del artículo

Page 106: Como Escribir Documentos Tecnicos de Ingenieria v13

• Por última vez, cuando se han elaborado el Desarrollo temático y las

Conclusiones.

Así, la primera vez se redacta teniendo en cuenta lo que se intenta hacer en el

documento; la última, según lo realizado. Eco (1996, 137-146) lo dice en forma más

explícita: “…la introducción habrá que ser continuamente reescrita según avance el

trabajo. Así es como se hace… La introducción final será diferente a la inicial. Es lo normal.

Si no fuera así, significaría que toda la investigación efectuada no os ha proporcionado

ninguna idea nueva”.

En la Introducción se debe guiar al lector indicándole el propósito del artículo y

definiendo el problema que dio origen al proyecto. También se deben describir los

antecedentes del problema y los aportes hechos por otros. Asimismo se debe explicar

cómo este trabajo contribuye a llenar algunas necesidades; manifestar su utilidad e

importancia.

La Introducción presenta al lector la columna vertebral del documento y, como tal,

debe contener, al menos, los siguientes puntos:

• Ante todo debe quedar claro el problema y su alcance; si éste no se define

en forma concisa, razonable y comprensible, los lectores ya no se

interesarán por el resto del documento.

• En segundo lugar se debe hacer una revisión de los antecedentes, es decir,

de la bibliográfica centrada en el problema. Ésta debe incluir en forma

concisa tanto los fundamentos teóricos que soportan la solución del

problema como la tecnología relacionada con productos, preferiblemente

comerciales, que den una respuesta al problema planteado.

• A continuación se deben exponer las alternativas de solución visualizadas y

especificar la seleccionada, conjuntamente con la tecnología empleada.

• Asimismo se deben mencionar los principales resultados obtenidos

• Y, en último lugar, presentar la conclusión o conclusiones principales, que

se desprenden de los resultados.

Page 107: Como Escribir Documentos Tecnicos de Ingenieria v13

La estructura planteada va del problema a la solución; es tan importante para los

lectores que es conveniente que haya cierta redundancia con el Resumen.

Como dice Day, (2003, pp 31-33), los temas “deben presentarse de forma que el

lector comprenda cuál era el problema y cómo se trató de resolverlo”.

Finalmente, cabe recordar que no todos los lectores serán de la misma especialidad

que los autores. En consecuencia, la Introducción es el lugar más apropiado para colocar

los principales términos y las abreviaturas especializadas que se vayan a utilizar en el

documento.

8.6 Desarrollo temático En este punto del artículo ya se tienen la tabla de contenido, el Resumen y la

Introducción. Es decir, se tiene el plan de trabajo.

De la tabla de contenido se toman los subtítulos de la sección de Desarrollo

temático para redactar sus contenidos. Sin embargo, este borrador es sólo una guía para

iniciar la construcción del documento que se irá ajustando a medida que se escribe.

El Desarrollo temático es la parte principal del artículo. A medida que se va

escribiendo cada parte se le ocurrirán nuevas ideas para complementar o modificar la

tabla de contenido inicial. Esto es normal, pues el proceso de escribir es dinámico.

En el caso los estudiantes que hacen un artículo para la revista sobre su trabajo de

grado, ya disponen del documento completo del proyecto con mucha información valiosa y

detallada. Por tanto, el principal problema que encuentran está en la orientación que se le

quiere dar al material existente dentro del artículo.

Una de las partes claves para afinar la estructura del Desarrollo temático es la

selección de buenos títulos para las secciones y las subsecciones. La búsqueda de títulos

cortos y descriptivos ayuda al escritor a mantenerse dentro del propósito de cada una de

las secciones sin salirse de ellas y, asimismo, la redacción se le hace más manejable pues

se toman porciones más pequeñas. Cuando se está redactando una sección se empieza a

juzgar el balance e importancia de ésta en el contexto; esto se hace de forma casi

automática. Así, por ejemplo, se puede querer llevar un acápite a nivel de subsección o se

Page 108: Como Escribir Documentos Tecnicos de Ingenieria v13

le puede querer quitar importancia. Así, poco a poco se va obteniendo la estructura final

del artículo.

La importancia de la selección de los subtítulos es tal que Day (1996, 36) propone

tratar de buscar subtítulos que casen con los utilizados en los Resultados, pues se

aumenta la coherencia interna de las secciones y el lector podrá entonces comprender

rápidamente la relación existente entre los Métodos y los Resultados.

En esta sección también es muy importante que las gráficas y las tablas que

soporten el texto estén diseñadas con este propósito específico; no para llenar espacio.

Por ejemplo, son muy útiles las gráficas que ayudan a mostrar las relaciones entre las

partes de un sistema o que muestran la apariencia externa del mismo. Sin embargo, se

debe evitar el uso de gráficas genéricas que no fortalezcan al texto pues, por el contrario,

lo debilitan. Del mismo modo, el uso de tablas puede ayudar a clarificar y resaltar la

información.

Michaelson (1990, 45) propone seleccionar gráficas que apoyen uno de los

siguientes propósitos:

• Que describan una función

• Que muestren la apariencia externa

• Que muestren la estructura interna

• Que ilustren un fenómeno

• Que demuestren las relaciones

• Que sean novedosas y originales

Sin embargo, debe tenerse en cuenta que en los artículos para las revistas sólo

tienen cabida pocas gráficas o tablas.

Por otra parte, la selección de los datos, su nivel de detalle y su presentación son

importantes. ¿Qué se quiere mostrar?, ¿con qué objetivo? Y ¿cuál es la mejor forma de

mostrar lo que se quiere?, son preguntas que ayudan en esta selección. Como dice

Page 109: Como Escribir Documentos Tecnicos de Ingenieria v13

Michaelson (1990, 47): “Muchos detalles ocultan los puntos principales que se quieren

resaltar y pocos oscurecen el documento por falta de información técnica”.

En último lugar, el uso de las fuentes documentales debe hacerse en forma

precisa; las fuentes deben ser citadas. Con este propósito, se deben seguir las normas de

citación indicadas por los editores de la revista. (Ver capítulo 7).

8.7 Conclusiones La sección final es quizás la más difícil de escribir. Muchos artículos con buenas

secciones de Resumen, Introducción y Desarrollo temático sucumben a causa de una

Conclusión deficiente. En esta sección se tiende a la verbosidad.

La sección de Conclusiones resume los resultados y su significado. Debe incluir, si

es posible, una comparación entre los resultados logrados por otros –antecedentes-, y los

resultados conseguidos en el trabajo expuesto y sus implicaciones. También se presentan

los aspectos positivos y negativos del proyecto, lo que la solución puede hacer y lo que no

puede hacer. Se discute la precisión de los resultados y sus razones, y se hacen

recomendaciones para mejorar los resultados en un trabajo posterior.

Las conclusiones deben ser claras, precisas, deben definir los problemas que

surgieron en el desarrollo del trabajo y que aún continúan.

Nótese que las conclusiones son tan importantes que aparecen en el Resumen y en

la Introducción.

Michaelson (1990, 50-56) recomienda escoger la forma de concluir dependiendo de

la clase de artículo. Para él una mala elección de la forma es un gran error. Con este fin

presenta tres formas de hacerlo: resumen, conclusión y recomendaciones.

• Resumen. Una forma normal de concluir es resumir los puntos principales

del Desarrollo temático pero suministrando más información que en el

Resumen o en la Introducción.

Se aplica bien en informes de avance, en artículos que describan las

características técnicas de un dispositivo o sistema y en artículos de tipo

tutorial.

• Conclusión. Esta forma no sólo resume sino que analiza el significado de los

resultados.

Page 110: Como Escribir Documentos Tecnicos de Ingenieria v13

Es apropiado para reportes de investigación y desarrollo; como el

resumen de un proyecto, el diseño de un dispositivo o sistema, el desarrollo

de un proceso o de un método y la revisión de desarrollos de una disciplina

de ingeniería.

• Recomendaciones. Es ideal para concluir proyectos de investigación sobre

problemas de ingeniería o en análisis de situaciones problemáticas.

Es adecuado para propuestas de proyectos de ingeniería, estudios

de problemas técnicos o el análisis de procedimientos defectuosos

En resumen, se requiere un gran esfuerzo para concretar una buena sección de

Conclusiones: imaginación, creatividad e ingeniería.

8.8 Documentación referenciada En este apartado van los documentos citados dentro del texto del artículo de

acuerdo con las normas de los editores de la revista. Para complementar esta sección vea

la sección 7.2.

8.9 Importancia de un manuscrito bien preparado Cuando se ha terminado el proyecto los ingenieros presuponen que si el trabajo es

bueno y sólido técnicamente, el manuscrito del artículo será aprobado para su publicación.

Pero un manuscrito mal preparado no será aceptado para su publicación, ni siquiera será

considerado.

Con este fin, existe una regla fundamental: antes de escribir por última vez el

original, se deben revisar detenidamente las instrucciones a los autores de la revista.

También se debe examinar un número reciente de la revista para revisar su estilo

editorial; su forma de citar la bibliografía, los títulos y subtítulos, el tamaño y ubicación del

resumen, y el diseño de cuadros y figuras.

En consecuencia, no se debe despreciar la forma. En la vida profesional tanto los

directores de las revistas como los árbitros normalmente están muy ocupados y no tienen

tiempo para ocuparse de manuscritos desordenados e incompletos: sencillamente los

rechazan (Day, 1996, 79-86).

Page 111: Como Escribir Documentos Tecnicos de Ingenieria v13

9. CÓMO ESCRIBIR UN ARTÍCULO DE REVISIÓN

9.1 Generalidades

Ante todo se debe aclarar lo que se entiende por hacer una revisión bibliográfica.

En este sentido la definición del Diccionario de la Real Academia, “examinar una cosa para

comprobar su situación, corregirla, repararla, etc.”, [RAE, 1970], es ambigua. Es más

apropiada la que da la Enciclopedia Visor: “controlar, cotejar o analizar un trabajo ya

realizado”, [VISOR, 1999], que se complementa con la definición de revisión que se

encuentra en la Epidemiología Clínica de Sackett et al.: “es el intento de sintetizar los

resultados y conclusiones de dos o más publicaciones sobre un tópico dado”, [Sackett,

1998].

Un artículo de revisión no es una publicación original y su finalidad es examinar la

bibliografía publicada y situarla en cierta perspectiva [Day, 1996]. Las publicaciones

originales –fuentes o estudios primarios- son documentos publicados como resultado de

estudios directos efectuados mediante observaciones, investigaciones o experimentos

sobre un tema. Por otra parte, el artículo de revisión es un estudio en sí mismo, que

resulta de examinar los estudios realizados por otros investigadores sobre un interrogante

dado; es una fuente o estudio secundario. Para elaborar el documento, se aprende a

buscar y recuperar información: identificar, localizar, recopilar, evaluar y asimilar las

investigaciones de otros sobre un tema de estudio. Del análisis de los documentos se

extraen conclusiones que se presentan en forma clara y persuasiva.

Sin embargo, la revisión bibliográfica debe ser selectiva, pertinente y necesaria

para el problema tratado, pues cada día se publican miles de artículos. Hoy en día se

prefieren las revisiones que muestran el estado del arte –últimos adelantos- o que brinden

una buena comprensión del tema tratado. Es normal que estos estudios abarquen los

últimos cinco años.

9.2 Tipos de revisiones

Hay artículos de revisión que se orientan a la evaluación crítica de la bibliografía y

otros que se inclinan hacia la exhaustividad bibliográfica. Aunque en ambos casos su

principal producto es la bibliografía analizada, sin embargo, los artículos realmente buenos

Page 112: Como Escribir Documentos Tecnicos de Ingenieria v13

son aquellos que ofrecen una evaluación crítica y, a menudo, llegan a conclusiones

importantes basados en esos trabajos [Day, 1996, 121-122].

Las revistas más aprestigiadas prefieren las evaluaciones eruditas y críticas, pero

existen otro tipo de revistas que se dedican sólo a la recopilación sin que esto implique

evaluar la documentación; de ahí surgen las reseñas anuales.

Así que antes de iniciar el documento hay que definir la meta que se persigue con

el mismo. También hay que sopesar bien los recursos personales, pues un artículo que se

orienta a la evaluación crítica de la bibliografía requiere mejores conocimientos

especializados sobre el tema que otro que se orienta a la recopilación bibliográfica.

Un artículo de revisión suele ser largo; entre 10 y 50 páginas. Colciencias define el

artículo de revisión como “documento resultado de una investigación terminada donde se

analizan, sistematizan e integran los resultados de investigaciones publicadas o no

publicadas, sobre un campo en ciencia o tecnología, con el fin de dar cuenta de los

avances y las tendencias de desarrollo. Se caracteriza por presentar una cuidadosa

revisión bibliográfica de por lo menos 50 referencias”.

9.3 Estructura

A diferencia de los artículos científicos, no hay una estructura establecida para los

artículos de revisión. Por consiguiente, tendrá que definirse.

Si se parte del artículo científico, IMRYD, es claro que las secciones de Métodos y

Resultados no aplican. Si se considera el artículo tipo revista – Introducción, Desarrollo y

Conclusiones- parece que su estructura se aproxima más a la requerida, ver capítulo IX.

Sin embargo, no contiene un apartado sobre la búsqueda, selección y evaluación de la

documentación primaria.

El artículo de revisión debe organizarse para que su alcance general quede bien

definido y sus partes encajen correctamente siguiendo un orden lógico [Day, 1996,122].

Teniendo en cuanta las anteriores consideraciones, la estructura de un documento de

revisión puede tener las siguientes secciones:

• Introducción; donde se establece el problema que da origen al trabajo y sus

objetivos

• Metodología; de búsqueda, recuperación y selección de los estudios

primarios

Page 113: Como Escribir Documentos Tecnicos de Ingenieria v13

• Desarrollo; donde se evalúan y discuten las diferencias de las fuentes

primarias

• Conclusiones

Estos apartados se complementan con el Resumen y las Referencias Bibliográficas.

Esta estructura es similar a la sugerida por la Revista de Postgrado de Medicina [Ramos,

2003].

Sin embargo, se debe establecer a priori el plan de trabajo, que como dice

Umberto Eco (1996, 137-146), cambiará durante el proceso pero es mejor iniciar el

camino con una ruta preestablecida a no tener ninguna. Esto aplica especialmente al

capítulo de Desarrollo, pero debe abarcar todas las secciones del artículo.

9.4 Fuentes de información

El documento de revisión se fundamenta generalmente en fuentes primarias; otras

veces se incluyen tanto fuentes primarias como secundarias; y finalmente, también se

puede basar sólo en fuentes secundarias.

Aquí se entiende que una fuente primaria es un documento publicado en una

revista científica como resultado de estudios directos efectuados mediante observaciones,

investigaciones o experimentos sobre un tema; los estudios primarios suelen incluir datos

estadísticos. Un artículo presentado en una conferencia o simposio no se considera como

fuente primaria a menos que los organizadores del evento publiquen sistemáticamente

esas memorias y que los documentos presentados incluyan datos no publicados

anteriormente [Gibaldi, 2000], [Day, 1996].

Por otra parte, se entiende como fuente secundaria el escrito resultante de

examinar los estudios realizados por otros investigadores sobre un tema dado; pueden ser

libros, artículos de revisión y artículos de opinión principalmente, pero también artículos

cortos, reportes de caso, artículos de reflexión no derivados de investigación, y reseñas de

libros. También se incluyen los artículos presentados en simposios o conferencias, y las

compilaciones, resúmenes y listados de referencias publicadas en un área del

conocimiento en particular –bases de datos- que ayudan a detectar las fuentes primarias

[Gibaldi, 2000], [Sampieri, 1998], [Colciencias Publindex, 2008].

Page 114: Como Escribir Documentos Tecnicos de Ingenieria v13

Finalmente, cuando no se sabe absolutamente nada del tema se debe recurrir a las

llamadas fuentes terciarias; lugares donde se puede obtener información para detectar a

través de ellas las fuentes primarias o secundarias de interés. Entre estas fuentes están

las instituciones nacionales e internacionales al servicio de la investigación como

bibliotecas, sociedades científicas, etc., [Sampieri, 1998].

9.5 Búsqueda de información

Una vez seleccionado el tema, a través de un profesor o por motu proprio, el

siguiente paso es determinar dónde buscar la información.

9.5.1 Biblioteca universitaria

La primera alternativa es ir a la biblioteca de la universidad para conocer los

servicios que ésta ofrece y, especialmente obtener información sobre la correcta utilización

de los recursos de información, colecciones y servicios; también se puede obtener

capacitación sobre estos temas.

Las bibliotecas universitarias ofrecen en esencia los siguientes servicios:

1) Presenciales

a) Préstamo

i) En sala

ii) Externo

iii) Interbibliotecario

iv) Entrenamiento; especialmente en búsqueda y recuperación de

información

b) Orientación; sobre las necesidades de información de los usuarios

c) Búsqueda bibliográfica; lista de referencias bibliográficas sobre el tema de

interés del usuario, a partir de las bases de datos suscritas por la biblioteca

2) Virtuales

a) Catálogo en línea; permite el acceso al texto completo de algunos libros y

revistas, enlaces a recursos bibliográficos de rigor académico y científico

disponibles en la web

b) Búsqueda, localización y entrega de documentos; ayuda al usuario para

localizar cualquier clase de artículo científico que se encuentre dentro o

Page 115: Como Escribir Documentos Tecnicos de Ingenieria v13

fuera de la universidad. La solicitud y entrega de artículos se hace

normalmente a través de la web

c) Bases de datos; las bibliotecas suscriben anualmente una serie de bases de

datos especializadas en las diferentes áreas del conocimiento, texto

completo, que son accesibles a través de internet

Entre sus servicios, algunas bibliotecas universitarias ofrecen entrenamiento sobre

búsqueda y recuperación de información para capacitar a los usuarios a ser eficientes en

el tema. Tomar un seminario-taller sobre este tema le facilitará su labor.

A manera de ejemplo, un programa típico incluye:

1) Estrategia de búsqueda y uso de los lenguajes documentales (tesauros).

2) A continuación se busca obtener el conocimiento y eficiencia en diferentes

bases de datos, que para ingeniería pueden incluir algunas como:

a) Base de datos IEEE; especializada en ingeniería eléctrica, electrónica e

informática

b) Base de datos UIT; sobre las recomendaciones y otra información

complementaria de la Unión Internacional de Telecomunicaciones

c) Base de datos Global Book in Print; contiene millones de libros en español e

inglés e incluye reseñas

d) Base de datos E-Libro; multidisciplinaria, ofrece miles títulos de libros en

formato electrónico, en inglés y español

e) Base de datos Doaj; acceso libre a revistas científicas en texto completo a

nivel mundial y en las diferentes áreas del conocimiento, que cumplen con

el requisito de control de calidad bajo estándares internacionales

3) Finalmente, también se ofrecen herramientas de gestión para referencias

bibliográficas y para la elaboración de mapas mentales

9.5.2 Internet

Es frecuente que los investigadores utilicen a internet para complementar la

información obtenida en fuentes impresas tradicionales. A través de la web, un

investigador puede obtener material a través de catálogos de bibliotecas y millones de

otros sitios útiles, como: asociaciones profesionales, agencias gubernamentales, empresas

Page 116: Como Escribir Documentos Tecnicos de Ingenieria v13

comerciales y entidades educativas. Allí se consiguen no solo fuentes de información sino

documentos en texto completo y material audiovisual.

Sin embargo, a pesar de ser un usuario familiarizado con la web, se requiere

práctica y entrenamiento para buscar información específica. Las bibliotecas universitarias

ya han hecho ese trabajo; han seleccionado cuidadosamente algunas fuentes luego de un

detenido análisis y evaluación, y, en algunos casos, han tenido que pagar la cuota de

suscripción previa exigida. Además, si se desea ampliar el espectro de búsqueda, el

personal de las bibliotecas universitarias puede ser de gran ayuda para obtener

información específica de otros sitios de la web.

Siempre que se encuentre un documento que parezca útil, se debe tener cuidado

de tomar los datos relevantes del mismo: dirección del sitio o URL –uniform resource

locator- y fecha de consulta.

Sin embargo, antes de usar o citar un documento, siempre es necesario evaluar su

calidad. Esto es difícil, especialmente cuando se están escribiendo los primeros

documentos de investigación, pues no todas las fuentes son confiables o no tienen la

calidad necesaria. No se debe asumir que lo aparece en internet es verdadero o confiable.

Se puede encontrar información desactualizada, incorrecta o de poca profundidad

científica o técnica. En consecuencia, se debe sopesar lo que se lee según los

conocimientos e inteligencia propios; también es útil comparar la información contra otras

fuentes.

La evaluación de las fuentes de internet no es fácil. Mientras la información que se

encuentra en revistas o libros académicos está soportada por la calidad y tradición de los

editores, y por su sistema de revisiones por pares y consejos editoriales, no ocurre lo

mismo en la mayoría de las fuentes encontradas en internet. Mucha de la información que

se encuentra en internet no es revisada por pares o consejos editoriales que la garanticen

[Gibaldi, 1996, 20-26].

9.6 Consideraciones para revisar la literatura

Entre las consideraciones para garantizar que la búsqueda y recuperación de

información sean apropiadas y eficientes, Sampieri sugiere tener en cuenta las siguientes:

1) Consultar una base de datos durante los últimos cinco años

Page 117: Como Escribir Documentos Tecnicos de Ingenieria v13

2) Consultar como mínimo cuatro revistas científicas durante los últimos cinco

años

3) Buscar en foros, revistas electrónicas, bibliotecas virtuales y bases de datos de

internet

4) Averiguar quiénes son los autores más importantes en el campo de estudio

5) Averiguar si hay artículos de revisión anteriores sobre el tema de estudio

6) Consultar una tesis o disertación sobre el tema

7) Buscar libros actualizados como mínimo en dos bibliotecas

8) Consultar con más de una persona experta en el tema

9.7 Proceso de elaboración

El método de búsqueda debe permitir hallar los artículos más importantes del tema

objeto de estudio. Cuanto más exhaustivo sea el método utilizado mayor será la

probabilidad de localizar la información relevante. Con este fin, se debería:

1) Hacer una investigación de las publicaciones más relevantes sobre el tema

2) Utilizar bases de datos bibliográficas que contengan publicaciones sobre el

tema

3) Seleccionar las palabras clave a utilizar, su forma de uso y registrar los

resultados obtenidos

4) Confrontar los resultados con investigadores que conozcan el tema para

asegurarse que no se haya omitido información importante

5) Especificar la forma como se seleccionarán los artículos que se incluirán en la

revisión: temas específicos, procedimientos particulares, pruebas, resultados y

otros factores relevantes

6) Analizar los documentos seleccionados; ver capítulo VII

7) Combinar apropiadamente los resultados de los artículos primarios analizados

para obtener conclusiones fundamentales

8) Detallar los resultados significativos de los estudios primarios para sustentar las

conclusiones con base en los datos

Page 118: Como Escribir Documentos Tecnicos de Ingenieria v13

9.8 Redacción

La redacción de un artículo de revisión debe tener en cuenta algunos aspectos

importantes. En primer lugar, el documento abarcará probablemente cierto número de

temas especializados, por lo que interesará a muchos investigadores relacionados con el

área y a otros de campos conexos que desean mantenerse al día. Como el público será

amplio y diverso, el estilo debe ser más general que el que se usa en un artículo de

investigación, evitando usar terminología y abreviaturas especializadas. El estilo deberá ser

más dilatado que telegráfico.

En segundo lugar, hay que tener en cuenta que el público de los artículos de

revisión es muy sensible a la introducción, si es que llegan a ella. Por lo tanto, esos

párrafos son muy importantes.

Los lectores también se dejan influenciar por el primer párrafo de cada sección

principal de la revisión, y deciden leer, examinar superficialmente o saltarse el resto de la

sección según lo que encuentren en él. Es, pues, necesario redactar muy bien esos

párrafos para capturar a la audiencia.

Por otra parte, un artículo de revisión no debe terminar en punta; debe haber

conclusiones que dejen satisfechos a los lectores. Éstas deben ser bien meditadas y mejor

escritas [Day, 1994, 124-125].

Finalmente, lo dicho en los capítulos VI, VII y IX puede ser de ayuda.

Page 119: Como Escribir Documentos Tecnicos de Ingenieria v13

10. CÓMO ELABORAR CARTELES

Los carteles o posters son una alternativa para presentar un proyecto en una

conferencia; su contenido se elabora en forma sucinta.

Desde hace más de dos décadas los carteles han tomado importancia en las

conferencias concurridas donde se tiene limitación de espacio –salas- y de tiempo.

También porque la simultaneidad de conferencias hace difícil que los asistentes puedan

mantenerse al corriente de los trabajos presentados en otras salas. En estos casos los

ingenieros o investigadores fijan sus trabajos sobre atriles o los cuelgan de paneles para

exhibirlos.

En la actualidad las exhibiciones de carteles se han tornado importantes en muchas

reuniones, no sólo por los problemas indicados anteriormente sino porque éstos han

mostrado ser más eficaces, en algunos casos, para presentar los resultados de un

proyecto en comparación con el corto tiempo que se asigna para una exposición oral.

10.1 Tamaño

En la medida que una sesión de carteles puede ser muy concurrida, se hace

necesario instituir las reglas a que deben atenerse los participantes. En este caso los

organizadores del congreso establecen los requisitos a cumplir; entre los parámetros a

especificar estarán la altura y anchura del cartel según que se vayan a emplear atriles,

que se vayan a colgar de paneles de soporte, o que se vayan a colgar sobre las paredes;

también se indicarán los métodos a utilizar para fijar los posters a los soportes. Es posible

que también se especifique el tamaño mínimo de los caracteres y la cantidad de palabras

por apartado del cartel.

Por tanto, cuando se va a participar en una sesión de carteles, la preparación final

del poster se afinará cuando se conozcan los requisitos establecidos por los organizadores.

Page 120: Como Escribir Documentos Tecnicos de Ingenieria v13

10.2 Estructura

La estructura de un cartel sigue normalmente la organización del artículo científico,

IMRYD (Introducción, Métodos, Resultados y Discusión). Ver capítulo IX.

Esa estructura también responde a las necesidades de un proyecto de ingeniería,

pues contesta cuatro preguntas básicas:

• ¿Cuál era el problema?

• ¿Cómo se resolvió?

• ¿Qué resultados se lograron?

• ¿Cuáles son las conclusiones más relevantes del trabajo?

Pero hay que hacer hincapié en que el contenido del poster se caracteriza ante

todo por su sencillez y por la selección de gráficas que enfaticen el mensaje. Como dice

Day (1990, 145): “En un cartel bien diseñado hay muy poco texto, y la mayor parte del

espacio se destina a las ilustraciones”.

Es costumbre que a las cuatro secciones anteriormente mencionadas se le agregue

el objetivo fundamental del proyecto.

En consecuencia el cartel contiene las siguientes secciones:

• Introducción, que presenta el problema de manera sucinta

• Objetivo, norte del trabajo, elaborado en menos de tres renglones

• Metodología (desarrollo temático), expuesto de manera concisa. Este

espacio debería contener ilustraciones que traten de exponer la forma como

se resolvió el problema

• Resultados, apartado que es normalmente corto en el artículo científico,

pero que aquí dispone del mayor espacio. Este apartado también debería

contener ilustraciones

• Conclusiones, expuestas en forma de frases breves, normalmente marcadas

con viñetas

• Bibliografía, reducida a su mínima expresión. También se utilizan viñetas

Page 121: Como Escribir Documentos Tecnicos de Ingenieria v13

10.3 Preparación

La preparación del poster debe tener una meta que está muy bien descrita por Day

(1996, 146): “Un cartel debe explicarse por sí solo, permitiendo a los que lo contemplen

avanzar a su propio paso. Si su autor tiene que dedicar la mayor parte del tiempo a

explicarlo en lugar de a responder preguntas científicas, el cartel habrá fracasado en gran

parte”.

Con este fin, es una buena práctica el no atiborrar el cartel con muchos elementos;

debe haber mucho espacio en blanco para que los que pasen frente a él puedan distinguir

si les interesa algo y detenerse a preguntar por los detalles. Por el contrario, un cartel

atiborrado de información, con caracteres pequeños, no será leído.

También, la distribución de cada uno de sus componentes, dentro del espacio de

trabajo, es muy importante para que resalten al primer golpe de vista. Así, aunque existen

varias formas de hacer esa distribución, en la figura 10.1 se presenta una que es muy

aconsejable porque, además, dedica un espacio proporcional a cada apartado, según su

relevancia.

Los caracteres del texto deberán tener una altura apropiada, por ejemplo, un tipo

de cuerpo 24. Sin embargo, en las Referencias se utiliza un tipo de letra menor, pues no

es necesario que su contenido se pueda leer a la misma distancia que los otros apartados.

Page 122: Como Escribir Documentos Tecnicos de Ingenieria v13

ApellidoAutor1, NombreAutor1; ApellidoAutor2, NombreAutor2. DirecciónCorreoAutor1; DirecciónCorreoAutor2

Facultad, Universidad El Bosque, Bogotá, Colombia

Título del proyecto; debe ser corto pero atrayente

Introducción

Objetivo Resultados

Metodología

Conclusiones

Referencias

Fig. 10.1 Distribución de los contenidos de un cartel

Page 123: Como Escribir Documentos Tecnicos de Ingenieria v13

Esa forma de presentar el poster facilita su lectura de izquierda a derecha. Así que,

por ejemplo, se puede leer primero la Introducción, luego el Objetivo, los Resultados, las

Conclusiones y, finalmente, la Metodología.

La sección con más espacio es la de Resultados. Los otros apartados comparten el

resto del espacio.

Para realizar las Conclusiones y la Bibliografía se utilizan viñetas para resaltar cada

uno de sus componentes. También es una buena práctica que, dentro de un mismo

apartado, se utilicen diferentes colores de fondo entre sus componentes para resaltarlos.

En un poster se debe evitar que un apartado se parta entre las dos columnas, es

decir, que empiece en una y termine en la otra. Además, las ilustraciones –tablas, figuras,

procesos metodológicos- se titulan pero no se numeran, porque no es necesario.

En la elaboración de los contenidos el ingeniero despliega sus capacidades de

síntesis para decir en pocas palabras lo esencial del proyecto. Además, muestra su vena

artística para elaborar ilustraciones en los apartados de Metodología y Resultados de tal

forma que impacten a los asistentes y los inciten a preguntar por los detalles del proyecto.

El cartel, a diferencia de una presentación oral, se presta para comunicar bien

varios aspectos del trabajo a los espectadores para enterarlos de qué se trata y, si están

interesados, informarles los detalles.

Debe destacarse que lo más atractivo de los carteles es la variedad de ilustraciones

que pueden utilizarse; su limitante es la capacidad artística del autor.

10.3.1 Título

Es el primer apartado del cartel. Es la etiqueta mediante la cual se trata de vender

el proyecto; debe ser suficientemente llamativo, claro y breve. Cada una de sus palabras

debe ser elegida con mucho cuidado. Debe ser legible a una distancia de 1.5 metros y

utilizar caracteres gruesos y negros de unos 3 cm de altura. Los nombres de los autores

deben ser más pequeños.

10.3.2 Introducción

Se ha resaltado utilizando todo el ancho del cartel. Presenta el problema que

origina el proyecto en forma sucinta. No debe ser mayor a cinco reglones.

Page 124: Como Escribir Documentos Tecnicos de Ingenieria v13

10.3.3 Objetivo

Muestra en forma concreta, no más de tres reglones, el norte del proyecto. Las

siguientes secciones dan respuesta al objetivo.

10.3.4 Metodología

Muestra en forma gráfica el proceso metodológico utilizado para resolver el

problema. Cada una de las actividades del proceso debe tener entregables.

10.3.5 Resultados

Se les ha destinado el espacio más grande. Cada una de las actividades de la

Metodología da lugar a resultados concretos que deben exponerse en este apartado en

tablas, gráficas, ecuaciones, en lo posible.

10.3.6 Conclusiones

Los Resultados dan lugar a las conclusiones, que se exponen en frases cortas

demarcadas por viñetas. No pueden existir Conclusiones que no surjan de los Resultados.

10.3.7 Referencias bibliográficas

Se exponen solo las tres o cuatro referencias más importantes. Cada una de ellas

debe tener toda la información pertinente para que el lector interesado pueda encontrarla.

Ver capítulo quinto.

Page 125: Como Escribir Documentos Tecnicos de Ingenieria v13

11. CÓMO ESCRIBIR UN ENSAYO

En este apartado se trata de hacer claridad sobre el tema. Con este fin, primero se

hacen unas aclaraciones sobre los escritos de investigación y de ingeniería. Luego se

presentan varias definiciones generales del ensayo, se sigue con su estructura básica, se

exponen sus aspectos formales, y, finalmente, los pasos a seguir para elaborarlo.

11.1 Escritos de investigación

Como lo menciona Gibaldi (2000, pp. 2-3), se hace investigación cuando se desea

explorar una idea, probar algo, resolver un problema, o buscar soporte externo para

apoyar las ideas propias. Entonces se busca, se investiga y se utilizan materiales ajenos a

nuestros recursos. Lo que se halla y se concluye, en respuesta a la pregunta, es lo que se

expone en un documento de investigación.

El documento de investigación se basa en fuentes primarias, secundarias o en una

combinación de ambas. Aquí se entiende que una fuente primaria es un documento

publicado como resultado de estudios directos efectuados mediante observaciones,

investigaciones o experimentos sobre un tema; por ejemplo, los resultados de un

experimento de laboratorio. Por otra parte, se entiende como fuente secundaria el escrito

resultante de examinar los estudios realizados por otros investigadores sobre un tema

dado; pueden ser libros, artículos de revisión o artículos de opinión.

La mayor parte de los escritos académicos se basan en fuentes secundarias. El uso

de información, ideas y opiniones de otros investigadores juega un papel principal en la

formación de los estudiantes. Así, para elaborar un documento, el estudiante aprende a

buscar y recuperar información: identifica, localiza, evalúa y asimila las investigaciones de

otros sobre un tema de estudio. Después desarrolla y expresa sus ideas propias,

presentadas en forma clara y persuasiva.

Empero también, durante su actividad profesional, continuará elaborando reportes

y propuestas con base en fuentes secundarias.

Page 126: Como Escribir Documentos Tecnicos de Ingenieria v13

La investigación le aumentará el conocimiento y la comprensión de un tópico.

Algunas veces le ratificará sus ideas y opiniones; otras veces las cambiará y modificará,

pero siempre le ayudará a modelar su forma de pensar. La revisión de las fuentes de

información le ayudará a conocer los diferentes puntos de vista sobre un asunto, a ampliar

o adecuar sus ideas, a conocer nuevos métodos, modelos o tecnologías, pero siempre

teniendo en cuenta que el objetivo fundamental de la investigación no es resumir el

pensamiento o los trabajos de otros sino asimilarlos, apropiarse de ellos.

11.2 Escritos de ingeniería

Un ingeniero realiza trabajos relacionados con el desarrollo de una nueva teoría o

el desarrollo de soluciones a problemas concretos de ingeniería que terminen en

dispositivos, materiales, sistemas o procesos. También hace trabajos relacionados con

aplicaciones prácticas de conocimientos existentes, desarrollo de nuevos métodos,

establecimiento de estándares, control de calidad de procesos de manufactura,

confiabilidad de los sistemas, control de elementos y materiales adquiridos, entre otros.

Asimismo, elabora papers, documentos de grado, tesis, informes, reportes y propuestas.

Sin embargo, esos trabajos de ingeniería difícilmente pueden dar lugar a un ensayo.

A pesar de esto, es costumbre que los profesores le soliciten a los estudiantes

hacer ensayos. Pero dado que este concepto es un poco ambiguo para los estudiantes de

ingeniería, éstos no comprenden qué es lo que se les pide exactamente. Para ayudarlos,

en este capítulo, se les dará a conocer la estructura y elaboración de un ensayo; este

conocimiento puede ayudarlos a modelar su pensamiento.

11.3 Definiciones

El Diccionario de la Real Academia Española (RAE, 1970) define el ensayo como

“escrito, generalmente breve, sin el aparato ni la extensión que requiere un tratado

completo sobre la misma materia”. En su versión digital actual (2006), lo define como

“escrito en el cual un autor desarrolla sus ideas sin necesidad de mostrar el aparato

erudito”. Definiciones muy similares pero ambiguas.

Existe una gran cantidad de definiciones o aproximaciones a lo que es el ensayo,

ver, por ejemplo, el documento de Gómez-Martínez (1992). Dentro de ellas llama la

atención la de José Ortega y Gasset: “El ensayo es la ciencia, menos la prueba explicita”.

Page 127: Como Escribir Documentos Tecnicos de Ingenieria v13

Si se quiere conocer el origen del género y su definición primigenia, nos tenemos

que remontar a la obra de Montaigne (2007, pp 436-437), quien en el ensayo número 50

del libro primero, que tituló De Demócrito y Heráclito, presentó su definición:

El juicio es instrumento para todos los temas y en todo se mete. Por este

motivo, en estos ensayos que estoy haciendo, úsolo en toda suerte de

circunstancia. Si es tema del que nada entiendo, aún así lo trato, midiendo

el vado desde muy lejos; y después, hallándolo demasiado profundo para

mi talla, quédome en la orilla; y este reconocer la imposibilidad de

atravesarlo, es una muestra de su efectividad, y una incluso, de las que

más se jacta. Ya, en tema vano y vacío, intento ver si hallará con qué darle

cuerpo y con qué sostenerlo y apuntarlo. Ya, lo paseo por un tema noble y

manido en el que nada ha de encontrar de su propia cosecha, al estar el

camino tan pisado que no puede andar más que tras las huellas de otros.

Entonces, su papel es elegir la ruta que mejor le parezca, y, de mil

senderos, dice que éste o aquél fue el mejor escogido. Tomo al azar el

primer tema que se me presenta. Todos me son igualmente buenos. Y

jamás pretendo tratarlos por entero. Pues de nada puedo ver el todo.

Aquéllos que prometen mostrárnoslo, no lo hacen. De cien partes o rostros

que cada cosa tiene, tomo uno de ellos, ya sólo para lamerlo, ya para

rozarlo, ya para pellizcarlo hasta el hueso. Penetro en él, no con amplitud

sino con la mayor profundidad que puedo. Y a menudo gusto de cogerlo

desde algún punto de vista inusitado. Me atrevería a tratar a fondo alguna

materia, si me conociera menos. Sembrando una frase aquí, otra allá,

muestras desgajadas de su conjunto, separadas sin designio ni promesa, no

creo que haga nada bueno, ni que me mantenga yo mismo sin variar

cuando me plazca y sin rendirme a la duda o a la incertidumbre o a mi

estado natural que es la ignorancia.

El ensayo, abarca, pues todos los temas.

Page 128: Como Escribir Documentos Tecnicos de Ingenieria v13

Por otra parte, en las ciencias, el objetivo de la investigación es el avance del

conocimiento. En este sentido las publicaciones científicas juegan un papel fundamental,

pues son el medio básico que hace posible que fluya el conocimiento, ya que éstas son el

insumo natural de todo grupo de investigación para, a su vez, generar nuevo

conocimiento. En consecuencia, los nuevos conocimientos se fundamentan en el trabajo

anterior. Por consiguiente, puede decirse que toda investigación termina en un artículo

científico. En consecuencia, el artículo científico no es un ensayo. Imitando lo que decía

Ortega y Gasset, se puede decir que el artículo científico es la ciencia, con la prueba

explícita.

Ahora bien, ¿qué se puede esperar de un trabajo realizado a nivel de pregrado o

aún de maestría? Difícilmente, estos trabajos pueden generar un avance del conocimiento.

Quizás, imitando de nuevo a Ortega y Gasset, se pueda decir entonces que el escrito de

ingeniería muestra la ciencia, sin la prueba explícita.

Pero ese mostrar la ciencia implica unos mínimos como: conocimiento del tema,

documentación del tema y organización de los argumentos.

Por lo tanto, en un escrito (¿ensayo?) a nivel de pregrado en ingeniería está en

juego la opinión sustentada y razonable del estudiante sobre un tema específico. El

estudiante no sólo debe presentar su punto de vista sobre el tópico, sino que se debe

esmerar en exponer sus argumentos para llegar a una conclusión que convenza al

profesor, destinatario del escrito/ensayo. Pero debe hacerlo siguiendo una estructura.

Sin embargo, al darle estructura al escrito/ensayo ya se lo está limitando, pues, por

su misma definición el ensayo no tiene ninguna estructura definida. No obstante, en el

ámbito universitario cuando se habla de ensayo se conmina a los estudiantes a utilizar la

siguiente estructura, que si se mira bien, es la misma estructura que se utiliza para el

artículo de una revista.

11.4 Estructura

La estructura del ensayo es muy simple: introducción, desarrollo y conclusión.

11.4.1 Introducción

En la sección 3.4 se definió lo que se espera de este apartado, que se puede

concretar en lo que dice Day (2003): el problema, la revisión bibliográfica y la solución

Page 129: Como Escribir Documentos Tecnicos de Ingenieria v13

“deben presentarse de forma que el lector comprenda cuál era el problema y cómo se

trató de resolverlo”.

A continuación se deben mencionar los principales resultados obtenidos y, en

último lugar, presentar la conclusión o conclusiones principales, a partir de los resultados.

11.4.2 Desarrollo

Aquí se presentan las diferentes posiciones o alternativas de tratamiento del

problema. Éstas se confrontan, mediante argumentos bien desarrollados e hilados, para

demostrar la tesis propuesta. Es la parte principal del ensayo.

11.4.3 Conclusión

Aquí se espera que la tesis propuesta en la introducción sea profundizada a la luz

de los argumentos expuestos en el desarrollo. Se debe evitar hacer afirmaciones y

conclusiones que no estén fundamentadas en el desarrollo.

11.5 Aspectos formales

11.5.1 Persona gramatical

Los ingenieros escriben normalmente en tercera persona. Sin embargo, en un

ensayo está comprometido el autor hasta los tuétanos, y, por lo tanto, debe defender su

opinión en primera persona. Como decía el señor de Montaigne (2007, p 1202), en el

capítulo 2 del tercer libro, El arrepentirse: “Los autores se presentan al pueblo por algún

signo especial y externo; yo, el primero, por mi ser general, como Michel de Montaigne,

no como gramático, poeta o jurista”.

11.5.2 Formato

En principio se debe continuar utilizando el formato propuesto en la plantilla guía

para avances de los trabajos –plantilla borrador-, sección 5. El uso de un espacio y medio,

márgenes amplios, en todas las partes, incluyendo la página de presentación, facilita la

corrección del ensayo.

El estilo utilizado generalmente para las referencias es muy amplio. Va desde las

menciones breves al autor referido, porque se considera que esa fuente hace parte del

acervo cultural de los lectores, en cuyo caso no se incluye la información bibliográfica.

Pero si, por el contrario, se considera que la fuente no es conocida por los lectores,

Page 130: Como Escribir Documentos Tecnicos de Ingenieria v13

entonces se sugiere insertar una nota de pie de página con toda la información

bibliográfica. En este caso, se prescinde de una bibliografía formal como anexo al ensayo.

Sin embargo, hay varias acotaciones al respecto:

a. El uso general del pie de página es para ampliar la información de un

término, una sigla, un autor, su obra, etc., uso propuesto por Eco (1996, pp

201-206). No es común utilizarlo como referencia bibliográfica por la

duplicidad que puede acarrear.

b. Si se usa el pie de página, es preferible que las notas aparezcan al final del

texto como referencias. Muchas citas al pie de cada página, pueden dar la

impresión de esnobismo erudito.

c. Es preferible utilizar referencias bibliográficas completas que indiquen el

número del documento en la bibliografía y la página o páginas concretas

donde se halla la cita [Doc, pag(s)]. Así, si el lector quiere confrontar la cita

o ampliar su contexto, sabe dónde ir directamente. Es un asunto de

amabilidad con el lector.

También, se puede utilizar el formato autor, año, pero agregándole la

página donde está la referencia.

11.5.3 Portada

Debe llevar la siguiente información:

a. Título del artículo. Debe ser corto: ojalá que no supere 15 palabras. En el

título se debe incluir toda la información que haga posible la localización

electrónica del artículo.

b. Nombre de los autores.

c. Facultad de ingeniería a que pertenecen los autores.

d. Asignatura dentro de la que se hace el ensayo.

e. Fecha.

11.5.4 Resumen y palabras clave

Después de la portada viene el resumen. (Ver sección 3.1).

Page 131: Como Escribir Documentos Tecnicos de Ingenieria v13

11.5.5 Introducción

A continuación viene la introducción que normalmente no supera el 10% de todo el

ensayo. (Ver sección 3.4).

11.5.6 Desarrollo

Posteriormente viene el desarrollo, cuerpo básico del ensayo, que cubre

aproximadamente el 80% del mismo.

11.5.7 Conclusiones

Finalmente, vienen las conclusiones, que cubren aproximadamente el otro 10%.

(Ver sección 3.24).

11.5.8 Referencias

Y, para acabar, vienen las referencias. Siempre que sea posible, se debe

proporcionar la fuente original del trabajo citado. Se debe evitar hacer citas a trabajos de

resúmenes. (Ver sección 3.23 y capítulo 7).

11.5.9 Extensión

La extensión del ensayo es muy ambigua. La mayoría de los autores que tratan del

tema dicen que su extensión no debe ser mayor a lo que se abarca en una sentada. Pero

¿qué es una sentada? Esto depende de que tan buen lector se sea; habrá lectores que no

pueden abarcar más de dos o tres páginas de una sentada. Otros, más duchos, podrán

leer 20 o más páginas. Y, en casos extremos, si el libro captura el interés del lector, éste

podrá leerlo todo de una tirada.

Por lo tanto, se acostumbra que el profesor fije la longitud del ensayo asignándole

un número mínimo de palabras. Un ensayo exigente solicita un mínimo de 1500 palabras,

por ejemplo.

11.6 Pasos a seguir para escribir el ensayo

11.6.1 Conocimiento del tema

Toda opinión argumentada es siempre una opinión sobre algo. Si no se tiene

conocimiento del tema no se pueden dar opiniones al respecto. Como dice el documento

de la Escuela de Ciencias Humanas de la Universidad del Rosario, 2002: “Así, también las

Page 132: Como Escribir Documentos Tecnicos de Ingenieria v13

opiniones difieren: frente a un hecho, la opinión consiste en explicarlo; frente a un

problema la opinión consiste en valorarlo; frente a una encrucijada la opinión consiste en

valorar la mejor vía de acción. Por lo tanto, antes que nada hay que conocer la naturaleza

del tema”.

El profesor puede proponer el tema a trabajar o puede sugerir que el estudiante

proponga el tema a partir de una serie de lecturas o trabajos realizados previamente.

11.6.2 Documentación

Sustentar una opinión argumentada requiere recopilar información seria. En

consecuencia, se debe acudir a las fuentes al alcance en la Biblioteca de la Universidad.

Allí, se encontrarán bases de datos, revistas, libros y trabajos de grado sobre los cuales se

puede fundamentar el ensayo.

Para documentarse, el estudiante debe explorar el concepto central y tratar de

entender los alcances del mismo. Es necesario leer y pensar. El uso de fichas de lectura,

temáticas, bibliográficas, etc., es de gran ayuda para organizar la información y las ideas.

Así, cuando comience a escribir todo será más fácil. Con este fin, los estudiantes deberían

leer el libro de Eco (1996, pp 69 – 176).

11.6.3 Búsqueda de argumentos

Después de explorar el concepto central, se tiene una gran cantidad de material

que es necesario organizar. Se trata de ordenarlo por argumentos a favor y en contra de

la tesis –ventajas y desventajas-. También, debe crearse un índice que le dé estructura al

ensayo.

Por otra parte, una buena cantidad de los ensayos son debates entre alternativas;

así, el capítulo de diseño global, (ver sección 3.15), del trabajo de grado podría

considerarse un debate. Para el desarrollo del ensayo es necesario argumentar a favor y

en contra de esas alternativas. De ser posible, se debe tratar de dar ejemplos para llegar a

pequeñas conclusiones.

11.7 Documentación complementaria

Existen otra serie de documentos que merecen la pena de tener a la mano para

complementar la información sobre el ensayo. Entre ellas, merece destacarse el libro del

profesor Fernando Vásquez Rodríguez, (Vásquez Rodríguez, 2005) especialmente en

Page 133: Como Escribir Documentos Tecnicos de Ingenieria v13

cuanto se refiere a los conectores, punto álgido para muchos escritores noveles, pues

suministra más de 1500 conectores agrupados según su necesidad de uso, páginas 81-

210.

1. Vásquez Rodríguez, Fernando. Pregúntele al ensayista. Editorial Kimpres, Bogotá,

mayo 2005, primera reimpresión.

2. Uniform Requirements for Manuscripts Submitted to Biomedical Journals: Writing

and Editing for Biomedical Publication, February 2006

3. Ieanet. Cómo escribir artículos científicos. www.ieanet.com/profesional/escribir.htm

4. Elsevier. Preparation of IFAC meeting papers.

http://www1.elsevier.com/homepage/saf/ifac/site/IPV%20overview.htm

5. Ensayo. Wikipedia

6. Ensayo.

http://www.memo.com.co/fenonino/aprenda/castellano/castellano6.html#ensayo

7. Para redactar un ensayo. www.educarchile.cl

8. Formato de ensayo. www.educarchile.cl

9. IEEE. Autor Guidelines for 8.5x11-inch Proceedings Manuscripts

Page 134: Como Escribir Documentos Tecnicos de Ingenieria v13

12. CÓMO ELABORAR INFORMES DE AVANCE

Page 135: Como Escribir Documentos Tecnicos de Ingenieria v13

13. CÓMO ELABORAR FIGURAS Y TABLAS

No siempre los datos deben presentarse en tablas o figuras. Algunos tipos de datos

no merecen representarse, especialmente los escasos o los reiterativos. En esos casos es

mejor hacer las referencias dentro del texto.

Por otra parte, hay resultados de proyectos que pueden presentarse tanto en

cuadros como en figuras. Una buena regla para decidir cuál es la más apropiada dice: “Si

los datos muestran tendencias pronunciadas que componen una imagen interesante,

utilice una gráfica. Si los números solo cuentan por sí mismos y no revelan ninguna

tendencia interesante, un cuadro debería ser satisfactorio”, [Day, 1996, 67].

Es primordial que las gráficas y las tablas que soportan el texto estén diseñadas

con este propósito específico; no para llenar espacio. El uso de tablas y gráficas puede

ayudar a clarificar y resaltar la información.

Hay gráficas útiles y otras inconvenientes. Son muy útiles las gráficas que ayudan a

mostrar las relaciones entre las partes de un sistema o que muestran la apariencia externa

del mismo. Pero si su documento sobre un dispositivo electrónico de comunicaciones trata

de mostrar sus características de operación, una fotografía del acabado externo del mismo

no beneficiará las explicaciones del texto sobre las funciones del aparato. Hay que evitar el

uso de gráficas genéricas que no fortalezcan al texto pues, por el contrario, lo debilitan.

Así que, es esencial la selección de figuras apropiadas que ayuden a aclarar el texto.

Michaelson (1990, 45) propone seleccionar gráficas que apoyen uno de los

siguientes propósitos:

• Que describan una función

• Que muestren la apariencia externa

• Que muestren la estructura interna

• Que ilustren un fenómeno

• Que demuestren las relaciones

• Que sean novedosas y originales

Page 136: Como Escribir Documentos Tecnicos de Ingenieria v13

Sin embargo, debe tenerse en cuenta que en la mayoría de los documentos sólo

tienen cabida pocas gráficas o tablas.

Es un error muy frecuente el no tener en cuenta el tamaño de las letras y símbolos

que aparecen en las gráficas del documento final. Éstos deben ser claros y legibles sin

necesidad de utilizar lupa.

13.1 Tablas

13.2 Figuras

Bajo este concepto se incluyen gráficos (charts), dibujos (drawings), diagramas,

fotografías y mapas.

La planeación del documento incluye la selección apropiada de figuras que lo

fortalezcan. Una forma eficiente de atraer a los lectores es utilizar figuras que resalten el

contenido del manuscrito; pero hay que escoger la más efectiva para cada caso.

Entre las ilustraciones más utilizadas están [Michaelson, 1990, 71]:

• Gráficos de curvas, que muestran las relaciones entre variables, tendencias

y cambios relativos.

• Gráficos de barras, que exponen comparaciones de cifras a intervalos

regulares.

• Gráficos de tortas, que revelan la proporción de cada una de las partes de

un objeto.

• Diagramas de flujo, que ponen de manifiesto los pasos de un proceso.

• Dibujos, que muestran los detalles de objetos físicos desde varios puntos de

vista.

Page 137: Como Escribir Documentos Tecnicos de Ingenieria v13

• Diagramas de componentes, que muestran los módulos de un sistema, sus

diagramas de símbolos, sus diagramas eléctricos, y sus diagramas de

conexión.

• Fotografías, que muestran objetos reales en perspectiva.

En un proyecto de desarrollo, por ejemplo, se pueden utilizar diferentes tipos de

ilustraciones según la etapa del proyecto que se quiera resaltar. Así, cuando se definen los

objetivos, es importante mostrar el proceso a seguir para desarrollar el proyecto,

incluyendo actividades principales que conlleven a resultados concretos. Ver figura 13.1.

Incluir una figura que presente la metodología.

Fig. 13.1 Metodología de desarrollo

En la fase de diseño, se puede incluir un diagrama de bloques que muestre las

funciones de los diferentes módulos y sus relaciones. Ver figura 13.2.

Incluir una figura que presente la estructura de bloques.

Fig. 13.2 Estructura modular

En el diseño detallado se pueden incluir diagramas de componentes lógicos

(hardware) y diagramas de flujo (software). Ver figuras 13.3 y 13.4.

Incluir una figura que presente un diagrama de componentes lógicos.

Fig. 13.3 Diagrama lógico

Page 138: Como Escribir Documentos Tecnicos de Ingenieria v13

Incluir una figura que presente un diagrama de flujo.

Fig. 13.4 Diagrama de flujo

En la etapa de implementación se pueden incluir diagramas eléctricos, diagramas

de conexión y diagramas de circuitos impresos. Ver figuras 13.5, 13.6 y 13.7.

Incluir una figura que presente un diagrama eléctrico.

Fig. 13.5 Diagrama eléctrico

Incluir una figura que presente un diagrama de cableado.

Fig. 13.6 Diagrama de cableado

Incluir una figura que presente un circuito impreso.

Fig. 13.7 Circuito impreso

Si se quiere destacar el dispositivo final, se puede incluir una fotografía del mismo.

Page 139: Como Escribir Documentos Tecnicos de Ingenieria v13

14. CÓMO ESCRIBIR EL TRABAJO DE GRADO

El trabajo de grado se puede concebir como el primer documento formal de tipo

científico/tecnológico a que se enfrenta un estudiante de pregrado. Por tanto, es necesario

que tenga bien claro cómo hacerlo.

La primera cartilla (Téllez Barón Fabio et al., 2004) se centró ante todo en los

procedimientos, los documentos y las instancias que deben tener en cuenta los

estudiantes para llevar a buen término su trabajo de grado. Sin embargo, después de diez

años de estar asesorando a los estudiantes de ingeniería electrónica de la Universidad El

Bosque en la elaboración de sus proyectos y otros documentos, se hizo evidente la

necesidad de escribir un manuscrito que les sirviera de apoyo en el momento de

construirlos.

Esta guía muestra la estructura del manuscrito y los contenidos esperados en cada

uno de sus apartados.

Para una mejor claridad, el tema de este capítulo se ha dividido en dos grandes

partes. La primera trata de las consideraciones generales de cada una de las secciones

que componen el trabajo de grado; éstas se exponen a continuación. En la segunda se

han elaborado algunos ejemplos reales que pueden ayudar a clarificar los conceptos

generales tratados en la primera parte. Los ejemplos están en el anexo A.

Un trabajo de grado típico, que termine en un dispositivo, equipo o sistema –a

continuación se hablará siempre de sistema, en forma genérica-, contiene las secciones

mencionadas a continuación:

1. Resumen/Abstract

2. Tabla de contenido

3. Título del trabajo de grado

4. Introducción

5. Problema

Page 140: Como Escribir Documentos Tecnicos de Ingenieria v13

6. Estado del arte

7. Glosario de términos

8. Justificación

9. Objetivos

10. Requerimientos

11. Diseño global

12. Diseño detallado

13. Implementación

14. Pruebas

15. Manuales

16. Resultados

17. Discusión

18. Conclusiones

19. Referencias documentales

20. Anexos

Sin embargo, las secciones indicadas corresponden a un trabajo típico que termina

en un equipo, pero no todos los proyectos terminan en un sistema concreto. En este

sentido, los proyectos se pueden clasificar en tres grupos: el primero, que termina en un

sistema; el segundo grupo, sobre estudios de preingeniería; y el tercero, relacionado con

trabajos teóricos.

Para cada uno de estos casos, la estructura del documento varía, como se indica a

continuación:

a) Un trabajo que termine en un sistema contiene cada uno de los 20 capítulos

mencionados arriba.

b) Un proyecto que termine en un estudio de preingeniería contiene las secciones

iniciales, hasta el diseño global. Los apartados de diseño detallado,

implementación, pruebas y manuales no aplican; en su lugar, a partir del

diseño global, se hacen las especificaciones o requerimientos del sistema que

se implantaría en caso de que el estudio se lleve a cabo. Con esa información

se hace un estudio de costos, y, finalmente, se calcula la viabilidad del mismo.

Page 141: Como Escribir Documentos Tecnicos de Ingenieria v13

c) Un estudio teórico también contiene las secciones iniciales hasta el diseño

global. Los capítulos de ejecución se reemplazan según se esboza en el capítulo

de requerimientos donde se plantea cuántos son, cómo se titulan y qué

contenido tienen.

Una forma rápida de saber cuántas secciones puede contener la fase de

ejecución de un estudio teórico es hacer una relación unívoca entre aquellas y

cada uno de los objetivos específicos del proyecto.

De igual forma se describen algunos capítulos que hacen parte del anteproyecto

pero que no aparecen en el documento final del trabajo de grado. Estos apartados son:

1) Metodología de desarrollo

2) Recursos:

i) Humanos

ii) Técnicos

iii) Institucionales

iv) Financieros

v) Tiempo de ejecución

3) Cronograma de actividades

4) Compromisos

14.1 Resumen/Abstract

El resumen es la última parte del documento que se redacta en un trabajo de

grado. Sólo cuando ya se ha terminado todo el trabajo -sistema y documento- se elabora

este apartado. Por tanto, debe escribirse en pasado.

El objetivo es resumir el trabajo de grado. Al redactarlo, se debe tener en cuenta

que los lectores no saben nada del trabajo realizado y leen el resumen para ver si les

interesa el documento. Es más, la mayoría de los lectores sólo leerá el resumen. Por tanto,

éste debe considerarse como una alternativa al documento, no como una introducción.

Como dice Umberto Eco (1996, 141), un buen resumen le debe dar al lector la sensación

de conocer el trabajo sin haberlo leído.

Un buen resumen debe informar, ser concreto y autosuficiente.

Page 142: Como Escribir Documentos Tecnicos de Ingenieria v13

En el resumen se debe utilizar un lenguaje familiar, claro y conciso que llegue en

forma directa al posible lector. Por tanto, se deben omitir las siglas y abreviaturas poco

conocidas; éstas se presentan la primera vez que se utilizan en el documento, es decir, a

partir de la introducción.

El tamaño del resumen depende de la longitud del documento tratado. Para un

trabajo de grado su tamaño no puede exceder las 200 palabras. Para el artículo tipo

revista, el tamaño debe reducirse a 150 palabras. Sin embargo, no tiene sentido malgastar

las palabras; si se puede escribir un buen resumen en 100 palabras ¿para qué utilizar las

200 permitidas? Por tanto, se debe evitar la verbosidad; cada palabra utilizada debe

sopesarse cuidadosamente.

Para hacer un resumen conciso se requiere extraer las ideas principales de aquellas

otras que las complementan; esto requiere trabajo. Por ejemplo, hay que tratar de escribir

el problema en una sola frase, lo cual no es fácil pero contribuye a formar una disciplina

que le servirá al estudiante en todos sus escritos.

Por otra parte, quienes están interesados en buscar información específica acuden

normalmente a los servicios especializados de búsqueda bibliográfica, que prestan ese

servicio a partir de los resúmenes. Algunos de estos servicios lo hacen a partir de las

palabras clave del resumen y otros lo hacen a partir de todo el resumen. Por eso se

recomienda incluir máximo cinco palabras clave o descriptores primarios (Keywords in

context) en el resumen que ayudarán a esos servicios bibliográficos.

Tanto Day (1996, pp 28-30) como Michaelson (1990, pp 31-34) tratan en esencia

dos tipos de resúmenes: el informativo y el descriptivo. El informativo muestra en forma

sucinta el trabajo, sin interpretaciones. A su vez, el descriptivo, muestra cualitativamente

qué contiene el documento.

Para el artículo científico, Day propone utilizar el resumen informativo en cuanto

que es una versión reducida de aquél. Este resumen consta de los siguientes elementos

de información:

• El problema.

• El método utilizado.

• Los datos y las conclusiones principales.

Page 143: Como Escribir Documentos Tecnicos de Ingenieria v13

Por su parte Michaelson propone utilizar el que más se adapte al público

destinatario del documento. Así, para un artículo de revisión plantea un resumen

descriptivo en cuanto a que los lectores necesitan un “mapa de ruta” que los oriente. Pero

si se trata de un estudio experimental o teórico propone utilizar un resumen informativo.

Y, si es para una tesis, opina que se puede escoger tanto un resumen informativo como

una mezcla de los dos (descriptivo-informativo).

Desde el punto de vista de ingeniería, el resumen de tipo informativo debe

contestar tres preguntas básicas:

• ¿Cuál era el problema?

• ¿Cómo se resolvió?

• ¿Qué resultados se lograron?

• E incluir la conclusión más relevante del trabajo.

Este tipo de resumen les permite a los lectores mantenerse al día en su campo de

acción sin necesidad de leer todo el documento. Pocos lectores o ninguno leerán el

documento completo porque o bien no tienen tiempo o no están interesados.

Los resúmenes yerran ante todo por suministrar detalles innecesarios. También, a

veces, omiten información importante.

14.2 Tabla de contenido

Informa al lector las diferentes secciones de que consta el documento e indica la

página donde se inicia cada una de ellas.

Debe estar limitada a dos o tres páginas. Según el tamaño se incluirán hasta los

títulos de tercer orden, incluyendo la bibliografía y los anexos.

Para su realización se deben utilizar las herramientas pertinentes de Word.

Las tablas de contenido pecan porque se elaboran a mano y porque no están

actualizadas. También, a veces, suministran demasiados niveles de información.

Page 144: Como Escribir Documentos Tecnicos de Ingenieria v13

14.3 Título del trabajo de grado

Dada la gran cantidad de información que se produce a nivel científico y

tecnológico, un trabajo de grado tiene muy pocas posibilidades de ser leído. Sin embargo,

sus autores tienen varias oportunidades para interesar a los lectores: título, resumen,

artículo tipo revista y documento completo, en ese orden.

El título es la etiqueta mediante la cual se trata de vender el producto final -el

documento-. Sin embargo, la mayoría de los posibles lectores termina su interés aquí; si el

título no los atrae no mostrarán interés por el resto del trabajo. Si el título es llamativo, el

lector entonces tratará de buscar el resumen del documento para constatar que su interés

inicial sigue siendo real. Después de leerlo, si definitivamente el trabajo continúa siendo

interesante, el lector irá a buscar el documento final. Pero es muy probable que a este

punto lleguen muy pocos lectores o ninguno.

Existe otra posibilidad intermedia de acceso al público y es el llamado artículo tipo

revista, pero sólo algunos de los trabajos de grado son publicados en las revistas

académicas que promocionan ese tipo de proyectos.

Por tanto, el título debe ser lo suficientemente informativo, claro y corto; cada una

de sus palabras debe ser elegida con mucho cuidado.

Un título como Estudios sobre antenas no resulta muy útil para el posible lector.

Por otra parte, otro como Módulo de interfaz de software para el geoposicionamiento y

obtención de información de puntos móviles o fijos terrestres mediante la utilización de la

constelación Orbcomm se acerca más a un resumen que a un buen título.

La mayoría de los títulos largos contienen palabras superfluas como investigación

sobre…, proyecto de…, estudio sobre... Estas palabras, así como las abreviaturas, deben

evitarse.

Un título como Sistema de tarificación telefónica parece un buen título; es corto y

no tiene palabras superfluas. Sin embargo, este título es corto porque utiliza términos

generales y no específicos.

Se puede suponer a priori que el trabajo no incluyó todos los posibles métodos de

tarificación y que no se aplica a todos los sistemas o subsistemas de conmutación

telefónica. Por tanto, el título es ambiguo. Posiblemente tiene solo una aplicación

específica y se debería tratar de mejorarlo indicando su aplicación para darle un

Page 145: Como Escribir Documentos Tecnicos de Ingenieria v13

significado más claro. En consecuencia, el título mencionado podría plantearse como

Sistema de tarificación telefónica para cabinas de servicio público.

Muchos de los errores de los títulos están relacionados con el orden de las palabras

o con el significado de las mismas. Así, títulos como Digitalización del arco dental y

generación de base de datos tienen un significado diferente al que imaginaron sus

autores. ¿Se va a digitalizar el arco dental o la información de las mediciones que se

obtengan del mismo?

Una propuesta contenía el siguiente título: Transmisión inalámbrica para cabezas

de medición en seguridad industrial. ¿Qué clase de cabezas serán esas? El título mejoró en

una segunda entrega: Transmisión inalámbrica para cabezas de medición de gases tóxicos

en seguridad industrial. Sin embargo, las palabras en seguridad industrial parecen

superfluas.

Otra propuesta se titulaba: Afinador para guitarras acústicas autónomo.

Indudablemente el título mejora si se cambia de sitio una palabra: Afinador autónomo

para guitarras acústicas.

Finalmente, en un tercer ejemplo, el trabajo se titulaba: Sistema de monitoreo de

conexión de dispositivos periféricos en computadores en red. El título mejoró al quedar

así: Monitoreo de dispositivos periféricos en redes de computadores. Quizás mejoraría más

si se especificara el tipo de redes de computadores en que se aplicará.

Por tanto, el significado y el orden de las palabras del título son importantes para

el posible lector que ve el título en el índice de una revista o en otro medio. El título, en

general, es una frase cuyo contenido, por sí solo, es fuente de información.

Por otra parte, los títulos no deben contener, en lo posible, abreviaturas, siglas,

nombres patentados, jerga, etc. Su longitud no debe sobrepasar 15 palabras.

Los títulos yerran porque son muy cortos o muy largos. Un título corto no define el

alcance del trabajo; empero uno largo puede contener muchas palabras superfluas que

tampoco ayudan a delimitar su espectro.

Page 146: Como Escribir Documentos Tecnicos de Ingenieria v13

14.4 Introducción

No debe confundirse con el resumen. La introducción es independiente de éste y

se escribe como si el resumen no existiera; de hecho, cuando se escribe la introducción

por primera vez, el resumen no existe todavía.

Cabe anotar que la introducción se escribe en dos momentos diferentes:

• Por primera vez cuando se está elaborando el anteproyecto; fase de

planeación.

• Por segunda vez, cuando se está redactando el documento final; fase de

ejecución.

Así, la primera vez se redacta en futuro y trata de lo que se intenta hacer en el

trabajo de grado; la segunda se redacta en pasado y cubre lo realizado.

La introducción presenta al lector la columna vertebral del documento y, como tal,

debe contener, al menos, los siguientes puntos del trabajo de grado:

• Lo primero que debe quedar claro es el problema y su alcance; si éste no se

define en forma concisa, razonable y comprensible, los lectores ya no se

interesarán por el resto del documento.

• En segundo lugar se debe hacer una revisión bibliográfica centrada en el

problema. Con este fin se recomienda hacer la revisión en dos tópicos

diferentes pero complementarios:

o Los fundamentos teóricos que soportan la solución del problema

definido.

o La tecnología relacionada con productos, preferiblemente

comerciales, que den una respuesta al problema planteado.

De estos puntos se debe extractar la columna vertebral que complemente

al problema y ayude a ubicar al lector –antecedentes-.

• A continuación, exponer las alternativas de solución visualizadas y

especificar la seleccionada conjuntamente con la tecnología empleada.

• Además se deben mencionar los principales resultados obtenidos

• Y, en último lugar, presentar la conclusión o conclusiones principales que se

desprenden de los resultados.

Page 147: Como Escribir Documentos Tecnicos de Ingenieria v13

La estructura planteada va del problema a la solución; es tan importante para los

lectores que es conveniente que haya cierta redundancia con el resumen. Este contenido

está ajustado a los trabajos de grado.

Como dice Day, (2003, pp 31-33), los temas “deben presentarse de forma que el

lector comprenda cuál era el problema y cómo se trató de resolverlo”. Aquí Day,

evidentemente, se refiere a la introducción final, cuando el proyecto ya se ha terminado.

Michaelson, (1990, pp 37-43), por su parte, plantea que la introducción debe

ajustarse al público destinatario del documento, así:

• Reporte interno para los ingenieros de una compañía; ajustarla para llenar

las expectativas del consumo doméstico.

• Paper para una revista; ajustarla al estilo y necesidades de la publicación

seriada.

• Documento para una conferencia o seminario técnico; plantear qué se hizo

en el trabajo y qué se mostrará en la conferencia.

• Artículo para una revista comercial; mostrar las técnicas desarrolladas y la

utilidad del sistema.

• Y para una tesis de maestría; ajustarla para el público destinatario -el

director y jurados de grado-.

La extensión de la introducción no debe sobrepasar dos páginas.

Finalmente, cabe recordar que no todos los lectores serán de la misma especialidad

que los autores. En consecuencia, la introducción es el lugar más apropiado para colocar

los principales términos y las abreviaturas especializadas que se vayan a utilizar en el

documento.

14.5 Problema

Este es el punto de partida del trabajo de grado. Aquí se requiere de una mente

clara que defina en forma concisa, precisa y completa el problema que origina el proyecto.

Page 148: Como Escribir Documentos Tecnicos de Ingenieria v13

Si no hay claridad al respecto, todo el edificio que se construya con estos cimientos se

derrumbará. Como decía Eurípides: “lo que mal empieza mal acaba”.

Es conveniente referenciar las posibles soluciones ya existentes y precisar cuáles

son los vacíos o debilidades que presentan y que hacen necesario acometer una solución a

la medida. En la descripción del problema deben emplearse términos precisos que no den

lugar a varias interpretaciones. En la ingeniería se presentan problemas de tipo técnico,

económico, social, político, etc.

Su extensión debe ser de pocos párrafos.

14.6 Estado del arte

La revisión documental relacionada con el problema es un punto de partida

importante para el proyecto dado que no se parte de cero.

Es necesario conocer qué han hecho los demás al respecto, qué soluciones

similares existen y qué ventajas y desventajas ofrecen. Si existe una solución que no

presente desventajas, y aún así se decide acometer el proyecto, debe justificarse el

porqué se amerita otra solución.

Por revisión documental se entiende la información existente relacionada con el

problema que origina el proyecto. La información puede estar en cualquier medio: libros,

revistas, catálogos, manuales, memorias de simposios, trabajos de grado, tesis, bases de

datos, CD-ROM, casetes, etc.

Dado que las palabras que se tomarán de esa revisión no son propias, hay que

referenciar las fuentes de las mismas, es decir, se debe hacer citas.

La revisión documental se centra en el problema. Se recomienda dividir la revisión

en dos partes diferentes pero complementarias. La primera, referida a las bases teóricas

que soportan la solución del problema; y la segunda, que trata de los productos

tecnológicos existentes en el mercado.

14.6.1 Bases teóricas

Se refiere a la teoría que soporta la solución del problema propuesto. Se indaga

sobre lo que hay escrito acerca de él. Para esta investigación la información se encuentra

Page 149: Como Escribir Documentos Tecnicos de Ingenieria v13

especialmente en revistas, bases de datos, libros, simposios, foros y demás trabajos

escritos sobre el tema.

Como lo menciona Gibaldi (2000, pp. 2-3), se hace investigación cuando se desea

explorar una idea, probar algo, resolver un problema, o buscar soporte externo para

apoyar las ideas propias.

El documento de investigación se basa en fuentes primarias, secundarias o en una

combinación de ambas. Aquí se entiende que una fuente primaria es un documento

publicado como resultado de estudios directos efectuados mediante observaciones,

investigaciones o experimentos sobre un tema. Por otra parte, se entiende como fuente

secundaria el escrito resultante de examinar los estudios realizados por otros

investigadores sobre un tema dado; pueden ser libros, artículos de revisión o artículos de

opinión.

Así, para elaborar el documento, el estudiante aprende a buscar y recuperar

información: identifica, localiza, evalúa y asimila las investigaciones de otros sobre un

tema de estudio. Después desarrolla y expresa sus ideas propias, presentadas en forma

clara y persuasiva.

La revisión de las fuentes de información le ayudará a conocer los diferentes

puntos de vista sobre un asunto, a ampliar o adecuar sus ideas, a conocer nuevos

métodos, modelos o tecnologías, pero siempre teniendo en cuenta que el objetivo

fundamental de la investigación no es resumir el pensamiento o los trabajos de otros sino

asimilarlos, apropiarse de ellos.

En este apartado se relacionan los principales fundamentos teóricos en que se

apoya de manera profunda y concreta la solución.

La información extractada se muestra en:

• Un resumen preciso y concreto de las bases teóricas.

• Un anexo con información más extensa de aquellos puntos esenciales que

aclaran los fundamentos teóricos.

• Referencias bibliográficas de la información de donde se hicieron citas

textuales o de contexto. Estas citas deben mencionar el documento y la

página o páginas de donde fue extractada la información.

Page 150: Como Escribir Documentos Tecnicos de Ingenieria v13

Se debe evitar el plagio; siendo estrictos, se deberían hacer citas, párrafo por

párrafo, de las fuentes que le sirvieron para elaborar este numeral. Cuando las citas son

textuales, éstas van entre comillas. Por otra parte, se estima que la cantidad de citas

textuales no debe superar al 30% del texto total del capítulo; también que cada cita

textual, en lo posible, no exceda el tamaño de un párrafo. Toda información escrita de un

autor debe ser respetada; esto incluye tablas, figuras, ejemplos e ideas.

También hay que evitar la tendencia a llenar este apartado de extensos discursos

que tocan tangencialmente otros temas; como se mencionó antes, debe concentrarse en

el problema. Una buena extensión de este apartado no debería sobrepasar unas cinco

páginas.

Al elaborar las bases teóricas se yerra por el contenido, por la estructura y por

incluir información no necesaria. Respecto del contenido, porque se tiende a ser

superficial; hay que ser precisos, concretos y profundos. Respecto a la estructura en

cuanto a la falta de numeración interna del capítulo que lo hace incomprensible. Y,

finalmente, porque se tiende a llenar este apartado de información copiosa e innecesaria

desde el punto de vista del problema que se trata de solucionar.

14.6.2 Tecnología

Este numeral es muy importante en todos los proyectos de ingeniería. Aquí se hace

una referencia a las tecnologías de punta que existen sobre el tema propuesto y se

exponen productos tecnológicos existentes en el mercado que solucionan, total o

parcialmente, el problema.

Se indaga sobre lo que hay escrito con respecto a tecnologías de punta y a

productos concretos existentes. La información se encuentra especialmente en revistas de

divulgación, catálogos y bases de datos de patentes (si amerita). Internet es una buena

herramienta de ayuda para buscar esta información.

Hay que tener en cuenta que para desarrollar el trabajo de grado, los futuros

ingenieros estudian las tecnologías de punta que utilizarán en su ejecución para

apropiarse de ellas.

La información de referencia se utiliza para:

Page 151: Como Escribir Documentos Tecnicos de Ingenieria v13

• Elaborar el resumen preciso y concreto de las características técnicas de los

productos tecnológicos. Dicho resumen va en este apartado.

• Elaborar un anexo con aquellos documentos esenciales que amplíen las

características de los productos tecnológicos.

• Construir la información sobre los documentos de referencia consultados

sobre el tema; ésta hará parte de la información de referencia (bibliografía).

La longitud de este numeral no debería ser superior a cinco páginas.

Al elaborar esta sección se peca por el contenido, por la estructura y por incluir

información innecesaria. Por el contenido en cuanto a que la información suministrada es

superficial; ésta debe contener las características técnicas esenciales de los productos y

los datos de las mismas. Por la estructura porque la numeración interna es confusa y se

pierden las ideas. Y finalmente, porque a falta de lo anterior, se trata de suministrar más

información pero ésta no es relevante para el problema.

14.7 Glosario de términos

En esta sección se incluyen los términos técnicos ajenos al programa de ingeniería

objeto del trabajo. Es decir, aquellos términos que no hacen parte del lenguaje técnico

común de los estudiantes.

El glosario tiene normas respecto al contenido y a la forma. Respecto al contenido,

cada término debe ser definido en forma concreta y corta; no puede ser farragoso. En

cuanto a la forma se hace necesaria una visualización que le muestre al lector claramente

cada una de las entradas. En este sentido, una forma normal de hacerlo es siguiendo un

formato similar al de la documentación de referencia, teniendo en cuenta que el glosario

de términos no se numera y va en orden alfabético.

Al elaborar el glosario de términos se falla por el contenido, por la forma y por

incluir términos que no son necesarios, pues son del lenguaje común.

Page 152: Como Escribir Documentos Tecnicos de Ingenieria v13

14.8 Justificación

Es normal que los problemas que se abordan para desarrollar trabajos de grado ya

cuenten con muchas soluciones, más o menos exitosas. Entonces surge la pregunta: ¿para

qué reinventar la rueda?

En respuesta a la pregunta inicial, a manera de ejemplo y tomándola en forma

literal, se puede decir que en el campeonato de fórmula1 se reinventa la rueda cada 15

días. Dependiendo del tipo de chasis, de las características del piso, de las condiciones

ambientales y algunas otras, los fabricantes de llantas que proveen de neumáticos a los

competidores viven en un proceso constante de innovación.

Por otra parte, y ya entrando en materia, en respuesta a esa pregunta existen

razones de índole académica. También pueden existir otras razones técnicas, económicas,

sociales, políticas, etc.

La justificación es la explicación del porqué fue conveniente llevar a cabo el trabajo

de grado, exponiendo para ello razones y argumentos de importancia real. En lo posible,

la justificación incluye datos.

La justificación liga al problema con los entregables de la solución propuesta. En

consecuencia, en este apartado se señalan los aportes que hizo el trabajo de grado a la

solución del problema planteado.

En la justificación se yerra por desvincular el problema origen del trabajo de grado

de la solución propuesta.

14.9 Objetivos

Al llegar a este numeral ya se ha definido el problema y se ha concretado el título

del trabajo de grado. Mediante este último se ha expuesto, en forma muy amplia, lo que

se quiere realizar.

Aquí se define mejor el alcance del proyecto a través de los objetivos, es decir, de

las acciones principales por realizar. Estos se redactan en frases cortas con verbos activos

en infinitivo y se pueden diferenciar entre principal o general y específicos. Entre los

verbos que se pueden utilizar se tienen los siguientes:

• Analizar

Page 153: Como Escribir Documentos Tecnicos de Ingenieria v13

• Comparar

• Clasificar

• Calcular

• Determinar

• Diseñar

• Evaluar

• Implementar

• Y probar

Cada uno de los objetivos termina en un producto entregable concreto: un

dispositivo, un algoritmo, un proceso, un documento, por ejemplo. Si no hay entregables,

entonces las actividades que se plantean podrán ser muy loables pero no son objetivos.

Los objetivos se expresan con claridad para evitar posibles desviaciones en el

proceso de desarrollo. Deben ser susceptibles de alcanzar.

El objetivo general contesta a la pregunta: ¿Qué se propone con el desarrollo del

proyecto? Está relacionado directamente con la respuesta al problema planteado; define lo

que se quiere alcanzar.

Los objetivos específicos se formulan en estricta función del objetivo general. Son

la guía lógica de ejecución del proyecto, determinan sus límites y amplitud, orientan sobre

los resultados esperados y delimitan las etapas del proceso a realizar; facilitan el

desarrollo del trabajo de grado y ayudan a concretar los requerimientos. Los objetivos

específicos contestan a la pregunta: ¿qué logros se pretenden, a corto plazo, para lograr

el objetivo general?

Los objetivos yerran porque son muy ambiguos, no conducen a un producto

entregable o están orientando el diseño.

14.10 Requerimientos

En el desarrollo de un trabajo de grado de ingeniería, hardware y/o software, no

basta con tener unos objetivos bien definidos; estos son ambiguos a la hora de acometer

el diseño y la implementación del proyecto. Se hace, pues, necesario acotar su alcance.

Page 154: Como Escribir Documentos Tecnicos de Ingenieria v13

Para lograrlo, se desglosa cada uno de los objetivos específicos con el fin de definir las

características técnicas de cada una de las acciones a realizar, hasta llegar a cifras y datos

mínimos mensurables. Si después de esta labor existe aún cierto grado de ambigüedad, al

final del proyecto, normalmente, tanto el usuario final como los jurados del proyecto no se

mostrarán satisfechos con el producto ofrecido.

Aquí es necesario tener en cuenta que la sección de requerimientos es semejante

al capítulo técnico de los pliegos de condiciones de una licitación pública o privada. En

consecuencia, se debe evitar cualquier grado de ambigüedad.

Ahora bien, los requerimientos son consecuencia de las reuniones adelantadas

entre los estudiantes y los usuarios finales para definir el alcance del trabajo de grado; se

parte de los objetivos, pero su elaboración final es función del trabajo de los estudiantes

asignados al proyecto. Aquí se plasman los acuerdos entre las partes –usuarios y

estudiantes-. Sin embargo, los requerimientos deben satisfacer las necesidades puntuales

del usuario final; si éste no está de acuerdo, entonces aquellos no son válidos. Por tanto, y

como se trata de un acuerdo entre las partes, este ítem debería ser firmado por éstas.

Los requerimientos se redactan en lenguaje técnico, de ingenieros. Deben ser

precisos, concretos, contener las características técnicas que debe cumplir el

sistema/dispositivo/algoritmo, u otro, que se vaya a realizar. Por cada característica se

definen los datos que la delimiten; a veces es conveniente agregar gráficas para mejorar

su comprensión. Estas características y datos son las condiciones mínimas a tener en

cuenta en el momento de desarrollar el trabajo.

El tiempo que se le asigne a definir bien los requerimientos será provechosamente

retribuido cuando se desarrollen los capítulos relacionados con la ejecución del proyecto.

El apartado de requerimientos es la última sección de la fase de planeación.

Existen varias formas de acometer la definición de los requerimientos. La primera

parte de cada uno de los objetivos específicos y los desmenuza; al final, se mira el

conjunto para analizar qué otros puntos deben definirse al considerar la integración de los

objetivos específicos. Otra manera de hacerlo es partir de cada uno de los módulos

previsibles en la arquitectura final del sistema y, por cada módulo, concretar todas sus

especificaciones. Esta última forma es aplicable cuando se puede predecir la arquitectura

de la solución.

Page 155: Como Escribir Documentos Tecnicos de Ingenieria v13

Otra forma más técnica e independiente de la arquitectura considera los siguientes

puntos, pero requiere que los realizadores tengan cierto grado de experiencia:

• Requerimientos funcionales

o Definición

o Entradas

o Proceso

o Salidas

• Requerimientos de operación

• Requerimientos de interfaz

• Requerimientos de desempeño

• Requerimientos de administración

• Requerimientos de instalación

• Requerimientos de mantenimiento

• Requerimientos de calidad

Los requerimientos yerran ante todo por ser superficiales, ambiguos y por no tener

en cuenta al problema. A veces faltan también definiciones complementarias.

14.11 Metodología de desarrollo

Es el marco operativo, pues explica la forma concreta como se va a trabajar. En él

se precisa cuál será la estrategia de desarrollo; se definen las etapas, las actividades

concretas de cada una, y se hace un esbozo de los resultados esperados al término de

aquellas.

Debe tener en cuenta, cuando se trabaja con sistemas de información, que la

materia prima que alimenta esos sistemas es la información específica. Por consiguiente,

el análisis debe considerar si se debe capturar y validar la información que se instalará en

el sistema a implantar.

Igualmente, cuando el sistema a ejecutar automatiza algunas actividades

humanas, que antes se hacían manualmente o con procedimientos diferentes, es

necesario considerar la actualización de los métodos y los procedimientos que se

emplearán con el nuevo sistema.

Page 156: Como Escribir Documentos Tecnicos de Ingenieria v13

Los diagramas de flujo pueden ayudar.

14.12 Recursos

Se refiere a los medios necesarios para llevar a cabo el proyecto de grado;

pueden ser humanos, técnicos, institucionales, financieros, y de tiempo.

14.12.1 Humanos

Son las personas que van a trabajar, básicamente los estudiantes que proponen el

anteproyecto de grado. También deben figurar el director y los asesores propuestos que

hayan aceptado su función.

Todas las personas tienen limitaciones de tiempo para desarrollar el proyecto que

se plantea. Por tanto, se debe especificar la cantidad de horas que aportará cada una de

ellas (por semana o por mes). Se espera que los estudiantes puedan dedicar diez horas

semanales.

14.12.2 Técnicos

Son los equipos -hardware y software-, instrumentos de medición, materiales y

componentes necesarios tanto para desarrollar como para implantar el sistema propuesto.

Se debe diferenciar entre los equipos e instrumentos necesarios para desarrollar el

sistema, por una parte; y los equipos, materiales y componentes que harán parte del

sistema a implantar, por otra.

Normalmente es posible que la Universidad pueda aportar equipos e instrumentos

de apoyo para desarrollar el sistema propuesto; no obstante, esos equipos e instrumentos

no están sin oficio; es decir, tienen algún objetivo que cumplir dentro de los laboratorios

de la Facultad. Por tanto, se debe calcular el tiempo que se necesita disponer de ellos para

realizar el proyecto y consultar con las autoridades académicas para ver si puede disponer

de ellos o no.

14.12.3 Institucionales

Page 157: Como Escribir Documentos Tecnicos de Ingenieria v13

Son los libros, revistas, manuales y demás documentos escritos y, también, el

acceso a bases de datos de información, que se requieren para elaborar el proyecto de

grado.

También se incluye el espacio que se requiere en los laboratorios, u otro sitio, para

desarrollar el proyecto y, posteriormente, implantarlo, si es el caso.

Estos recursos, normalmente, no tienen el mismo costo que los equipos pero,

quizás, son más difíciles de conseguir y su obtención puede ser más demorada. Por tanto,

se debe considerar esta dificultad en el momento de establecer el cronograma de

actividades.

14.12.4 Financieros

Se refiere a todos los gastos que son necesarios para el desarrollo del proyecto.

Tiene que ver con los recursos humanos internos (estudiantes, director, codirector

y asesores de la Universidad) y externos cuya contribución es indispensable; técnicos

(equipos, instrumentos, materiales y componentes que es necesario adquirir);

documentales, y otros (transporte, correo, nacionalización, impuestos y servicios de

telecomunicaciones, por ejemplo).

Algunos de esos recursos técnicos y documentales pueden ser aportados por la

Universidad; sin embargo, se deben calcular e indicar que ya existen y no requieren

erogaciones extras dentro del desarrollo del proyecto. Igualmente, se debe calcular el

costo de los recursos humanos internos de la universidad aunque no haya pagos directos

dentro del proyecto.

De esta forma se tendrá una visión del costo total que implica desarrollar el

proyecto de grado.

Ahora bien, se debe hacer una separación clara entre recursos que requieren o no

erogaciones directas dentro del proyecto; es necesario conocer qué ítems específicos

requieren erogaciones para desarrollar el proyecto de grado.

14.12.5 Tiempo de ejecución

Es el tiempo total estimado para desarrollar el proyecto, una vez se apruebe el

anteproyecto de grado y se inicie su desarrollo.

Page 158: Como Escribir Documentos Tecnicos de Ingenieria v13

14.13 Cronograma de actividades

Se refiere a la distribución de las actividades necesarias para desarrollar e

implantar el sistema, según el tiempo y recursos requeridos.

Se debe tener en cuenta que algunas actividades menores pueden ocasionar

demoras en el desarrollo de las demás. Por ejemplo, puede ser necesario importar algunos

elementos; aquí pueden aparecer tiempos imprevistos en el cronograma.

El cronograma de actividades será, también, una herramienta de control del

desarrollo del proyecto. Por tanto, se recomienda utilizar un paquete informático de

ayuda, como Project.

14.14 Compromisos

Para desarrollar un proyecto existen, normalmente, compromisos de los diferentes

entes y personas que participan en el mismo.

Para claridad del proyecto, se deben fijar concretamente las responsabilidades y

compromisos que adquiere cada uno de los actores. Esto facilitará el desarrollo del

sistema en el tiempo y con los recursos previstos.

14.15 Diseño global

Aquí se inicia la fase de ejecución del trabajo de grado. Todos los apartados

anteriores hacen parte de la etapa de planeación.

Se debe recordar que en el desarrollo de un proyecto, en general, existen varias

fases bien definidas que, normalmente, son acometidas por diferentes grupos. Estas

etapas incluyen la planeación, ejecución, pruebas, instalación, puesta en marcha,

operación y mantenimiento. Sin embargo, en el mejor de los casos, en la vida académica

sólo se llega hasta la instalación y puesta en marcha; aquí no se tienen en cuenta ni la

operación ni el mantenimiento.

Page 159: Como Escribir Documentos Tecnicos de Ingenieria v13

Por otra parte, en la vida académica los estudiantes realizan todas las fases

involucradas en el trabajo de grado. Sin embargo, es preciso que entiendan el proceso

real para que lo puedan realizar una vez que ingresen al campo laboral. Allí pueden estar

en cualquiera de los dos bandos: como contratantes o como contratistas.

En la vida real es normal que la etapa de planeación la realice la empresa que tiene

la necesidad, es decir, el usuario del sistema. Una vez que el documento está elaborado -

pliego de condiciones- se abre una licitación pública o privada en la que participan las

empresas diseñadoras interesadas. Aquella que gane la licitación será la encargada de

realizar la etapa de ejecución que incluye los capítulos de diseño global, diseño detallado,

implementación y pruebas, y la documentación relacionada. Cuando el sistema está

terminado, el usuario final realiza las pruebas de aceptación con base en los

requerimientos –capítulo técnico de la licitación-. Si el usuario final acepta las pruebas del

sistema, éste se pone en funcionamiento y se inician las fases de operación y

mantenimiento.

El diseño global tiene como propósito convertir los requerimientos en una

propuesta técnica concreta que cumpla con todos y cada uno de éstos. También plantea la

organización global del sistema. En este apartado se contesta la pregunta ¿qué se va a

hacer?

Se plantean al menos dos alternativas de solución. Cada alternativa presenta su

arquitectura física, con módulos interconectados entre sí (ver figura 14.1). Cada uno de

esos módulos es una caja negra a la que se le asignan las funciones que debe realizar y se

le especifican sus entradas y salidas en forma detallada; cada uno debe tener definidas

todas sus funciones completamente, y sus entradas y salidas deben estar bien

especificadas (nombre de cada variable, unidad de medida utilizada, rango de valores

permitidos, forma de conexión –serie o paralelo-).

Una alternativa de solución puede contener subsistemas hardware y software, en

general. Aquí no se incluyen circuitos específicos, pero sí se puede escoger la tecnología o

tecnologías a utilizar.

Page 160: Como Escribir Documentos Tecnicos de Ingenieria v13

Fig. 14.1 Diagrama de bloques

En una empresa de diseño es normal que los módulos planteados en el diseño

global se repartan entre varios ingenieros o grupos de ingenieros para que cada uno de

ellos realice su diseño detallado, implementación, pruebas individuales y documentación

correspondiente. Es más, esos ingenieros pueden estar ubicados en sitios geográficos

diferentes. Por consiguiente, la definición, por cada módulo, de sus funciones, entradas y

salidas debe ser minuciosa y precisa, pues de otra forma el sistema no funcionaría al

integrar las diferentes partes. Por lo demás, las funciones, entradas y salidas de cada

módulo no cambian en las etapas posteriores del proyecto.

En la vida académica, por otra parte, se simula que cada uno de los estudiantes es

un grupo de trabajo diferente que debe asumir el desarrollo de un módulo del sistema;

éste queda bajo su responsabilidad.

Al terminar el diseño global de cada una de las alternativas se hace la comparación

entre todas ellas; ésta incluye, al menos, los aspectos técnicos, económicos y de tiempo

de desarrollo. De ese análisis surge la alternativa escogida que se ejecutará en las

secciones subsiguientes.

Por otra parte, al término de este apartado ya se puede iniciar la elaboración del

plan de pruebas y el contenido inicial de los manuales de usuario, apartados que se irán

mejorando a medida que avanza la ejecución del trabajo de grado.

El diseño global yerra por la definición imprecisa de las funciones de cada módulo y

la falta de especificación minuciosa de sus entradas y salidas.

Page 161: Como Escribir Documentos Tecnicos de Ingenieria v13

14.16 Diseño detallado

Esta sección parte de la alternativa seleccionada. Aquí se contesta la pregunta

¿cómo se va a hacer?

En el diseño detallado se especifica cómo se cumplen los requerimientos del

proyecto dentro de niveles de servicio aceptables por el usuario final. Las funciones de las

cajas negras del apartado anterior se convierten en circuitos o en algoritmos, según que la

solución se realice mediante hardware, software, o una solución combinada.

Si la solución es por hardware, se seleccionan los componentes, se utilizan sus

diagramas esquemáticos y se hacen los cálculos que sean necesarios a partir del modelo

utilizado. La circuitería resultante reemplaza a las cajas negras, manteniendo las entradas

y salidas de éstas. Esto se hace para cada uno de los módulos –cajas negras-. En

consecuencia, al final del diseño detallado habrá un gran plano con todos los circuitos

esquemáticos que reemplaza a la arquitectura modular de cajas negras del diseño global.

Dependiendo del tamaño del hardware resultante, éste se dividirá en módulos y

submódulos hasta llegar al nivel de tarjetas; deben quedar muy claras la estructura, las

funciones de cada elemento, las interfaces y la tecnología a emplear.

Si la solución es por software, se hacen los diagramas de flujo correspondientes.

Se inicia con un diagrama general y de él se desprenden los diagramas de cada uno de

sus módulos hasta llegar a las funciones. Se utiliza un lenguaje natural, entendible por

cualquier persona. Los diagramas de flujo deben ser completos, detallados y bien

documentados; se utilizan rótulos para asociar estos diagramas con el código definitivo,

una vez se haga la implementación. Estos principios se deben adaptar a las herramientas

de software específicas que se utilicen.

En el subsistema software se debería llegar hasta el último nivel -estructura,

funciones y objetos que intervienen, librerías, directorios, archivos, variables globales,

parámetros, requerimientos de máquina-. También incluye el diseño y el esquema de la

base de datos, si aplica.

Otro aspecto del diseño detallado es el diseño industrial del mismo. Todos los

componentes del sistema deben ir en un recipiente adecuado a su uso. Se definen los

materiales a utilizar, el cableado, su ventilación, la calidad de los circuitos impresos, etc.

Con este fin, se utilizan herramientas apropiadas como, por ejemplo, Solid Edge.

Page 162: Como Escribir Documentos Tecnicos de Ingenieria v13

Al terminar el diseño detallado se tendrá el diagrama esquemático general de todo

el hardware del sistema en un solo plano, todos los diagramas de flujo correspondientes al

software y el diseño industrial del sistema.

Por otra parte, al término de este apartado se pueden complementar el plan de

pruebas y el contenido de los manuales de usuario, apartados que se iniciaron en la

sección anterior.

El diseño detallado yerra principalmente por desorden y falta de profundidad.

Desorden, en cuanto a que no se sigue el mismo orden del apartado de diseño global y su

numeración interna es muy superficial. Profundidad, en cuanto la selección de

componentes se hace a dedo y, especialmente, no se hacen los cálculos necesarios que se

tienden a sustituir por comentarios.

14.17 Implementación

Este apartado es relativamente el más sencillo de la fase de ejecución. Su objetivo

es el montaje y cableado de los circuitos definidos en el diseño detallado, y la codificación

de todas las funciones y módulos de software planteados con el fin de realizar las pruebas

del sistema.

El diseño industrial no se implementa todavía: se espera a que los estudiantes

realicen las pruebas y a que los evaluadores den su concepto sobre las posibles

modificaciones a que haya lugar. Por lo tanto, esta sección se escribe en dos momentos

diferentes: uno para hacer el documento antes de las pruebas; y otro para elaborar el

documento final, cuando ya está implementado el diseño industrial.

El montaje del hardware se hace sobre protoboards o circuitos impresos de

borrador. Aquí ya se trabaja con componentes reales. Por lo tanto, se pasa de los

diagramas esquemáticos a chips con todos sus pines. En el montaje del hardware se

depende del grado de integración que se haya utilizado en el diseño.

Page 163: Como Escribir Documentos Tecnicos de Ingenieria v13

Del montaje del hardware surge el diagrama general detallado de cableado del

sistema que va desde la fuente de alimentación hasta el puesto de trabajo donde se

ubiquen los operadores del sistema.

También se hace el diseño de todos los circuitos impresos, con todas sus artes, por

ambas caras, mostrando los caminos y los componentes. Los circuitos impresos se

documentan bien. Además, por cada tarjeta impresa va un listado detallado con todos sus

componentes y valores. Si hay más de una tarjeta impresa, se muestra cómo se

interconectan entre sí.

Desde el punto de vista del software, se trata de codificar todas las funciones y

módulos especificados en el diseño para garantizar su operatividad. Aquí se depende de

las herramientas de software que se hayan seleccionado; por ejemplo, con Labview no

existe diferencia entre el diseño detallado y la implementación.

Este capítulo se elabora en paralelo con el capítulo de pruebas. Por esta razón

también se ha insistido que el plan de pruebas y los manuales de usuario se realicen en

paralelo con los apartados de diseño. Para ejecutar las pruebas ya debe existir el plan

correspondiente y, si van a intervenir personas ajenas al desarrollo –usuarios, por

ejemplo-, deben existir también los manuales de usuario.

En la implementación se falla porque no se actualiza el capítulo luego de

implementar el diseño industrial.

14.18 Pruebas

Esta sección y la anterior, se desarrollan paralelamente. A medida que se

implementa cada elemento, hardware o software, se hacen pruebas individuales.

Posteriormente, se ejecutan las pruebas de cada tarjeta, módulo, subsistema y,

finalmente, las pruebas de integración de los subsistemas.

Para realizar las pruebas se sigue una metodología de menos a más. Se hacen las

pruebas individuales de cada componente; luego se hacen las pruebas tarjeta por tarjeta;

a continuación se ejecutan las pruebas módulo por módulo; y posteriormente se realizan

Page 164: Como Escribir Documentos Tecnicos de Ingenieria v13

las pruebas de todo el subsistema. Esto por cada subsistema, hardware y software, por

ejemplo. Finalmente se realizan las pruebas de integración.

Para realizar las pruebas se tienen en cuenta todos los requerimientos establecidos

para el sistema.

En general, por cada prueba hay que tener en cuenta:

• Los datos de entrada

• Los datos que deben estar a la salida

• La cantidad de circuitos (o de software) que debe estar implementada para

la prueba

• Los equipos de medición necesarios

• La cantidad de personas indispensables para la misma

• El tiempo necesario para realizar la prueba

El conjunto de todas ellas constituye el plan de pruebas o protocolo de pruebas del

sistema; la forma más fácil de graficarlo es mediante una tabla. El plan debe ser detallado

y exhaustivo.

El plan de pruebas lleva una columna extra, en blanco, rotulada resultados, que se

diligenciará cuando se ejecuten los ítems anteriores.

14.19 Manuales

El usuario final recibe la documentación completa del sistema; comprende todos

los apartados de desarrollo del sistema, los manuales y los anexos.

Los manuales de usuario le permiten a éste instalar, operar y conocer más a fondo

las características técnicas del sistema. A veces también se incluyen las instrucciones para

su mantenimiento.

Los manuales se empiezan a desarrollar desde el capítulo de diseño global. Cuando

se llega a la sección de pruebas es indispensable disponer de ellos; de otra forma las

pruebas estarán incompletas dado que los procedimientos y contenido de los manuales

también se prueban.

Page 165: Como Escribir Documentos Tecnicos de Ingenieria v13

Los manuales se ajustan a medida que surgen y se solucionan los problemas; con

cada revisión surge una nueva versión de éstos. Sólo cuando el sistema está listo para su

entrega al usuario, se puede decir que ya están listos en su versión final.

El procedimiento explicativo que se sigue en cada manual se hace a prueba de

tontos. Cada manual se redacta paso a paso; se inicia con el primer paso, se sigue con el

segundo y así sucesivamente, sin saltarse ninguno, hasta el final. No se puede dar nada

por sobreentendido; todo debe quedar explícito.

Los manuales, normalmente, van en folletos separados del resto de la

documentación del sistema puesto que son documentos de uso cotidiano.

14.20 Resultados

Se considera que el trabajo de grado, para bien o para mal, tiene su soporte en

este capítulo.

Al realizar las pruebas del sistema es normal que no todo funcione al primer

intento; hay que revisar aquellos casos en que los resultados no fueron los esperados. Con

este fin, se describen en forma lógica el síntoma, la causa y la solución para cada falla

relevante; se utiliza lenguaje técnico, se suministran datos.

Las fallas encontradas se reportan y se hacen los ajustes a que haya lugar hasta

que funcione el sistema. Es necesario ir hasta la raíz del problema, es decir, llegar incluso

hasta el diseño global si allí se halla su causa. En estos casos, se actualiza la

documentación de todos los apartados que hayan sido afectados por los ajustes.

La selección de datos relevantes implica capacidad de discriminación, pues no se

describen todos los casos sino los más significativos. Su descripción debe ser clara y

sencilla, sin palabrería.

La situación normal en un trabajo de grado es que la solución planteada funcione

aunque haya que hacerle ajustes hasta encontrar la solución final. Sin embargo, también

se da el caso de que la solución no funciona o funciona en forma parcial.

Aunque esta sección es muy importante también es muy corta, pues se basa en los

capítulos precedentes, y, además, va seguida del apartado de discusión.

Page 166: Como Escribir Documentos Tecnicos de Ingenieria v13

14.21 Discusión

En un artículo científico, este numeral explica los resultados y los compara con el

conocimiento previo del tema.

En la sección de discusión de un trabajo de grado se explica el significado de los

resultados; se presenta el análisis de los mismos. Se discute si se alcanzaron o no los

objetivos propuestos, la precisión de los resultados y sus razones, y las recomendaciones

para mejorar los resultados en un trabajo posterior.

Tanto en la sección de resultados como en ésta, se deben evitar frases

rimbombantes como “el estudiante aprendió en este trabajo…” o “el estudiante obtuvo

una mejor comprensión…”, etc. El esfuerzo se concentra en la discusión de los resultados.

Se requiere un gran esfuerzo para concretar una buena discusión; imaginación,

creatividad e ingeniería.

Si es posible se debe hacer una comparación con los resultados obtenidos por

otros según el estado del arte, para continuar con el análisis de los resultados obtenidos

en el trabajo de grado y sus implicaciones.

La longitud de este apartado no debe exceder dos páginas.

14.22 Conclusiones

Las conclusiones deben resumir la discusión en forma puntual. Unos tres a cinco

puntos pueden ser suficientes.

Debe tenerse en cuenta que:

• Deben ser precisas

• Deben definir los problemas que surgieron en el desarrollo del trabajo y que

aún continúan

• Y deben hacerse recomendaciones para realizar proyectos futuros

Nótese que las conclusiones son tan importantes que aparecen en el resumen, en

la introducción y en forma más detallada en la discusión.

Page 167: Como Escribir Documentos Tecnicos de Ingenieria v13

14.23 Referencias documentales

Si dentro del trabajo de grado no se informa explícitamente qué parte del trabajo

se apoya en otros, textual o contextualmente, se asume en forma automática que es de la

autoría de los estudiantes. Pero si este no es el caso, entonces se está cometiendo una

falta ética grave: plagio. Cualquier idea que no sea propia (citas directas, figuras, tablas,

ejemplos, resúmenes, ideas teóricas, entre otras) debe ser citada en forma adecuada

dentro del trabajo de grado.

La lista de referencias es muy importante en el estado del arte –bases teóricas y

tecnología- y, a veces, en el diseño detallado. Esa lista de referencias es una excelente

fuente de información que muestra que los estudiantes están familiarizados con los

antecedentes del problema.

Los posibles lectores del trabajo de grado deben encontrar las fuentes de

información en forma fácil. Una manera común de citar es hacerlo secuencialmente por el

número de cada documento; cada uno se numera a medida que aparece en el texto. La

primera cita que se hace en el texto corresponde al documento uno, citado [1], la

segunda al documento [2] y, así sucesivamente. Además, para los trabajos de grado de

ingeniería se seguirá la forma [documento, página(s)], donde documento se refiere al

orden de los documentos citados según aparecen en el trabajo de grado y página(s) se

refiere a la página exacta dentro del documento específico de donde se extractó la cita.

Esa forma de hacerlo facilita el trabajo a los lectores, pues en un documento grande, un

libro, por ejemplo, es difícil encontrar la cita. Así, si el lector quiere constatar o profundizar

en la fuente, se le facilita el trabajo.

Los documentos referenciados aparecen al final del trabajo de grado en el orden

secuencial de citación. Por ejemplo, “todo el mundo se ama más a sí mismo que a su

prójimo” [1, 216].

La cita [1, 216] le dice al lector que la frase se encuentra en la página 216 del

documento consultado en primer lugar. Si el lector quiere saber más de esa fuente, debe

ir a la lista de documentos referenciados, donde el número 1, tendrá la siguiente

información.

Eurípides, Medea, Tragedias. Tomo I, primera edición. 1997, Madrid. Editorial

Gredos.

Page 168: Como Escribir Documentos Tecnicos de Ingenieria v13

Esta entrada en la lista de documentos citados dice que Eurípides es el autor, la

obra es Medea, está en las tragedias, en el primer tomo, primera edición e impreso en

España.

Toda referencia en el texto apunta en forma clara a la fuente específica en la lista

de trabajos citados. En este contexto se habla de documentación citada o referenciada a

pesar de que en otras partes se utiliza el término bibliografía, pero, dado que la fuente se

refiere a cualquier documento independientemente de la forma en que se halle -revistas,

manuales, CD-ROM, internet, etc.-, se requiere ser más exactos y por eso se habla de

documentación citada o referenciada.

Por lo tanto, la documentación citada en esta forma, [Doc., página(s)], simplifica el

proceso de elaboración del documento y aumenta la precisión referente a la información.

14.23.1 Citación de libros

Todos los documentos citados que aparecen en la documentación referenciada

deben tener toda la información necesaria para que el lector los pueda conseguir. Así un

libro contiene tres partes principales:

Nombre del autor, Título del libro e Información de publicación.

Donde:

• Nombre del autor: aparece primero el apellido, una coma, después los

nombres y termina en punto seguido.

Los apellidos y nombres del autor aparecen como se encuentran en la

página del libro, no en la cubierta; no se aceptan abreviaciones.

En general, se omiten los títulos, afiliaciones y grados de los autores.

• Título del libro: se registra el título del libro como aparece en la carátula,

incluyendo cualquier subtítulo.

El título se escribe en cursiva; la primera palabra comienza con mayúscula

inicial y las demás pueden ir en minúscula, a no ser que sean nombres

propios.

El título termina con un punto seguido.

• Información de publicación: en general se suministra el número de la

edición, la ciudad donde se publicó, el año de publicación, y la editorial.

Los datos se toman directamente del libro.

Page 169: Como Escribir Documentos Tecnicos de Ingenieria v13

La edición, la ciudad de publicación y el año de publicación se separan con

comas.

El año de publicación y la editorial se separan con punto seguido.

Existe información adicional que aparece en la página de derechos

reservados.

14.23.2 Citación de revistas

Cuando se trata de citar artículos de una revista, la información tiene el siguiente

orden:

Nombre del autor, Título del artículo e Información de publicación.

Donde:

• Nombre del autor: sigue los mismos principios utilizados en los libros.

• Título del artículo: va entre comillas. Sigue los demás principios indicados

para los libros.

• Información de publicación: después del nombre del artículo, sigue el

nombre de la revista, el número del volumen, el año de publicación, dos

puntos, las páginas inicial y final y se termina con punto aparte.

14.23.3 Citación de internet

Otra fuente común en los trabajos de grado es internet. En este caso la

información es la siguiente:

Nombre del autor, Año de publicación del documento, Título e Información de

publicación.

Donde:

• Nombre del autor: sigue los mismos principios de los libros.

• Año de publicación: va entre paréntesis.

• Título: sigue los mismos principios de los libros.

• Información de publicación: dirección electrónica completa entre paréntesis

triangulares, fecha de consulta y número de páginas del documento en esa

dirección.

Page 170: Como Escribir Documentos Tecnicos de Ingenieria v13

14.23.4 Citación de otras fuentes

Existe otra gran variedad de fuentes. Sin embargo, en los trabajos de grado las

más utilizadas son libros, revistas e internet. Para un mayor conocimiento sobre como citar

casos especiales u otras fuentes, se sugiere consultar el capítulo cuarto del MLA Handbook

(Gibaldi, 1999), Documentation: Preparing the List of Works Cited.

14.23.5 Documentación citada

La lista de documentos citados va al final del trabajo de grado. Desde el punto de

vista formal, es conveniente que el listado tenga sangría francesa, pues de esa forma es

más legible la información.

14.23.6 Anexos

Se agregan al final del trabajo de grado; después de la lista de documentos

citados. Está compuesto por manuales, formularios, gráficas, cuadros, estadísticas, etc. sin

análisis, que el autor considera importante presentar en su trabajo pero fuera del cuerpo o

contexto del mismo. Los anexos se citan dentro del contenido o cuerpo del trabajo.

Por otra parte, las entidades financiadoras solicitan que las hojas de vida de los

responsables del proyecto se incluyan en los anexos.

En este apartado se incluye también el documento tipo artículo de revista del

trabajo de grado.

Los anexos van numerados en letras mayúsculas.

Page 171: Como Escribir Documentos Tecnicos de Ingenieria v13

BIBLIOGRAFÍA

Ballesteros, S. D. (1994). Elementos primarios de medición para lazos de control flujo-nivel-

presión-temepratura. Bogotá: Universidad Javeriana. Camerano, R. (2004). Diseño y fabricación de una transmisión. Guía de onda - microcinta a 76

GHz. Bogotá: Universidad de los Andes. Cassany, Daniel. (1993). La cocina de la escritura. Barcelona: Anagrama S.A. Day, Robert A. (2003). Cómo escribir y publicar trabajos científicos. Organización Panamericana

de la Salud. Washington. Duplat, Alfredo. (2006). Sistema normativo del español. Bogotá: Javeriana. Eco, Umberto. (1996, XIX edición). Como se hace una tesis. Barcelona: Gedisa. Gibaldi, Joseph. (1999). MLA Handbook for Writers o Research Papers. New York: Modern

Language Association of America. Gómez-Martínez, J. L. (1992). Teoría del ensayo, versión digital

www.ensayistas.org/critica/ensayo/gomez/indice.htm. México: UNAM. Humanas, Escuela de Ciencias. (2002). Como escribir...ensayos de opinión. Guías 47b, 47c, 47d y

47e. Bogotá: Universidad del Rosario. Mackerle, J. Scientific papers, their publishing and presentations. Linköping, Suecia: Linköping

Institute of Technology. Michaelson, Herbert B. (1990). How to Write and Publish Engineering papers and Reports, tercera

edición. Orys Press. Montaigne, Michel de. (2007). Ensayos. Barcelona, Acantilado. RAE. (1970). Diccionario de la real Academia Española. Decimonovena edición. Madrid: Espasa

Calpe. RAE. (1999). Ortografía de la lengua española. Madrid: Espasa. Ramos MH, Ramos MF, Romero E. (2003). Como escribir un artículo de revisión. En Revista de

Postgrado de la VI Cátedra de Medicina, No. 126, Abril 2003: 1-3. http://med.unne.edu.ar/revista/revista126/como_esc_articulo.htm

Rendón Gallón, Álvaro (2007). Modelo de un equipo de investigación, Documento interno, Universidad del Cauca.

Rodríguez, L. (2004). Simulación de antenas de microcintas utilizando FDTD 3D. Bogotá: Universidad de los Andes.

Roselli Cock, Diego Andrés. (1992). Cómo dictar una conferencia. En: Med, Vol.2, No. 1 -31-38, junio de 1992.

Sackett DL, Haynes RB, Guyatt GH, Tugwell P. (1998) Epidemiología clínica. Ciencia básica para la medicina clínica. México. Editorial Médica Panamericana 1998: 2da edición: 369-375

Sampieri RH, Collado CF, Lucio PB. (1998). Metodología de la investigación. Segunda edición. México. McGraw-Hill Interamericana Editores, S.A., 23-54

Sistema Nacional de Indexación y Homologación de Revistas Especializadas de Ciencia,

Tecnología e Innovación (2008). http://scienti.colciencias.gov.co:8084/publindex/ Téllez Barón, Fabio et al. (2004). Investigación y desarrollo en ingenierías: cómo elaborar un

proyecto. Bogotá: Universidad El Bosque.

Page 172: Como Escribir Documentos Tecnicos de Ingenieria v13

Vancouver, N. d. (2004). Normas de Vancouver. Revista Española de Salud Pública,78, 2004:297:321.

Vásquez Rodríguez, F. (2005). Pregúntele al ensayista. Bogotá: Kimpres. Primera reimpresión. VISOR Enciclopedias Audiovisuales SA. (1999). Con el aval científico de la Universidad de

Salamanca. Visor E.A.S.A. Impreso en Argentina.

Page 173: Como Escribir Documentos Tecnicos de Ingenieria v13

ANEXO A

OBRAS DE REFERENCIA EN INGENIERÍA

A continuación se muestran algunas obras de referencia en ingeniería y áreas

afines, según los programas existentes en la Universidad El Bosque:

A.1. Ambiental

1) Ecology Abstracts. Bethesda: Cambridge Scientific Abstracts. En línea.

2) Environment Abstracts. New York: Environment Information Center. En línea.

3) Environment Periodicals Bibliography. Santa Barbara: Environmental Studies

Inst. En línea.

4) Pollution Abstracts. Bethesda: Cambridge Scientific Abstracts. En línea.

A.2. Biología

1) Biological Abstracts. Philadelphia: Biosis. En línea.

2) Biological and Agricultural Index. New York: Wilson. En línea.

A.3. Ciencia y tecnología

1) Applied Science and Technology Index. New York: Wilson. En línea.

2) Engineering Index. New York: Engineering Information. En línea.

3) General Science Index. New York: Wilson. En línea.

A.4. Electrónica y telecomunicaciones

1) IEEE. Institution of Electrical and Electronics Engineers. En línea.

2) UIT. Unión Internacional de Telecomunicaciones. Geneve: ITU. En línea.

A.5. Física

1) Physics Abstracts. Surrey: Institution of Electrical Engineers. En línea.

Page 174: Como Escribir Documentos Tecnicos de Ingenieria v13

A.6. Matemáticas

1) Mathematical Reviews. Providence: American Mathematical Society. En línea.

A.7. Medicina

1) Medline. Bethesda: US National Library of medicine. En línea.

A.8. Sistemas

1) ACM Guide to Computing Literature. New York: Ass. For Computing Machinery.

En línea.

2) Computer Abstracts. London: Technical Information. En línea.

3) Computer Literature Index. Phoenix: Applied Computer Research. En línea

Page 175: Como Escribir Documentos Tecnicos de Ingenieria v13

ANEXO B

SISTEMA INTERNACIONAL DE MEDIDAS Y SUS SÍMBOLOS

A continuación se muestran algunos de los términos y símbolos del sistema

internacional de medidas.

TÉRMINO ABREVIATURA O SÍMBOLO

Amper A

Caballo de vapor cv

Candela cd

Coulomb C

Desviación estándar DE

Electrocardiograma ECG

Electroencefalograma EEG

Energía cinética EC

Error estándar EE

Error estándar de la media EEM

Farad F

Gauss G

Grado Celsius

Gramo g

Gravedad g

Henry H

Hertz Hz

Hora h

Infrarrojo IR

Joule J

Kelvin K

Kilogramo Kg

Page 176: Como Escribir Documentos Tecnicos de Ingenieria v13

Litro l

Lumen lm

Lux lx

Metro m

Minuto min

Mol mol

Newton N

Ohm Ω

Pascal Pa

Probabilidad P

Radián rad

Resonancia magnética

nuclear RMN

Revoluciones por minuto rpm

Roentgen R

Segundo s

Semana sem

Siemens S

Tesla T

Tonelada t

Ultravioleta UV

Volt V

Vatio W

Weber Wb

Page 177: Como Escribir Documentos Tecnicos de Ingenieria v13

ANEXO C

A theoretical model of UHF propagation in urban environments

• Walfisch, J., Bertoni, H.L. , 1988. A theoretical model of UHF propagation in

urban environments. En IEEE Transactions on Antennas and Propagation, Vol. 36,

Issue 12, Dec., pp.1788 – 1796. ISSN: 0018-926X