Embed Size (px)
Citation preview
DR. RAFAEL SANDOVAL RODRÍGUEZDR. JAVIER VEGA PINEDA
AGOSTO 2009
REDACCIÓN DE DOCUMENTOS TÉCNICOS
INSTITUTO TECNOLÓGICO DE CHIHUAHUA
¿Qué es un documento técnico?
“La presentación sistemática de la evidencia y/o la información sobre una situación, problema o necesidad en el ámbito de la ciencia o la tecnología”*
*Australian Training Productos Ltd
El objetivo directo y fundamental de un documento técnico es “transmitir información”.
Antes de empezar a escribir debemos haber generado u obtenido esa información.
El deseo del lector por obtener la información es un aspecto deseable pero no indispensable.
¿Qué es un documento técnico?
Tipos de documentos técnicos
Documentos de especificaciones
Manual de usuarioEstudios de viabilidadArtículos de
divulgación o investigación: Revistas Congresos Talleres (Workshops) Seminarios
Propuestas de proyectos
Reportes técnicos Reportes de avance
de proyectosTesisLibrosCuadernos de
laboratorio
Consideraciones a tomar en cuenta
Los puntos clave y las conclusiones principales deben de estar muy accesibles.
Debe considerarse un resumen al principio del documento
Recordar que, “NO TODO EL MUNDO TIENE TIEMPO PARA LEER TODO EL
DOCUMENTO”
La necesidad de los documentos técnicos
Para asegurar la transmisión del conocimiento:Resultados del trabajo realizadoContinuación del proyecto
Es la primera forma de registro de la “autoría intelectual” de cualquier cosa
En la academia es un elemento muy importante en la evaluación profesional. -La cantidad y calidad de los documentos escritos-
Una anécdota:
Max Karl Ernst Ludwig Planck empleó un esfuerzo considerable (1875-1891) en su teoría sobre la entropía (antes de su teoría cuántica) porque Gibbs (que ya había hecho ese trabajo) lo escribió para un medio con muy poca divulgación.
Bryson 2004
La necesidad de los documentos técnicos
¿Para quién se escribe?
No se puede escribir para que todo el mundo lo entienda
Desde el principio hay que identificar los posibles (o deseables lectores)
¿Conocen el tema de forma general?¿Son expertos?¿Conocen el detalle del trabajo que se
describe?.....
La longitud del documento
¿10 páginas... o 100 páginas...?Un documento breve necesita más trabajo de planificación
Existen restricciones en longitud para algunos documentos: artículos (4, 6, 8 páginas, tesis, propuestas de proyecto –CONACYT, DGEST)
La estructura del documento
¿Existe un modelo “convencional” a seguir?
La estructura ‘convencional’
El índice (tabla de contenidos)Una estructura lógicaRecomendaciones generalmente aceptadas
Las secciones más comunesLos apéndices
El índice
Escribir un “índice” para el documento puede ser un buen momento para darle una estructura adecuada
Una buena estructura ahorrará mucho tiempo después
Puede llevarse unos cuántos díasSe debe reflejar el mayor nivel de detalle
posiblePuede modificarse después si es necesario
Una estructura adecuada
De lo general a lo particularPrimero los antecedentes y después el
material técnicoEl documento debe “llevar” al lector de
forma lógica a las conclusionesLa estructura del documento no siempre refleja la secuencia temporal de escritura: no es raro escribir la introducción al final, por ejemplo, porque ayuda a tener una mejor perspectiva del documento
Una estructura adecuada
Ideas generales
La primera sección importante es “la introducción”
En ella se plantean (explícitamente o no) las preguntas que se responderán en “las conclusiones”
Los “hechos” y las medidas se separan de las opiniones y las interpretaciones
Es muy frecuente referirse al trabajo realizado antes por otros autores
Las secciones, sub-secciones, apartados (y algunas veces los párrafos) se enumeran
Las secciones más comunes
Una página para el título (logos, autores, fecha, etc.)
Dedicatoria(s), completamente abierto a los sentimientos del autor
Declaraciones: Registros de propiedad (copyright), autenticidad,...
Agradecimientos, generalmente a los que ayudaron a que exista el documento (CONACYT, DGEST, asesores, etc.)
Índice
Resumen (Abstract):Un resumen del documento completo.250 a 350 palabras es una medida común que se utiliza en algunos documentos técnicos
Se utiliza en ocasiones como presentación del documento en otras publicaciones o en bases de datos
Las secciones más comunes
Introducción
Presenta el trabajo realizadoEstablece las motivaciones del trabajo y su contexto (relación con otros trabajos)
Plantea explícita o implícitamente, las preguntas que se van a resolver a lo largo del documento
Presenta, a grandes rasgos, el contenido del documento
El “cuerpo” principal del documento
En el cuerpo se presenta la mayor parte del material técnico
Teoría, hipótesis, método de trabajo, resultados, discusión de esos resultados
Tablas, figuras, circuitos, diagramas, ... que complementen la comunicación autor – lector
Se comparan hipótesis con resultados, se comentan opiniones y se especula con el alcance de los resultados del trabajo
Conclusiones
Presentan el resumen de los resultados principales y las conclusiones que de ellos pueden se pueden obtener
Deben deducirse del trabajo y resultados presentados en el cuerpo principal del documento
Su redacción debe ser muy cuidadosa. Con seguridad es la única parte del documento que la mayor parte de la gente leerá más de una vez (aparte del título)
Esta sección será decisiva en la impresión que el lector tenga del trabajo completo
Apéndices
Contienen información importante que obstaculizaría la lectura fluida en el cuerpo del documento
Parámetros, demostraciones matemáticas, extractos de normativas, planos, etc.
Listas de referencias
A lo largo de TODO el documento es IMPRESCINDIBLE referenciar el trabajo de “otros autores” sobre el que hemos construido el “propio”
Al final del documento se compilan, ordenadas de alguna forma, todas las referencias con los DATOS NECESARIOS para que el lector interesado pueda encontrarlas
El plagio no tiene justificaciónUna buena utilización de las referencias mejora
la credibilidad de nuestro trabajo
Referencias nuestras en nuestro documento
Para evitar repeticiones, frecuentemente es necesario referenciar material dentro del propio documento
Todo material susceptible de ser referenciado debe llevar un nombre inequívoco
Por este motivo se enumeran los capítulos, las secciones, las figuras, las ecuaciones, los teoremas, etc.
La forma
LenguajeFigurasTablasEcuaciones
El lenguaje
Suele escribirse en forma impersonal y con frases cortas
En inglés se usa frecuentemente la voz pasiva
Revisar la ortografía y la gramática con mucho cuidado
En inglés, por ejemplo, debe evitarse partir las palabras, porque es un tema difícil
Figuras, tablas y ecuaciones
TODAS las figuras deben enumerarse de forma consecutiva.
Cada figura debe llevar un pie que la expliqueLo mismo con TODAS las tablasLas figuras son excelentes para comparar
tendencias, dar mayor claridad a lo explicado en el texto, etc.
“Una imagen vale más que mil palabras”Las tablas sirven para comparaciones
numéricas más detalladas.
Las ecuaciones son concisas y dicen mucho en poco espacio. “No hay que tener miedo de usarlas”!!¿¿??
Las ecuaciones también se enumeran para futuras referencias
El texto llena el espacio entre ecuaciones, tablas y figuras. Es el hilo conductor de la información
Figuras, tablas y ecuaciones
Ventajas del modelo convencional de redacción
El lector sabrá qué esperar y dónde buscar las cosas
La estructura del documento es clara y fácil de entender
Al ser muy rígida, es más fácil para los escritores menos experimentados
Sin embargo, no siempre hay que incluir todas las secciones que se han descrito
Alternativas al modelo convencional
Si se describen distintos experimentos con un propósito común...podría ser conveniente explicar completamente cada uno de los experimentos por separado y agregar secciones comunes (Introducción, Comparaciones, etc.)
En ocasiones los nombres convencionales de las secciones (Introducción, Resultados...) se sustituyen por otros “Titulares”.
Abstracto --- Resumen --- Epítome
Otras alternativas
En ocasiones, es conveniente poner las conclusiones al principio. Así, seguro que se leen y el lector puede tenerlas en mente mientras sigue el resto del documento
En documentos dedicados a la revisión de procedimientos, por ejemplo, podría ser útil poner una sección para cada uno de ellos y algunas secciones comunes (comparaciones, diagrama global)
Tecnología
Procesadores de textoMicrosoft WordLatexOpenOffice.org Writer
Microsoft Word
WYSIWYG: What you see is what you get!!¿¿??WYSIWYWLTG: What you see is what you like
to get!!!Muy conocido y fácil de aprender los
elementos básicosDifícil de mantener las referencias cruzadas
dentro del documento o a la lista de referencias
El manejo de documentos largos es complicado
Latex
YCOGWYAGTG: You can only guess what you are going to get!! (ASCII con comandos como el HTML)
WCINAW!!: Who cares! is nice, anyway! (sobre todo las ecuaciones y las figuras)
Perfecto para manejar referencias cruzadas y la lista de referencias
Maneja perfectamente documentos largos (libros, tesis, ...)
Difícil de aprender pero gratisExisten versiones comerciales para PC
OpenOffice.org Writer
Un subconjunto de Microsoft WordMenos conocidoGratuito
Calidad en los documentos
El autor tiene el control del documentoEl documento debe revisarse antes de
ponerlo en circulaciónEl autor debería volver a leer el
documento tratando de olvidar quién lo ha escrito
TODOS los defectos de forma deben corregirse en este momento
Una revisión desinteresada
Es buena idea que alguien ajeno al grupo de autores lea y comente el documento
Esta práctica es particularmente importante si los autores escriben en una lengua distinta de la materna
El supervisor
El supervisor del equipo también tendrá responsabilidades en el documento final
Si se han limado otros defectos, puede concentrarse en hacer comentarios útiles sobre el contenido técnico
Si lo devuelve sin correcciones es que...¡no lo leyó!
Resumen y conclusiones
Hay que escribir para transmitir información “útil”
Aunque el lector puede leer, volver a leer, saltar a otra sección, volver atrás, etc., no hay que presumir que tiene mucho tiempo
Un buen documento hay que planearlo
Existe una “forma de escribir” aceptada en la comunidad científico-técnica Se plantea el problema y se pone en contexto Se describe el trabajo realizado y los resultados Se escriben las conclusiones
Hay que cuidar el fondo y las formasSeleccionar con cuidado el procesador de texto
que se va a utilizarEl control de calidad debe ser exhaustivo y
completo
Resumen y conclusiones
Referencia principal
Aurelio García Cerrada, Recomendaciones para la redacción de documentos técnicos, Dept. de Electrónica y Automática e Instituto de Investigación Tecnológica, ETS de Ingeniería, Univ. Pontificia Comillas de Madrid, Nov. 2007
