Documentación Técnica

Transcripción

1 Documentación Técnica

2 1 Sesión No. 4 Nombre: Planeación de los documentos. Parte I. Objetivo: al finalizar la sesión, el estudiante conocerá las implicaciones que tiene ser un escritor técnico, además, verá la primera parte del proceso de planear un documento, todo esto con la finalidad de que una vez terminado el curso, pueda generar documentos de calidad de manera escrita, dentro de su ámbito profesional. Contextualización Existen más trabajos de los que te imaginas. Las formas en la que una persona puede ganarse la vida son inconmensurables; desde el inseminador artificial de caballos y vacas, pasando por diseñadores de los aparatos u objetos más inesperados o extraños y terminando en expertos buzos que se dedican a recolectar pelotas que caen en las trampas de agua de los campos de golf. Las maneras de ocuparte parecen ilimitadas. Los trabajos previamente mencionados parecen extremos y fuera del medio en el que te desenvuelves; sin embargo, existe otro puesto que te aseguro no habías imaginado antes de haber iniciado este curso: el de escritor técnico. A continuación conoceremos lo que implica este puesto, además de empezar a vislumbrar lo que implica redactar un documento técnico.

3 2 Introducción al tema El escritor técnico es en cierta forma un traductor. Su tarea es traducir la información existente en el mundo de las ideas en texto que pueda ser comprendido por el resto de las personas en la corporación donde trabaja. Durante esta sesión aprenderemos las actividades y las características que debe de tener quienquiera que busque establecerse como escritor técnico. Hay que tener bien claro que estas características no son excluyentes para el resto de los puestos en una empresa. Antes de que deseches esta información pensando «esto jamás me aplicará a mí, yo no busco ser escritor técnico» considera que quien sabe escribir, sabe pensar. Para finalizar la sesión, veremos el primer paso de la redacción un documento técnico: la planeación.

4 3 Explicación 2. PLANEACIÓN DE LOS DOCUMENTOS 2.1. El escritor técnico El escritor técnico es la persona que convierte información relacionada con alguna empresa o industria en documentos fáciles de comprender. Se trata de individuos cuyo trabajo consiste en realizar la labor cognitiva de selección y digestión de información para posteriormente presentarla a un público de manera sucinta y clara. Su labor es importante para el buen funcionamiento de una empresa. Generalmente, el escritor técnico es alguien con formación en periodismo, idiomas o letras que además cuenta con experiencia en algún tema técnico como puede ser ingeniería, administración, diseño web o ciencias computacionales. Con el incremento del uso de tecnologías digitales en cuanto a forma de distribución de la información dentro y fuera de las empresas, el escritor técnico debe estar familiarizado con la edición electrónica, producción de video y el uso de gráficos (BLS, 2012). Las tareas del escritor técnico pueden dividirse en dos: Preparar reportes, manuales, instructivos, apuntes, guías, catálogos, materiales de promoción de ventas o informativos, informes técnicos, entre otros. Redactar artículos técnicos o científicos para publicaciones especializadas. Aquí es importante que el escritor técnico difunda la

5 4 información en un lenguaje comprensible tanto para expertos como para neófitos en el asunto en cuestión. De acuerdo con Gallach (2014), cinco puntos que un escritor técnico debe de tener dentro de su desarrollo profesional son exactitud, claridad, orden, objetividad y documentación Plan del documento Planear es la acción de fijar una meta y estipular los pasos que se tienen que recorrer para llegar a ella. Se planea un viaje, un proyecto, la lista de mercado para la comida que consumirás en la semana. Planear o no, pareciera ser cosa de temperamento, sin embargo en el ambiente laboral es una actividad que no puede obviarse. Aunque pudiera parecer como innecesario, la redacción de un documento técnico también requiere de un proceso de planeación; es en este momento cuando se buscará responder a las preguntas de porqué, para quién, cómo, y cuándo se realizará. Reflexionemos, si lo que quieres es redactar un proyecto qué necesitas para poder comenzar? No se trata de sólo sentarse frente a un teclado e iniciar a escribir. Podríamos hacer una división del proceso de planeación de la siguiente manera: 1. Es necesario conocer el estado de la cuestión a tratar, de esta manera se elegirá mejor el tipo de documento requerido de acuerdo a la situación. 2. Una vez que se cuenta con esto, el siguiente paso es definir los objetivos a los cuales se busca llegar. Como recomendación, deben de ser objetivos concretos y mesurables; de esta manera será más sencillo mostrar los resultados a los superiores. 3. Posteriormente se tiene que dividir y señalar el tiempo que tomarán los procesos que implica redactar un documento: revisión de la literatura,

6 5 bosquejo del documento, formalización dentro de una estructura predeterminada y homogeneización del estilo. 4. Una vez que se cumplieron con todas estos pasos, se procede a la puesta en marcha de la redacción del documento.

7 6 Conclusión El escritor técnico es un profesionista que convierte información relacionada con alguna empresa o industria en documentos fáciles de comprender. Ayuda a la comunicación tanto interna como externa de la empresa, por tanto es pieza clave de sus procesos. Para ser un buen escritor técnico, el profesionista debe de producir textos que cuenten con exactitud, claridad, orden, objetividad, sencillez y documentación. Buscando iniciarnos en la labor de redactar documentos técnicos, en esta presentación conocimos el primer paso: la planeación. Una buena planeación no asegura un buen desenlace, sin embargo aumenta las posibilidades de éste. Como se mencionó previamente, la planeación es el primer paso. En las siguientes sesiones nos adentraremos en los siguientes pasos para que al finalizar este curso, seas capaz de redactar un documento técnico.

8 7 Para aprender más Planeación de documentos Documentación Técnica UNID (2012). Planeación de documentos. Información disponible en: planeacion-de-los-documentos/

9 8 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 entrelaza con la realizada en la segunda sesión de este curso. 1. Tendrás que retomar las tres réplicas que hiciste y hacer una revisión acerca de su exactitud, claridad, orden, y objetividad. Preséntaselas a tus papás, tíos, amigos, novia(o) al menos tres personas- y pregúntales si comprenden lo que escribiste. Haz notas sobre el texto en la parte que podría mejorar y guárdalo en un archivo. 2. Realiza un segundo archivo donde hagas las correcciones que las tres personas te hicieron, además de las que creas pertinentes después de lo que has visto en las últimas sesiones. Una vez que hayas terminado guarda el archivo. Puedes realizarlos en cualquier programa, al final tendrás que guardarlo en formato PDF, y entregarlo de acuerdo a las indicaciones de tu profesor. Esta actividad representa el 5% de tu calificación y se tomará en cuenta lo siguiente: Tus datos generales. Ortografía y redacción. Entrega de todos los documentos solicitados. El significativo cambio y mejora de las réplicas originales a las que se presentan en el segundo archivo.

10 9 Bibliografía Ackoff, R. (2008). Planificación de la empresa del futuro México. Editorial Limusa. Marquina, J. (2013). Plan social media y community manager. España. Editorial UOC. Cibergrafía Barcelona Activa (2011). Escritor/a técnico/a. Recuperado el 10 de julio de 2015 de: Bureau of Labor Statistics (2012). Technical Writers. Recuperado el 10 de julio de 2015, de: Documentación Técnica UNID (2012). Planeación de documentos. Información disponible en: planeacion-de-los-documentos/ Gallach, Y. (s/f). Características del escritor técnico. Recuperado el 10 de julio de 2015 de: