Escuela Tcnica Superior de Ingeniera Aurelio Garca Cerrada Escuela Tcnica Su erior de In!

eniera
1
18/03/10

RECOMENDACIONES PARA LA REDACCIN DE DOCUMENTOS TCNICOS Aurelio Garca Cerrada

Contenido
Preliminares. Tipos de documentos tcnicos Estructura en el modelo habitual Aspectos relacionados con la forma Alternativas al modelo habitual El procesador de texto Control de calidad Resumen

18/03/10

Preliminares
Consideraciones antes de ponerse a escribir

18/03/10

Qu es un documento tcnico?

La presentaci n sistem!tica de la evidencia "#o la informaci n sobre una situaci n$ problema o necesidad en el !mbito de la ciencia o la tecnolo%&a [Australian Training Products Ltd]

18/03/10

Qu es un documento tcnico? La misi n fundamental e inexcusable de un 'oc. Tec. es transmitir informaci n. Antes debemos haber %enerado(obtenido esa informaci n. El entretenimiento del lector )aun*ue deseable+ es un aspecto accesorio.

18/03/10

Qu es un documento tcnico? ,a" muchos tipos de 'oc.Tec. 'ocumento de especificaciones .anuales de usuario C di%o para ordenador Estudios de viabilidad Art&culos )divul%aci n o investi%aci n+ Propuestas /fertas Tesis$ libros$ etc.

18/03/10

Muchos documentos y poco tiempo

Los puntos clave " las conclusiones principales tienen *ue estar mu" accesibles 'ebe considerarse un resumen al principio 0o todo el mundo tiene tiempo para leer todo el documento

18/03/10

Por qu hay que escribir documentos tcnicos?

Para ase%urar la transmisi n del conocimiento )continuaci n del pro"ecto$ avances tecnol %icos$ etc.+ Es la primera forma de re%istro de la autor&a intelectual de cual*uier cosa En al%unas profesiones es una forma mu" aceptada de evaluaci n

18/03/10

Por qu hay que escribir documentos tcnicos?

Una ancdota: 1Plan2 empleo un esfuer3o considerable )4567(4584+ en su teor&a sobre la entrop&a )antes de su teor&a cu!ntica+ por*ue 9ibbs )*ue "a hab&a hecho ese traba:o+ lo escribi para un medio con poca divul%aci n; ( r!son" #$$%&

18/03/10

Para quin se escribe?

0o se puede escribir para *ue todo el mundo lo entienda 'esde el principio ha" *ue identificar los posibles )o deseables+ lectores <Conocen el tema de forma %eneral=. <>on expertos=. <Conocen el detalle del traba:o *ue se describe=$ <s lo un poco= ?

10

18/03/10

La longitud prevista para el doc.

<@A P!%s.. o @AA P!%s..= Bn documento corto necesita m!s traba:o de planificaci n Al%unos tipos de documentos tienen una lon%itud m!xima establecida )art&culos$ tesis$ pro"ectos fin de carrera$ ?+ Caltasar 9raci!n- Lo bueno si breve ?

11

18/03/10

La estructura del documento

El modelo convencional es el m!s se%uro para los escritores noveles

12

18/03/10

La estructura
El &ndice )tabla de contenidos+ Bna estructura l %ica Recomendaciones %eneralmente aceptadas Las secciones m!s comunes Los apndices

13

18/03/10

El ndice
Escribir un &ndice para el documento puede ser un buen momento para darle una estructura adecuada Bna buena estructura ahorrar! mucho tiempo despus Puede llevar unos cuantos d&as >e debe refle:ar el ma"or nivel de detalle posible Puede modificarse despus si es necesario

14

18/03/10

na estructura adecuada
'e lo %eneral a lo particular Primero los antecedentes " despus el material tcnico El documento debe llevar al lector de forma l %ica a las conclusiones La estructura del doc. no refle:a la secuencia temporal de escritura 0o es raro escribir la introducci n al final. A"uda a tener una me:or perspectiva del documento
15
18/03/10

na estructura adecuada
In"roducci#n An"eceden"es$ con"e%"o De"alles "cnicos Resul"ados

Discusi#n & Conclusiones

16

18/03/10

!ecomendaciones generales
La primera secci n seria es la introducci n En ella se plantean )expl&citamente o no+ las pre%untas *ue se responder!n en las conclusiones Los hechos " las medidas se separan de las opiniones " las interpretaciones Es frecuente referirse al traba:o hecho por otros antes Las secciones$ sub(secciones$ apartados )" al%unas veces los p!rrafos+ se numeran

17

18/03/10

Las secciones m"s comunes

Una pgina para el ttulo )lo%o$ autores$ fecha$ etc.+ Una dedicatoria )al%unas veces podemos ser sentimentales+ Una declaracin )cop"ri%ht$ autenticidad$ ?+ Agradecimientos )a todos a*uellos *ue han a"udado sin participar en el documento+ ndice

18

18/03/10

M"s secciones tpicas

Resumen (A'stract&:
Resume el documento completo. DAA palabras es una medida *ue suele usarse$ por e:emplo$ en art&culos tcnicos. Al%unas veces es susceptible de publicarse como presentaci n del documento o como reclamo.

19

18/03/10

#ntroducci$n
Presenta el traba:o reali3ado Establece las motivaciones del traba:o " su contexto )relaci n con otros traba:os+ Plantea$ expl&cita o impl&citamente$ las pre%untas *ue se van a resolver a lo lar%o del documento Presenta$ a %randes ras%os$ el contenido del documento

20

18/03/10

El %cuerpo& principal del documento

A*u& se presenta la ma"or parte del material tcnico Teor&a$ hip tesis$ mtodo de traba:o$ resultados$ discusi n de esos resultados A*u& se pondr!n las tablas$ las fi%uras$ los circuitos$ ?. para facilitar la comunicaci n >e comparan hip tesis con resultados$ se comentan opiniones " se especula con el alcance de los resultados del traba:o

21

18/03/10

'onclusiones
Presentan el resumen de los principales resultados " las conclusiones *ue de ellos pueden sacarse 'eben deducirse del traba:o " resultados presentados en el cuerpo principal del documento. 'ebe cuidarse su redacci n. Probablemente es la Enica parte del documento *ue la ma"or parte de la %ente leer! m!s de una ve3 Esta secci n ser! decisiva en la impresi n *ue el lector ten%a del traba:o completo

22

18/03/10

(pndices
Contienen cosas importantes *ue obstaculi3ar&an la lectura fluida del resto del documento. Par!metros$ demostraciones matem!ticas$ extracto de normativas aplicables$ planos detallados$ etc. 0o se recomienda para ho:as de caracter&sticas

23

18/03/10

Lista de re)erencias
Durante TODO el documento es imprescindible referenciar el traba:o de otros sobre el *ue hemos construido el nuestro Al final se recogen, ordenadas de al%una forma$ todas esas referencias con los datos necesarios para *ue el lector interesado pueda encontrarlas El plagio es inaceptable pero, adems, Bna buena utili3aci n de las referencias me:ora la credibilidad de nuestro traba:o El receptor final del documento puede tener normas explicitas sobre c mo se hacen las referencias a traba:os anteriores
18/03/10

24

!e)erencias dentro de nuestro documento

Para evitar repeticiones$ frecuentemente es necesario referenciar material dentro del propio documento Todo material susceptible de ser referenciado debe llevar un nombre ine*u&voco Por ese motivo se numeran los cap&tulos$ las secciones$ las fi%uras$ las tablas$ las ecuaciones$ los teoremas$ etc.

25

18/03/10

Otras cuestiones
La (or)a ta)'in es i)portante

26

18/03/10

El lengua*e
>uele escribirse en forma impersonal " con frases cortas En Fn%ls se usa frecuentemente la vo3 pasiva )" s lo a*u&+ >e revisa la orto%raf&a " la %ram!tica concien3udamente En Fn%ls$ por e:emplo$ debe evitarse partir las palabras$ por*ue es un tema dif&cil

27

18/03/10

+iguras, tablas y ecuaciones #

T/'A> las fi%uras deben numerarse de forma consecutiva. Cada fi%ura debe llevar un pie explicativo Lo mismo con T/'A> las tablas Las fi%uras son excelentes para comparar tendencias$ dar la visi n %eneral de la or%ani3aci n de las partes$ etc. Las tablas sirven para comparaciones numricas m!s detalladas

28

18/03/10

+iguras, tablas y ecuaciones ##

Las ecuaciones son concisas " dicen mucho en poco terreno. 0o ha" *ue tener miedo de usarlas Las ecuaciones tambin se numeran para futuras referencias El texto llena el espacio entre ecuaciones$ tablas " fi%uras. Es el hilo conductor de la informaci n

29

18/03/10

-enta*as del modelo habitual

El lector sabr! *u esperar " d nde buscar las cosas La estructura del documento es clara " f!cil de entender Al ser mu" r&%ida$ es m!s f!cil para los escritores menos experimentados 0o siempre ha" *ue incluir todas las secciones *ue se han descrito

30

18/03/10

(lternativas al modelo habitual

>i se describen distintos experimentos con un prop sito comEn ? podr&a ser conveniente explicar completamente cada experimento por separado " aGadir secciones comunes )Fntroducci n$ Comparaciones$ etc.+ A veces los nombres convencionales de las secciones )Fntroducci n$ Resultados ..+ se sustitu"en por Titulares. El lector sabr! de *u va el informe " los resultados le"endo el &ndice.

31

18/03/10

M"s alternativas
En ocasiones$ es conveniente poner las conclusiones al principio. As&$ se%uro *ue se leen " el lector puede tenerlas en mente mientras si%ue el resto del documento. En documentos dedicados a la revisi n de procedimientos$ por e:emplo$ podr&a ser Etil poner una secci n para cada uno de ellos " al%unas secciones comunes )Fntroducci n " Comparaci n$ por e:emplo+

32

18/03/10

Procesadores de te.to
Pueden )encionarse dos )u! populares: *icroso(t +ord Late,

33

18/03/10

Microso)t /ord
HI>FHI9=- Hhat "ou see is Jhat "ou %et= HI>FHIHLT9K- Hhat "ou see is Jhat "ou Jould li2e to %etK L!cil de aprender r!pidamente 'if&cil para mantener las referencias cru3adas dentro del documento o a la lista de referencias El mane:o de documentos lar%os es complicado

34

18/03/10

Late.
IC/9HIA9T9K- Iou can onl" %uess Jhat "ou are %oin% to %etK )A>CFF con comandos como el ,T.L+ HCF0AHK- Hho caresK itMs nice$ an"Ja"K )sobre todo las ecuaciones " las fi%uras+ Es perfecto para mane:ar referencias cru3adas " la lista de referencias .ane:a perfectamente documentos lar%os )libros$ tesis$ ?+ 'if&cil de aprender pero es %ratis

35

18/03/10

Finalmente

El control de calidad

36

18/03/10

'ontrol por el autor

El documento debe revisarse antes de ponerlo en circulaci n El autor deber&a volver a leer el documento tratando de olvidar *uin lo ha escrito T/'/> los defectos de forma deben corre%irse en este momento

37

18/03/10

n amigo desinteresado
Es buena idea *ue al%uien a:eno al %rupo de autores lea " comente el documento Este paso es particularmente importante si los autores escriben en una len%ua distinta de la materna

38

18/03/10

El supervisor
El supervisor del e*uipo tambin tendr! responsabilidades en el documento final >i se han limado otros defectos$ puede concentrarse en hacer comentarios Etiles sobre el contenido tcnico N>i lo devuelve sin correcciones es *ue ? no se lo ha le&doK Al%unos lle%ar!n a ser supervisores al%En d&a " podr&an no necesitar estas recomendaciones

39

18/03/10

!esumen y conclusiones
,a" *ue escribir para transmitir informaci n Aun*ue el lector puede leer$ volver a leer$ saltar a otra secci n$ volver atr!s$ etc.$ no ha" *ue presumir *ue tiene mucho tiempo Bn buen documento ha" *ue planearlo

40

18/03/10

!esumen y conclusiones 0cont.1

,a" una forma de escribir aceptada en la comunidad cient&fico(tcnica
>e plantea el problema " se pone en contexto >e describe el traba:o reali3ado " los resultados >e escriben las conclusiones

,a" *ue cuidar el fondo " las formas Fncluso debe esco%erse con cuidado el procesador de texto *ue se va a utili3ar El control de calidad debe ser exhaustivo " completo

41

18/03/10

!e)erencias 0#1
Australian Training Products Ltd- ./riting tec0nical docu)ents 1CS$234- 25560ttp:77+++-atpl-net-au7sa)ple7pd(7atpsa)ple8#699-pd( oone" :- .;o+ to +rite a report4- Sun *icros!ste)s U:- 0ttp:77+++-<e=in'oone-co)70o+to8report-0t)l r!son" - A S0ort ;istor! o( 1earl! E=er!t0ing- A lac< S+an 'oo<- #$$% Li" >-?-:- .;ints on +riting tec0nical papers and )a<ing presentations4 IEEE Transactions on Education" =ol- %#" no- #" *a! 2555" pp-2@%A2@3 1onas0 Uni=ersit! (Language and learning onAline& ./riting tec0nical reports40ttp:77+++-)onas0-edu-au7lls7llonline7+riting7engineeri ng7tec0nicalAreport7inde,-,)l

42

18/03/10

!e)erencias ##
Ba)Cn ! CaDal" S- Beglas ! ConseDos So're In=estigaciCn Cient(ica- ColecciCn Austral" Espasa Calpe" Ed- 2@E 2559 Bing+ood" F- .;ints on tec0nical report +riting4- Sc0ool o( Electronic Engineering- Gu'lin Cit! Uni=-" 2555 0ttp:77odtl-dcu-ie7+p725557odtlA2555A$@-0t)l-

43

18/03/10

El escritor pro)esional
Technical author trainin% and report(Jritin% courses
Iou can earn 67AOP per Jee2 as a freelance technical authorK

)http-##JJJ.estontr%.com#+

44

18/03/10