DOCUMENTACIN TCNICA

Documentacin Tcnica

1

Sesin No. 1 Nombre: Conceptualizacin de documentacin tcnica

Contextualizacin

Probablemente debas escribir en tus actividades cotidianas, ya sea al redactar

un correo electrnico, un recado, una gua o hasta un manual de usuario o un

reporte. La comunicacin escrita es fundamental en gran parte de las actividades

de la gente, especialmente en las laborales.

En esta sesin sabrs qu es un documento tcnico, qu caractersticas debe

tener un documento de calidad para que cumpla con su objetivo y qu ventajas

tiene el uso de la metodologa que ofrece este curso.

Documentacin Tcnica

2

Introduccin al Tema

Los documentos tcnicos pueden dividirse segn su estilo, forma de

presentacin y de distribucin, adems cuentan con una estructura en particular

y cumplen una serie de principios, de tcnicas para mapear la informacin,

para estructurar bloques de informacin, para etiquetarlos, para ilustrarlos y para

utilizar la tipografa, por supuesto, tambin deben seguir las reglas de escritura,

como las ortogrficas y el uso correcto de la sintaxis.

Para realizar un documento tcnico de calidad, adems de tomar en cuenta sus

fundamentos, se requiere de una planeacin cuidadosa, en la que se analice la

pertinencia de elaborar el documento, adems de cmo, cundo y en qu

programa realizarlo.

No cualquier documento, aun siendo un manual, un reporte o un apunte, es un

documento tcnico eficiente si no cumple con los principios y reglas precisas que

se desarrollarn a lo largo de este curso.

Documentacin Tcnica

3

Explicacin

Conceptualizacin de documentacin tcnica

La documentacin tcnica es uno de los pilares de nuestra civilizacin. La forma

en que la mayora de nosotros podemos beneficiarnos con los descubrimientos y

avances es preservarlos de forma escrita, ya sea impresa en los tradicionales

libros y revistas o de manera electrnica.

Un documento tcnico es aquel escrito que contiene informacin acerca de un

rea de conocimiento, organizada de forma estructurada y presentada

eficazmente a los lectores. De manera muy sencilla podemos definir un

documento tcnico como todo aquel documento que no es una obra literaria y

que est relacionado con el mbito laboral, tecnolgico o cientfico.

Caractersticas e importancia de la buena documentacin tcnica

Para escribir un buen documento tcnico es preciso seguir una serie de reglas,

cuya correcta aplicacin definir la eficiencia que tenga al ser consultado por los

destinatarios. Estas reglas no se refieren solamente a aspectos estticos o de

inspiracin del escritor, sino a reglas precisas y estrictas, que sin dejar a un lado

un aspecto agradable a la vista o una organizacin y uso de recursos grficos, el

material logre su propsito primordial de presentar informacin concreta.

Al hacer este tipo de documentos, el reto es lograr que los destinatarios

realmente los lean y asimilen su contenido. Un documento bien elaborado debe

invitar a la lectura. Un buen documento es agradable al lector, aun cuando ste

probablemente no sepa exactamente por qu es agradable.

Para lograr este objetivo el documento debe:

Ser de fcil lectura.

Permitir al lector obtener el mayor provecho de su contenido.

Documentacin Tcnica

4

Facilitar su actualizacin.

Proporcionar distintos niveles de detalle.

Al escribir un documento se deben seguir los siguientes teoremas:

1. Identificar a los destinatarios y escribir de manera apropiada para ellos.

2. Escribir con claridad.

3. Escribir de manera concisa.

4. Captar la atencin de los destinatarios.

5. Ayudar al lector a la fcil comprensin.

Suele ocurrir que los teoremas entren en conflicto uno con otro. Por ejemplo, para escribir un concepto con suficiente claridad puede requerirse de un texto ms extenso, con lo cual entraran en conflicto los teoremas 2 y 3. Para ayudar al lector puede resultar conveniente agregar una explicacin, un glosario o una ayuda en lnea, con lo cual tambin habra un conflicto entre los teoremas 2 y 5. Sin embargo, un buen escrito deber lograr un equilibrio armnico entre todos

los teoremas.

As pues, para lograr la armona entre todos los teoremas habr que dominar

dos aspectos que pueden parecer contradictorios:

Creatividad

Disciplina

Esto requiere tanto de conocer los fundamentos tericos y experimentales de la

buena documentacin tcnica como de practicar, practicar y practicar.

Qu teoremas te parecen ms relevantes?

Tipos de documentos tcnicos (texto, reporte, manual, instructivo, apuntes, guas, etc.).

Existe gran variedad de documentos tcnicos, con los cuales seguramente ests

familiarizado:

Documentacin Tcnica

5

Correo electrnico

Mensajes instantneos

Oficios

Documentacin de software

Presentaciones por computadora

Circulares

Manuales de usuario

Manuales de organizacin

Pginas web

Apuntes

Libros de texto

Artculos cientficos

Guas

Reportes

Instructivos

Documentacin Tcnica

6

Conclusin

Los documentos tcnicos pueden dividirse segn su estilo, forma de

presentacin y de distribucin, adems cuentan con una estructura en particular

y cumplen una serie de principios, de tcnicas para mapear la informacin,

para estructurar bloques de informacin, para etiquetarlos, para ilustrarlos y para

utilizar la tipografa, por supuesto, tambin deben seguir las reglas de escritura,

como las ortogrficas y el uso correcto de la sintaxis.

Para realizar un documento tcnico de calidad, adems de tomar en cuenta sus

fundamentos, se requiere de una planeacin cuidadosa, en la que se analice la

pertinencia de elaborar el documento, adems de cmo, cundo y en qu

programa realizarlo.

No cualquier documento, aun siendo un manual, un reporte o un apunte, es un

documento tcnico eficiente si no cumple con los principios y reglas precisas que

se desarrollarn a lo largo de este curso.

La documentacin tcnica no se basa en una escritura tradicional, sino en forma

de organizar y presentar la informacin segn resultados de pruebas

experimentales, en cuanto a la comunicacin clara. De ah el uso del concepto

Mapeo de informacin, que se abordar ms adelante.

Documentacin Tcnica

7

Para aprender ms

Documentos tcnicos y cientficos resumen, informe y ensayo y Tcnicas de comunicacin

Laura (2013). Documentos tcnicos y cientficos resumen, informe y

ensayo y Tcnicas de comunicacin documento obtenido

de http://www.slideshare.net/laurita9025/documento-tecnicos

Cmo escribir un documento tcnico?

Alba, E. (2002) cmo escribir un documento tcnico? Documento,

obtenido de http://brd.unid.edu.mx/como-escribir-un-documento-tecnico/

Documentacin Tcnica

8

Actividad de Aprendizaje

Instrucciones:

La actividad a realizar es con el fin de reforzar los conocimientos durante esta

sesin es con un resumen acerca de todo lo visto durante el tema y definiciones.

El resumen se realizar por computadora con extensin mximo de una cuartilla,

en formato PDF y se subir a la plataforma, donde se revisarn los archivos.

Esta actividad ayuda a reforzar y entender mejor los conceptos mencionados,

acerca de la documentacin tcnica.

Esta actividad tiene un porcentaje del 5% de tu calificacin y se tomar en

cuenta lo siguiente:

caratula

introduccin

desarrollo

conclusin

redaccin

Documentacin Tcnica

9

Bibliografa

Gonzlez, M. (2005). Documentacin. Mxico: UNID.

Laura (2013). Documentos tcnicos y cientficos resumen, informe y

ensayo y Tcnicas de comunicacin Documento obtenido

de http://www.slideshare.net/laurita9025/documento-tecnicos

Alba, E (2002) cmo escribir un documento tcnico? Documento

obtenido de http://www.lcc.uma.es/~eat/pdf/sw-spanish.pdf

Sesin No. 1ContextualizacinIntroduccin al TemaExplicacinConclusinPara aprender msActividad de AprendizajeBibliografa