Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Pautas para Lograr Documentos Tecnicos de Calidad
Pautas para Lograr Documentos Tecnicos de Calidad
rcucos
DE cALIDAD
POR:
Profesor asociado.
Colaboradora:
CLARA INS HERRERA P.
Estudiante ingeniera mecnica.
Medelln, 1999.
TABLA DE CONTENIDO
Pgina
1.
INTRODUCCION
3.
TCNICO.
2
2
3
5.
I
8
I
9
11
11
11
13
13
4.3.2 Anexos.
14
4.3.3 Referencias.
15
4.3.4
16
Bibliografa.
17
17
5.2 EL ESTILO.
18
5.3 ILUSTRACIONES.
19
20
vensrn DEFrNrrvA.
6.1 Revrsrt DE Los BoRRADoRES.
21
22
7.
23
6. LA
PROYECTOS ESPECIFICOS.
21
23
8.
34
RECOMENDACIONES.
25
9. BrBLrocnari
36
ANEXO
38
lll
1.
INTRODUCCION
medio
donde a pesar de que las ideas del autor sean buenas e interesantes
muchas veces no.se logran transmitir de manera clara al lector resultando
al estudiante nicamente en la
parte de la forma, tal es el caso de las normas ICONTEC para la
numerosas publicaciones que apoyan
presentacin de informes tcnicos.
mayores
TCNICO.
correctamente; mientras
el mensaje
El primer paso en la
elaboracin
de un
consiguiente, debe ser considerar tanto al que escribe como al que lee.
En
externa del lector, el autor debe tratar de ponerse en los zapatos del lector
y pensar en la forma cmo ste recibir su documento.
escritura,
l.JJ
ag
E
E
sH
>--.l
8
m
Ho
HE
HE
4e
ttJ
r-ri
o
c
c)
C)
b
E
c
:9
(J
(!
E
L
o
.E
(u
L
=
(
L
o-
o
o
o
o
E
a
()
c
o
'6
C)
o
lJ.
3.
un
proyecto
de anlisis de
experimentos en
u.n
sistemas
o los
resultados
de
unos
biblioteca, ya que
de
especializadas y
la
o un
simple
Seccin de preliminares.
Cuerpo principal.
Seccin de complementarios.
todo.
El ttulo en s debe ser corto y tiene por objeto indicar el contenido del
informe tan precisamente como sea posible.
El resumen.
si
r-
a leer el documento
plan de desarrollo.
la
su
Justificar
la
determinada
por las
consecuencias tericas
desprendan de su desarrollo
y el inters por el
prcticas que se
carcter polmico o
de
10
r-
o nos gustara......
Quisiera..... Ojal.......
Tal
ve2......
lnvitamos
la
es
irrelevante, desactualizado
exagerado.
t
I
ni correcto.
mostrando
Esto
lgico
dndole
al lector la
secuencial.
definidas,
su
organizacin
es
principalmente
un proceso
de
el
I
I
el uso de ttulos y
subttulos
la
pregunta:
guias
Con estas seales se pueden terminar o comenzar algunas secciones del
4.3.1 Conclusiones.
su
salir
igual que
ni
1. Por consiguiente,
debe haber
un
debera
medida que
15
1.
CHRISTENSEN, Jeff
2.
3.
in
of a
Un libro.
SHIGLEY, Joseph
MISCHKAE,
las
Cuando el flujo del informe deba ser interrumpido por una explicacin
aparte o por una explicacin detallada puede ser apropiado el uso de un
pi de pgina. Lo mejor es mantener en un mnimo el nmero de pi de
4.3.4 Bibliografa.
el
'16
5.
5.1
un
un
buscan un
largas
el buen entendimiento
del
texto.
til. Se encuentran
ejemplos
donde los trminos tcnicos son usados ms para impresionar, que para
informar.
Las frases largas y complejas son muy difciles de organizar con claridad.
Puede ser mejor partir un extenso prrafo en frases pequeas; pero sin
exagerar ya que una secuencia de frases y prrafos cortos, puede ser una
buen diccionario debe estar al lado del escritor de tal forma que pueda
verificar la ortografa; por fortuna muchos de los procesadores de texto
tienen un diccionaiio incluido, pero cuidado no se confe de 1. Si existen
y utilcelo en todo el
5.2 EL ESTILO.
En general, la razn o el argumento para seleccionar el estilo de
la
lector.
que:
claro e informativo.
a lo largo de
los
canales de comunicacin.
5.3 ILUSTRACIONES.
Los lectores cientficos encuentran muy tiles las tablas, grficos y
dibujos, y a menudo pasan las pginas en pos de las ideas claves del
reporte, detenindose para examinar los diagramas. Otros lectores no
buscan informacin de esta manera y tratan de pasar los diagramas de
una manera muy superficial.
cortas.
suministrar
la documentacin
pertinente, describiendo
su
propsito,
leer. La informacin
descripcin
de la
estructura
de
documentacin
del
6.
LA VERSION DEFINITIVA.
algunas
6.1
pasar uno o dos das despus de terminar los borradores para proceder a
revisarlos; de esta manera se conseguir mayor imparcialidad. Tambin
se obtendrn beneficios de los comentarios recibidos tanto del director del
proyecto como de los colegas para lo cual ser necesario reservar el
tiempo suficiente en el cronograma de actividades.
Es una perdida de tiempo tratar de mejorar los detalles de estilo antes de
y frases estn en el
correcto
orden, que todos los puntos esenciales hayan sido incluidos y aquellos
superfluos descartados. Debe examinarse todo el material para darle un
21
orden lgico
preciso,
asegurarse tanto
su consistencia como
su
veracidad.
argumentada.
"r
citaciones
examinar su
clientelista
la
puntuacin?
La
colaboracin
de un colega o del
director
de
proyecto es
y pulidos, es usual
institucin.
22
la
grandes problemas.
7.
PROYECTOS ESPECIFICOS.
el captulo
4.
Las
un
4.
Resultados.
5.
6.
del texto y que le haga ms fcil y claro la lectura del mismo. Una
estructura general para el cuerpo principal de un proyecto de diseo
puede ser la siguiente:
1.
lntroduccin.
(Deteccin
de las necesidades
seccin de
preliminares)
2.
3.
4.
.Anlisis (criterios)
. Seleccin de alternativas.
5.
Diseo de detalle.
Planos y especificaciones.
.Anlisis econmico.
6.
Construccin.
7.
Evaluacin.
8.
y ameno.
ms claro
de
al
lector a continuar leyendo, por esta razn se debe elaborar con mucho
cuidado.
25
Las conclusiones son una parte muy importante del informe, ya que
muestra los resultados obtenidos y los evalua; adicionalmente se pueden
dar algunas recomendaciones.
estudiantes
de ingeniera mecnica de la
Universidad Nacional de
EJEMPLO #'1.
minerales"l.
Esta introduccin se puede considerar que tiene la forma tpica de ellas,
cumple las tres funciones definidas en el numeral 4.1.4 de una manera
t.
lo
lo
2. En vistq de
el
justif
icacin de
lo
necesidad planteodo.
Por qu sehizo?
I
I
metodolgico y
4. Es por ello
ensoyos,
son
extremodqmente limitodos, no
concluyentes y solomente pueden ser
considerqdos como un oporte ol
desorrollo de uno tecnologo en este
compo.
diseor
sec de unq copocidod oproximodo de
500lbs/hr, pqro tomqos de los rocqs
trturqdqs enlre 2" y
As como, el
costo de lq mguino no debe ser superior
ol 70% del vqlor de eguipos similqres
importodos.
i".
un
exogerodo desgoste
en
los
Este prrato
nuevomente
pero se realiza de
uno
formo ms
preciso,
especificndolo dentro de
ciertos pormetros.
iQu se hizo?- Objetivos?
presentondo olgunos
ontecedentes ol respecto.
Y se omplon los
pormetros poro el onlisis
de lo solucin.
Por qu sehizo?
7.
de
dicho
se
9. Finolmente,
mtodo
utilizodo.
y dimensionomiento.
EJEMPLO
#2.
animales2.
t RAMIREZ, Juan y PINEDA, Oscar Diseo de una mquina para el llenado automtico
de sacos por peso
28
1.
INTRODUCCIN
1.1
ANTECEDENTE5
t.?
1.3 JU5TIFICACIN
DEL DI5EO.
1.3.1
1.3.2
elevodo.
30
1.3.3
1.4.2
debe
Estudior, onalizor
los
31
1.5
^AETODO
1.6
'
de
de
2t67
peso indicodo.
33
4009r, es decir
t7"
del
8.
RECO^ENDACIONES FINALES
PARA EL AUTOR.
'
archivo
de ideas para ser usadas cuando
sea necesario. Haga hincapi
sobre
pensamientos rerevantes
inmediatamente stos se presenten
y
almacneros. No importa que
en esta etapa no se tenga
un orden rgico.
'
'
con
ra ayuda de un diagrama
o con una tabra preriminar de
contenido
'
de ras
de ra estructura der documento,
debe
'
'
fueren
necesarios.
clara y brevemente la
esencia del reporte' No olvide que el resumen
necesita una estructura
tanto o ms clara que el informe mismo.
'
o
o
rgicamente
consistente evidencia el equilibrio
mental der escritor; si la redaccin es
ilgica e incoherente, er documento
arroja dudas acerca de ra propia
capacidad de razonamiento del autor.
'
accin de revisin puede ser ejecutada muchas veces hasta que el autor
se sienta satisfecho. Esto es lo que se llama retoque.
las
no ser que tenga una buena cantidad de ideas "bien pensadas", con
algunos datos y resultados para comunicar y explicar.
9. BIBLIOGRAFA.
diseo
E. The project
of Aston, 1981 . 20p
AVISON, D.
University
36
I
o
BEDOYA,
Universidad Nacional de
PINEDA, Oscar
Colombia, 1998.
WARD, R.A. 100o/o Report writing a guide for graduates and students.
37
ANEXO
38
1.
I
En esta parte se muestran las tablas de contenido de dos proyectos
diferentes, el primero es una investigacin cientfica, y el segundo es un
proyecto de diseo que no tiene un orden muy estricto pero es lgico.
1.
INTRODUCCIN.
2.
MARGO CONCEPTUAL.
3.
4.
RESULTADOS.
5.
DTSCUSTN.
frente
al desgaste.
5.2 Mtodos experimentales desarrollados.
austemperada
39
6.
CONCLUSIONES.
ANEXOS.
1.
INTRODUCCIN.
2. GENERALIDADES.
2.1 Definicin de trituracin.
2.2Propiedades fsicas de los minerales.
2.3 Teoras de trituracn.
'^f$,ttJi',.".
7.
MEDICION PRCTICA
DE LA FUERZA
DE APLASTAMIENTO Y
REACCIONES EN EL MECANISMO.
7'1 Medicin prctica de la fuerza de compresin
en ra riostra de una trituradora
de capacidad equivalete.
7 '2 clculo de la fueza mxima
de aplastamiento para la condicin del
ensayo.
7'3 Estabrecimiento de ra fuerza m.xima
o rlri"mento requerida para ra
trituracin de un materiar de mxima dureza
;" ;;;;ina oe ensayo.
7 4 Determinacin de la fuerza mxima
de aplastamiento para la trituracin del
material ms comn en el medio (granito)
out'i.r"ool en la trituradora
v
a disear.
"r'r"r
7'5 Reacciones en
excntrico y
la riostra a partir de la fueza mxima
_en
de aplastamiento en,"1la".l"
maquina a disbnar.
COSTO DE LA IVIQUIruE.
I1. RECOMENDACIONES.
BIBLIOGRAFA.
ANEXOS.
NorA:
demasiado detailados
y no aportaban
41
informacin
a ra organizacin