Claves para escribir
OCUMENTACIÓN
TÉ
CNICA
Sesión 2 Claves para escribir
Lección 2.1
Objetivo de la sesión
Introducción
Al elaborar un documento técnico, la materia prima son las palabras que, a su vez, se agrupan en oraciones. En algún momento, todos hemos escuchado de la importancia de la buena redacción. Sin embargo, dentro de la escritura técnica la buena redacción es crucial. Si en unarevista de modas o en una novela la redacción es mala, puede ser que no se comprenda o se malinterprete, pero las consecuencias de ello no serían muy graves. En cambio, si un manual de usuario, una interfaz, un oficio, un correo electrónico de trabajo, un examen de selección o una guía rápida están mal redactados, las consecuencias pueden ir desde la frustración del lector hasta una desgracialamentable. Por ello, esta sesión tiene como objetivo que identifiques los elementos principales con los cuales se construye la documentación técnica: palabras, oraciones y documentos, así como algunas reglas esenciales para su selección y construcción.
Contenido de la sesión
M
AESTRÍA
EN
TE
CNOLOGÍAS
DE
IN
FORMACIÓN
- PÁ
GINA
7
D
OCUMENTACIÓN
TÉ
CNICALección 2.2
Introducción
Palabras: Jerga y consistencia
Probablemente viviríamos en un mundo mejor si usáramos las palabras con más respeto y cuidado. El mal uso de las palabras suele ocasionar desde conflictos personales hasta conflictos legales internacionales. No se trata aquí de profundizar en lingüística o semántica, sino únicamente de establecer algunos principios que mejorarán la calidadde tu expresión escrita.
Jerga
La Real Academia Española (www.rae.es) define la “jerga” como el lenguaje especial y familiar que usan entre sí los individuos de ciertas profesiones y oficios, como los toreros, los estudiantes, etc. La jerga es entonces la terminología técnica utilizada por los expertos, esto es, el conjunto de palabras y frases que usan entre ellos las personas avezadas enun tema específico. De esta frase debemos destacar “entre ellos”. Dicho de otra manera, si el documento que elaboras va dirigido al grupo de personas que comparten contigo un área de conocimientos, el uso de la jerga será muy adecuado; sin embargo, si escribes para un público general o para un grupo de personas que no son especialistas en el tema, debes ser extremadamente cuidadoso en el uso detérminos técnicos.
Nota
La jerga tiene un comportamiento dinámico: lo que ahora es un término técnico puede ser una palabra de uso coloquial el día de mañana. Por ejemplo, la palabras: superego, chip o genoma fueron palabras de uso especializado y ahora forman parte del vocabulario normal.
Reglas para elegir palabras
Por lo anterior, sigue estas reglas en el uso de las palabras: 1. Si esposible expresa la idea con términos sencillos y de uso común. Elige la palabra más adecuada al concepto, de tal manera que coincida con el significado que se le atribuye en un buen diccionario, preferentemente el de la Real Academia Española. De esta forma, si el lector tiene duda, podrá consultar fácilmente. Cabe señalar que, por supuesto, las palabras suelen tener varios significados, de maneraque es conveniente elegir el significado más popular, siempre y cuando sea acorde al contenido que se desea expresar. 2. Si es indispensable utilizar un término técnico o jerga especializada, utiliza alguna de las siguientes opciones: Define el término dentro del texto, la primera vez que aparece. Incluye un glosario en el cual se definan todos los términos técnicos.
Consistencia
En cuanto alos términos importantes, debes usar la misma palabra a lo largo de todo el documento. Si bien la variedad de palabras puede ser agradable a lo largo de las explicaciones, los conceptos relevantes deben escribirse de manera idéntica para facilitar al lector su identificación. Por ejemplo, si utilizas la abreviatura RAM para Random Access Memory, no la cambies por MAA (Memoria de Acceso...
Regístrate para leer el documento completo.