documentación técnica

DOCUMENTACIÓN TÉCNICA
Documentación Técnica
Sesión No. 1
Nombre: Conceptualización de documentación técnica
Contextualización
Probablemente debas escribir en tus actividades cotidianas, ya sea al redactar
un correo electrónico, un recado, una guía o hasta un manual de usuario o un
reporte. La comunicación escrita es fundamental en gran parte de las actividades
de la gente, especialmente en las laborales.
En esta sesión sabrás qué es un documento técnico, qué características debe
tener un documento de calidad para que cumpla con su objetivo y qué ventajas
tiene el uso de la metodología que ofrece este curso.
1
Documentación Técnica
Introducción al Tema
Los documentos técnicos pueden dividirse según su estilo, forma de
presentación y de distribución, además cuentan con una estructura en particular
y cumplen una serie de principios, de técnicas para “mapear” la información,
para estructurar bloques de información, para etiquetarlos, para ilustrarlos y para
utilizar la tipografía, por supuesto, también deben seguir las reglas de escritura,
como las ortográficas y el uso correcto de la sintaxis.
Para realizar un documento técnico de calidad, además de tomar en cuenta sus
fundamentos, se requiere de una planeación cuidadosa, en la que se analice la
pertinencia de elaborar el documento, además de cómo, cuándo y en qué
programa realizarlo.
No cualquier documento, aun siendo un manual, un reporte o un apunte, es un
documento técnico eficiente si no cumple con los principios y reglas precisas que
se desarrollarán a lo largo de este curso.
2
Documentación Técnica
Explicación
Conceptualización de documentación técnica
La documentación técnica es uno de los pilares de nuestra civilización. La forma
en que la mayoría 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 electrónica.
Un documento técnico es aquel escrito que contiene información acerca de un
área de conocimiento, organizada de forma estructurada y presentada
eficazmente a los lectores. De manera muy sencilla podemos definir un
documento técnico como todo aquel documento que no es una obra literaria y
que está relacionado con el ámbito laboral, tecnológico o científico.
Características e importancia de la buena documentación
técnica
Para escribir un buen documento técnico es preciso seguir una serie de reglas,
cuya correcta aplicación definirá la eficiencia que tenga al ser consultado por los
destinatarios. Estas reglas no se refieren solamente a aspectos estéticos o de
inspiración del escritor, sino a reglas precisas y estrictas, que sin dejar a un lado
un aspecto agradable a la vista o una organización y uso de recursos gráficos, el
material logre su propósito primordial de presentar información 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 fácil lectura.
•
Permitir al lector obtener el mayor provecho de su contenido.
3
Documentación Técnica
•
Facilitar su actualización.
•
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 atención de los destinatarios.
5. Ayudar al lector a la fácil comprensión.
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
más extenso, con lo cual entrarían en conflicto los teoremas 2 y 3. Para ayudar
al lector puede resultar conveniente agregar una explicación, un glosario o una
ayuda en línea, con lo cual también habría un conflicto entre los teoremas 2 y 5.
Sin embargo, un buen escrito deberá lograr un equilibrio armónico entre todos
los teoremas.
Así pues, para lograr la armonía entre todos los teoremas habrá que dominar
dos aspectos que pueden parecer contradictorios:
•
Creatividad
•
Disciplina
Esto requiere tanto de conocer los fundamentos teóricos y experimentales de la
buena documentación técnica como de practicar, practicar y practicar.
¿Qué teoremas te parecen más relevantes?
Tipos
de
documentos
técnicos
(texto,
reporte,
manual,
instructivo, apuntes, guías, etc.).
Existe gran variedad de documentos técnicos, con los cuales seguramente estás
familiarizado:
4
Documentación Técnica
•
Correo electrónico
•
Mensajes instantáneos
•
Oficios
•
Documentación de software
•
Presentaciones por computadora
•
Circulares
•
Manuales de usuario
•
Manuales de organización
•
Páginas web
•
Apuntes
•
Libros de texto
•
Artículos científicos
•
Guías
•
Reportes
•
Instructivos
5
Documentación Técnica
Conclusión
Los documentos técnicos pueden dividirse según su estilo, forma de
presentación y de distribución, además cuentan con una estructura en particular
y cumplen una serie de principios, de técnicas para “mapear” la información,
para estructurar bloques de información, para etiquetarlos, para ilustrarlos y para
utilizar la tipografía, por supuesto, también deben seguir las reglas de escritura,
como las ortográficas y el uso correcto de la sintaxis.
Para realizar un documento técnico de calidad, además de tomar en cuenta sus
fundamentos, se requiere de una planeación cuidadosa, en la que se analice la
pertinencia de elaborar el documento, además de cómo, cuándo y en qué
programa realizarlo.
No cualquier documento, aun siendo un manual, un reporte o un apunte, es un
documento técnico eficiente si no cumple con los principios y reglas precisas que
se desarrollarán a lo largo de este curso.
La documentación técnica no se basa en una escritura tradicional, sino en forma
de organizar y presentar la información según resultados de pruebas
experimentales, en cuanto a la comunicación clara. De ahí el uso del concepto
Mapeo de información, que se abordará más adelante.
6
Documentación Técnica
Para aprender más
Documentos técnicos y científicos resumen, informe y ensayo y Técnicas
de comunicación
•
Laura (2013). Documentos técnicos y científicos resumen, informe y
ensayo
y
Técnicas
de
comunicación
documento
obtenido
de http://www.slideshare.net/laurita9025/documento-tecnicos
¿Cómo escribir un documento técnico?
•
Alba, E. (2002) ¿cómo escribir un documento técnico? Documento,
obtenido de http://brd.unid.edu.mx/como-escribir-un-documento-tecnico/
7
Documentación Técnica
Actividad de Aprendizaje
Instrucciones:
La actividad a realizar es con el fin de reforzar los conocimientos durante esta
sesión es con un resumen acerca de todo lo visto durante el tema y definiciones.
El resumen se realizará por computadora con extensión máximo de una cuartilla,
en formato PDF y se subirá a la plataforma, donde se revisarán los archivos.
Esta actividad ayuda a reforzar y entender mejor los conceptos mencionados,
acerca de la documentación técnica.
Esta actividad tiene un porcentaje del 5% de tu calificación y se tomará en
cuenta lo siguiente:
•
caratula
•
introducción
•
desarrollo
•
conclusión
•
redacción
8
Documentación Técnica
Bibliografía
• González, M. (2005). Documentación. México: UNID.
•
Laura (2013). Documentos técnicos y científicos resumen, informe y
ensayo
y
Técnicas
de
comunicación
Documento
obtenido
de http://www.slideshare.net/laurita9025/documento-tecnicos
•
Alba, E (2002) ¿cómo escribir un documento técnico? Documento
obtenido de http://www.lcc.uma.es/~eat/pdf/sw-spanish.pdf
9