Transcript Writing Engineering Reports

Escritura de Artículos en
Ingeniería
Purdue Writing Lab
Resumen
• Esta presentación cubrirá:
– Propósito y planificación del informe
– Formato y organización del informe
– Títulos y lenguaje
– Diseño visual
– Documentación de fuentes de información
– Retoques finales
Propósito del Informe
• Describir la investigación
– Explicar el problema o asunto estudiado
– Discutir el método de investigación
– Describir los datos recogidos
– Describir los resultados de la investigación
– Explicar las implicaciones
Propósito del Informe
• Informar a los lectores de los
resultados de investigación de manera
precisa, concisa y específica
– No deberían tener que leer el informe
completo para obtener los puntos esenciales
Planificación del Informe
• Antes de empezar a escribir
considera:
– Por qué escribes
– Qué esperas conseguir
– Para quién escribes
Estas consideraciones determinarán el contenido,
la organización, diseño textual y visual
de tú informe
Formato y Organización del Informe
• Los informes incluyen,
generalmente, estas secciones y
en este orden:
–
–
–
–
–
–
–
Resumen/Abstract
Introducción
Revisión de la literatura
Metodología
Resultados
Discusión
Conclusión
Formato y Organización del Informe
• Pero hay que ser conscientes de
que el orden es flexible y que
algunas secciones se pueden
combinar
– Algunas revistas combinan la introducción y
la revisión de la literatura
– Otras combinan los resultados y la discusión
de los mismos
Formato y Organización del Informe
• Resumen / Abstract
– Siempre al principio
– Microcosmos del informe completo – contiene
información clave de cada sección
• Contiene sólamente información esencial – ¡es
breve!
• Cubre los aspectos principales de la
investigación
• Suministra el problema a investigar y/o el
objetivo principal de la investigación
• Indica la metodología utilizada
• Presenta los principales resultados y las
conclusiones
Formato y Organización del Informe
• Introducción
– Explica el problema a investigar y su
contexto
• Explica la importancia del problema (¿Por qué es
importante? ¿Por qué se necesita más
información?)
• Explica las razones y los objetivos del estudio
• Explica los límites de la investigación realizada
Quieres que el lector comprenda completamente
el significado de la investigación
Formato y Organización del Informe
• Revisión de la literatura
– Resume y evalua la literatura que has
utilizado en tu estudio considerando:
• Cómo contribuye la literatura a tu área de
investigación
• Las fortalezas y debilidades de estudios anteriores
• Cómo la literatura informa tu propia investigación y
comprensión del problema a investigar
Formato y Organización del Informe
• Metodología
– Explica cómo se obtuvieron o generaron los
datos
– Explica cómo se analizaron los datos
– Supone que el lector comprende el material
• No incluye material explicativo
– Se escribe en tiempo pasado
Formato y Organización del Informe
• Resultados
– Representar visual y textualmente los
resultados de investigación
• Representacion visual de los resultados:
– Gráficas, tablas, diagramas,...
• Texto explicativo:
– El texto indica las partes más significativas de los
resultados de investigación
– Indica las tendencias y relaciones principales
– Resalta resultados esperados y no esperados
Formato y Organización del Informe
• Discusión
– Evalua y comenta los resultados de la
investigación
– Incluye:
• Explicación de los resultados
– Comentarios sobre resultados no esperados,
presentando hipótesis sobre los mismos
• Comparación con la literatura
– ¿Confirma tu investigación los resultados de estudios
previos? ¿Diverge respecto a los mismos?
• Explicación de cómo la información se puede
aplicar en un contexto más amplio
Formato y Organización del Informe
• Resumen
– Discute:
•
•
•
•
•
Qué se ha aprendido de la investigación
Qué queda por aprender
Debilidades y defectos del estudio
Fortalezas del estudio
Posibles aplicaciones del estudio (y cómo puede
usarse)
• Recomendaciones
Consideraciones Organizativas
• La audiencia, el propósito y el
contenido deben influir en la
organización y el formato de tu
informe
– Ejemplo: Tu profesor plantea instrucciones
específicas
• Considera cuidadosamente tu decisión
Títulos y Subtítulos
• Los títulos y subtítulos guian la atención del
lector
• Se pueden utilizar para mantener la pista de
las distintas partes del proyecto:
– Por ejemplo: “Fabricación de componentes,”
“Ensamblaje de componentes,” y “Comprobación”
• Deberían ser:
– Específicos y facilitadores
– Usados para romper el texto y trozos de información
– Usados para guiar la atención del lector
Títulos y Subtítulos
• Ejemplo de un título vago:
– “Uso de las tecnologías basadas en el
ordenador en ciertas aulas de ingeniería”
• Ejemplo de un título específico:
– “Uso de Matlab en el aula de ingenieros de
primer año”
Lenguaje y Vocabulario
• Los informes deberían ser fácilmente
acesibles
– Sé directo y conciso
– Utiliza términos simples, no jerga
– Frases cortas y simples (20 palabras máximo)
– Sé específico y no general
• Utiliza valores concretos, metáforas y símiles
Diseño Visual
• El diseño visual de un informe puede
contribuir al éxito o al fracaso en la
comunicación
• El diseño visual incluye :
– Utilización de gráficos, tablas, etc.
– Uso del espacio en blanco
Diseño Visual
• Gráficos:
– Se deben utilizar para ilustrar aspectos
específicos
– Se deben incorporar de forma natural con el
contenido y contexto del informe
– Debe ser explicado completamente en el
texto utilizando referencias tales como “La
Fig. 1 muestra…”
– Debe ser citado si se toma de otra fuente
Diseño Visual
• Gráficos
– ¡Los gráficos no hablan por sí mismos!
– Por eso, la información escrita explicativa
debe ir antes del gráfico.
Diseño Visual
• La disposición general debe centrar al
lector en información clave
– Utiliza el espacio en blanco para guiar la
atención del lector
• A través del uso de títulos, subtítulos y elementos
visuales
Documentación de fuentes
• Cita las fuentes siempre que cites,
parafrasees o resumas un trabajo que no es
tuyo propio.
• Las fuentes incluyen:
–
–
–
–
–
Libros
Artículos de revistas periódicas, revistas, o periódicos
Entrevistas
Actas de congresos
Conferencias
Documentación de fuentes
• Citar:
– Da muestras de tu credibilidad como
investigador
– Da reconocimiento adecuado a autores e
investigadores
– Te protege de acusaciones de plagio
Documentación de fuentes
• APA (American Psychological Association )
– De acuerdo con Jones (1998), el estilo APA
es un formato de referenciación difícil para
estudiantes que lo hacen por primera vez.
– APA es un formato de referenciación difícil
para estudiantes que lo hacen por primera
vez (Jones, 1998, p. 199).
• IEEE
– De acuerdo con Jones [1], el estilo IEEE es
un formato de referenciación difícil …
Documentación de fuentes
• APA (American Psychological Association )
– Autor, A. A., Autor, B. B., & Autor, C. C. (Año).
Título del artículo. Título de la revista,
número de volumen, páginas.
• Harlow, H. F. (1983). Fundamentals for preparing
psychology journal articles. Journal of
Comparative and Physiological Psychology, 55,
893-896.
– Autor, A. A., & Autor, B. B. (Fecha de
publicación). Título del documento. Fecha de
obteción mes, año, de (dirección Web)
http://Web.
Documentación de fuentes
•
IEEE
–
J. K. Autor, “Título del artículo,” Abrev. Título de
revista, vol. x, no. x, pp. xxx-xxx, Abrev. mes, año.
•
–
[1] R. E. Kalman, “New results in linear filtering and
prediction theory,” J. Basic Eng., ser. D, vol. 83, pp. 95108, Mar. 1961.
J. K. Autor. (año, mes, día). Título. Revista [Tipo de
medio]. Página si es posible. Disponible:
http://www.(URL)
•
A. Stuart, Ed. (1996, Dec. 3). Business in the wake
of the Web. WebMaster Mag. [Online]. Available:
http://www.cio.com/cgi-bin/gate2?~
Retoques finales
• Comprobación de valor práctico
– Haz que un colega lea tu informe para
comprobar la claridad, organización y diseño
visual
• Comprueba tus fuentes para citas
adecuadas
• Haz una prueba de lectura cuidadosa o
pide a alguien que la realice
Referencias
•
•
•
Purdue Writing Lab. (2007) Obtenido el 08 de mayo de 2007 de
http://owl.english.purdue.edu/owl/resource/647/01/
Asian Institute of Technology Language Center. (2008). Writing Up
Research Guidebook. Asian Institute of Technology. Obtenido 24 de abril
de 2008 de http://www.languages.ait.ac.th/el21open.htm
Halligan, N. (2008). A short course on writing technical reports. Technical
Writing. Obtenido 24 abril de 2008 de
http://sci.vu.edu.au/~nalin/ShortCourse%20by%20NancyHalligan.pdf