documentación técnica -...
TRANSCRIPT
Documentación Técnica
DOCUMENTACIÓN TÉCNICA
1
Sesión No. 3
Nombre: Introducción. Parte III. Objetivo: al finalizar la sesión, el estudiante conocerá las distintas formas de
categorizar los documentos técnicos, al conocer sus características y para
redactar el documento que se requiera de acuerdo a la situación en la que se
encuentre.
Contextualización
Volvamos al dilema del taco-quesadilla-gringa; esencialmente son iguales,
categóricamente diferentes. Gran parte de nuestro avance como humanidad
depende de la manera en que categorizamos las cosas a nuestro alrededor:
planta venenosa, planta comestible; risco peligroso, planicie segura. Aquí lo que
debemos de tener claro es que las clasificaciones sólo existen en nuestro
imaginario como especie para asegurar nuestra supervivencia, no están
impuestas por la naturaleza.
Por tanto, estas clasificaciones de documentos según su objetivo, construcción o
forma es sólo eso, una clasificación. Durante esta sesión hablaremos de las
distintas formas de esquematizar información y cómo de esta manera se pueden
categorizar los distintos documentos técnicos. Los dividiremos en subcategorías
de acuerdo al objetivo con el que son escritos, a la construcción que tienen y su
forma de distribución.
DOCUMENTACIÓN TÉCNICA
2
Introducción al tema
Hay distintas formas de categorizar los elementos. Ya en la sesión pasada lo
hicimos de acuerdo al tipo de documentos técnicos que se trata. Ahora los
clasificaremos de acuerdo a tres definiciones: su objetivo, su composición y su forma de distribución. La finalidad es que conozcas todas las formas en las
que pueden categorizarse los documentos técnicos y sepas cual utilizar cuando
te pidan algo en tu futuro trabajo.
Es posible hacer tantas mezclas según las clasificaciones que veremos en esta
sesión como las que tu imaginación te permita; puedes hacer un manual
descriptivo con imágenes, impreso o un reporte argumentativo interactivo que se
leerá de manera digital.
El cielo es el límite… ¡Disfruta la sesión!
DOCUMENTACIÓN TÉCNICA
3
Explicación
1.4. Tipos de documentos por su objetivo (textos descriptivos, narrativos, argumentativos, científicos)
De acuerdo con su objetivo, los textos pueden dividirse en:
Argumentativos,
Científicos,
Descriptivos
Narrativos.
Narramos si queremos contar hechos o sucesos; describimos si queremos
mostrar cómo es algo o su funcionamiento; si lo que queremos hacer es
convencer a alguien o provocar su atención, argumentamos; el texto científico
incluye todos los demás para probar una tesis.
Nos alejaremos del orden alfabético, e iremos describiendo uno a uno de los
tipos de documentos de acuerdo con su nivel de complejidad.
DOCUMENTACIÓN TÉCNICA
4
Fuente: http://thestocks.im/
Descriptivos: Siendo redundantes, el texto descriptivo describe. Describir
es dibujar, representar en forma animada, y viva las cosas que percibimos.
Se describe lo material como lo espiritual; tanto el mundo físico, como el
psíquico.
Podemos considerar que existen dos tipos de descripción: la técnica o
instructiva –cuyo fin es dar a conocer un objeto- y la literaria –que busca
provocar una impresión o un sentimiento mostrando de manera que cause
la impresión o el sentimiento que se proponga.
El proceso descriptivo cuenta con tres partes: observación, reflexión y
presentación.
1. Observación: La observación es la condición previa de la
observación. Sólo conociendo algo previo a su explicación es
posible describirlo de manera correcta. Hay que tener en cuenta
que la observación implica el ejercicio de los cinco sentidos
corporales. Una buena descripción del mar no sólo contiene su
color, sino también su aroma, temperatura y salado sabor.
2. Reflexión: Una vez que se han observado y diseccionado las
distintas características del objeto se tiene que analizar, valorar y
seleccionar lo que se incluirá en la descripción.
3. Presentación: La redacción utilizando las expresiones exactas.
Para lograr una buen texto descriptivo se debe de captar la atención
desde la primera línea y procurar ser vivo, sucinto, rápido y claro.
Narrativos: En los textos narrativos se narra una acción. Narrar es contar,
ordenados en el tiempo, una serie de hechos o situaciones. El lenguaje
debe de tener claridad, dinamismo naturalidad, sencillez y emotividad.
DOCUMENTACIÓN TÉCNICA
5
A diferencia de la descripción, la narración intenta averiguar o conocer,
además de las acciones, sus causas morales, los sentimientos y lo que
impulsa a actuar. La descripción es a una foto lo que la narración a una
película.
La narración consta de acción, circunstancias de lugar y tiempo, causas o
móviles de los hechos, modo o manera de ejecución y resultado de tales
hechos. Al igual que en todos los textos la claridad es un aspecto
importante a recalcar, aunándole que debe de seguir una secuencia
lógica para lograr la unidad interna.
Argumentativo: Los textos argumentativos tienen como propósito central
convencer, persuadir al público o lector para que adopte cierta doctrina o
asuma cierta actitud. A fin de llegar a este propósito, se basa en análisis
de los hechos a través de un razonamiento lógico.
Científico: En un texto científico se incluyen todos los tipos de
documentos mencionados previamente. El científico hace uso de la
narración para exponer los trabajos realizados en un experimento –y a su
vez la narración utiliza la descripción- de la manera más objetiva posible.
Dependiendo del estudio, una vez terminada la investigación puede hacer
propuestas que deben estar justificadas de manera argumentativa para
convencer al lector de su propuesta.
1.5 Tipos de documentos por su construcción (con o sin ilustraciones)
Los documentos también pueden ser divididos según los elementos en los que
estén constituidos. Aquí se pueden dividir entre los que cuentan con imágenes y
los que no.
Esta división parece sencilla, sin embargo ¿en qué lugar posicionarías a los
comics o las novelas gráficas? En estos documentos tanto las imágenes como
las palabras –en algunos casos incluso las tipografías- transmiten ideas y
emociones.
DOCUMENTACIÓN TÉCNICA
6
Extracto de la novela gráfica Agujero negro de Charles Burns. Fuente: http://ep00.epimg.net/diario/imagenes/2007/02/03/babelia/1170465133_740215_0000000000_noticia_normal.jpg
1.6 Tipos de documentos por su forma de distribución (impresa, en monitor, en pantalla)
Podría pensarse que las únicas formas de dividir la distribución de documentos
técnicos serían la impresa y la digital; sin embargo, la distribución digital debe de
subdividirse en computadoras y dispositivos móviles.
La distribución impresa de documentos digitales sigue estando vigente en
muchas empresas. Se trata de documentos físicos, almacenados en algún
espacio delimitado que permita la posibilidad de consulta. Pueden ser manuales,
DOCUMENTACIÓN TÉCNICA
7
informes, proyectos y demás. Lo principal, al crear uno, es fijarse en la calidad
de impresión –hojas, tintas y encuadernación- así como el lugar donde se
resguardarán.
Fuente: http://thestocks.im/
Existe un debate respecto a la diferencia de usar pantallas a usar papel en
cuanto a la transmisión de la información. De acuerdo a diversos estudios
citados por Jabr (2013) en su artículo “El cerebro lector en la era digital: la
ciencia del papel contra las pantallas” –en inglés The Reading Brain in the Digital
Age: The Science of Paper versus Screens- el acercamiento que el cerebro tiene
a la información y su relación con la memoria a largo plazo y comprensión se ve
privilegiada en el papel. Dentro del artículo de Jabr, la psicóloga y científica
Maryanne Wolf sostiene que «existe un componente físico en la lectura. Tal vez
más de la que queramos pensar mientras nos introducimos a la lectura digital».
Los documentos impresos tienen una topografía más obvia que el texto de una
pantalla: la página izquierda y derecha, ocho esquinas con las cuales orientarse,
la profundidad del libro que permite saber cuánto se ha avanzado en la lectura y
lo que falta. El proceso mental que implica dar la vuelta la página de un libro es
similar a dar un paso en un paseo; hay ritmo y el trecho recorrido es visible. Esta
posibilidad no existe en el formato digital.
DOCUMENTACIÓN TÉCNICA
8
Sin embargo, citando de nuevo a Wolf: «Hay que preservar lo mejor de las
antiguas formas, pero saber cuándo utilizar las nuevas». Desplazarse en una
pantalla en el movimiento denominado en inglés como scroll permite
posibilidades inexistentes en el papel. Tristemente, la mayoría de los ejemplos
que mejor se adaptan a este uso tecnológico están en inglés. Los sitios web de
New York Times, Washington Post y ESPN han creado artículos altamente
visuales que dependen por completo del scroll para narrar la historia. Un
excelente ejemplo de este sería la historia de la avalancha que sucedió en
Tunnel Creek en 2012 y que es bellamente narrada en este artículo de New York
Times. Ahora que conocemos las posibilidades que ofrece la distribución de
documentos de forma virtual, debemos ver las diferencias existentes entre la
distribución por monitor o por pantalla.
Las reglas que rigen a las computadoras y sus monitores no son las mismas que
aplican para los dispositivos móviles y sus pantallas. Resulta importante recalcar
la diferencia ya que, según cifras de Iabméxico el 84% de los mexicanos utilizan
algún dispositivo móvil. Omitir el considerar esto al momento de decidir el medio
de distribución de la información sería una falta grave. Es posible visualizar
páginas web en una multitud de tipos de dispositivos y cada uno cuenta con
características particulares: tamaño, resolución, potencia de CPU, capacidad de
memoria. Buscar homogeneizar el diseño y que este tenga una visualización
adecuada en cada dispositivo es la apuesta que el diseñador Ethan Marcotte
(2010) tiene a través del Diseño Web Adaptable -o RWD por sus siglas en inglés
de Responsive Web Design-.Lo que propone el RWD es escribir en lenguaje
CSS3 un estilo donde los sitios webs respondan a los tamaños, resoluciones y
potencias de los distintos dispositivos proponiendo lo que se adaptaría para una
mejor lectura.
DOCUMENTACIÓN TÉCNICA
9
Conclusión
Como puedes ver, las distintas formas de categorizar los tipos de documentos
técnicos permiten una rica comprensión de todas las posibilidades existentes.
Todos los elementos, desde la aparente simplicidad de un texto descriptivo hasta
la incorporación de todos los tipos de texto en un texto científico, la aparición o
ausencia de imágenes y el formato en que se presentará la información
generarán cierto impacto en los lectores. Es por esto que es necesario tomar
estos factores en cuenta antes de iniciar a escribir.
Ahora que ya vislumbramos las posibilidades de lo que se puede hacer, no
queda más que poner manos a la obra y comenzar a escribir. Prepárate, ya que
en las siguientes sesiones estaremos realizando ejercicios escriturales.
DOCUMENTACIÓN TÉCNICA
10
Para aprender más
Aquí te presento un sitio web donde podrás profundizar acerca de los tipos de
texto de acuerdo a su objetivo.
• librosvivos.net. Página disponible en:
http://www.librosvivos.net/smtc/PagPorFormulario.asp?idIdioma=ES&Tem
aClave=1047&est=0
¿Te interesó el RWD? ¿Quieres saber más al respecto? Te presento a
continuación una traducción del texto de Ethan Marcotte para el sitio web A List
Appart:
• Marcotte, E. (s/f). Diseño Web Responsivo. Disponible en:
http://xn--diseowebresponsive-
q0b.org/?utm_source=redirects&utm_medium=dise%25C3%25B1owebres
ponsivo.com.ar&utm_campaign=301_Redirects
DOCUMENTACIÓN TÉCNICA
11
Actividad de aprendizaje
Instrucciones:
Con la finalidad de profundizar en los conocimientos adquiridos a lo largo de esta
sesión, ahora tendrás que realizar una actividad que se divide en tres partes:
1. Para la primera, tenemos que aceptar el hecho que no hay forma de
aprender a escribir más que en gerundio, así que tendrás que escribir un
párrafo descriptivo, dos párrafos narrativos y tres párrafos argumentativos
de los temas que decidas. Puede ser el mismo tema en los tres ejemplos
o uno distinto para cada uno. Recuerda bien las características de cada
uno, ya que con base a estas serás calificado.
2. Para la segunda parte de esta actividad de aprendizaje, tendrás que
buscar ejemplos de los documentos según su construcción y según su
distribución. En total, serán cinco ejemplos. Realiza un print-screen, toma
una foto, escanea un artículo; la decisión es tuya. Te recomiendo ir
eligiendo un tema central para todas tus tareas, ya que estás te servirán
para ir armando el documento que entregarás como trabajo final.
3. Por último, realiza una pequeña reflexión respondiendo a la pregunta
¿prefiero usar papel o pantalla para leer y escribir?
Puedes realizarlo en cualquier programa, al final tendrás que guardarlo todo
dentro de un documento en formato PDF, y entregarlo de acuerdo a las
indicaciones de tu profesor.
DOCUMENTACIÓN TÉCNICA
12
Esta actividad representa el 5% de tu calificación y se tomará en cuenta lo
siguiente:
Tus datos generales.
Creatividad.
Ortografía y redacción.
Título.
Presentación homogeneizada.
En la primera parte, se hará particular énfasis en la calidad de los escritos.
Cumplir con todos los ejemplos solicitados.
DOCUMENTACIÓN TÉCNICA
13
Bibliografía
Mendoza, J. A. & López, A. (1982). Taller de lectura y redacción 2. México:
Compañía Editorial Continental.
Sánchez, M. de la P. C. et al. (2001). Taller de lectura y redacción. México:
Compañía Editorial Nueva Imagen.
Cibergrafía
IABMexico (s/f). Segunda edición de la Infografía sobre los usos y hábitos de
dispositivos móviles en México. Recuperado el 9 de julio de 2015 en:
http://iabmexico.com/Infografias/estudio-usos-y-habitos-dispositivos-moviles.html
Jabr, F. (2013). The Reading Brain in the Digital Age: The Science of Paper
versus Screens. Recuperado el 9 de julio de 2015, de:
http://www.scientificamerican.com/article/reading-paper-screens/
librosvivos.net. Página disponible en:
http://www.librosvivos.net/smtc/PagPorFormulario.asp?idIdioma=ES&TemaClave
=1047&est=0
Marcotte, E. (2010). Diseño Web Responsivo. Disponible en
http://xn--diseowebresponsive-
q0b.org/?utm_source=redirects&utm_medium=dise%25C3%25B1owebresponsiv
o.com.ar&utm_campaign=301_Redirects