Cinco etapas de la redacción técnica
Jupiterimages/Comstock/Getty Images
El proceso de redacción técnica es esencial para entregar información exacta y clara a grandes grupos de gente. Aunque las etapas de este proceso son similares a las de otros proyectos de redacción, las exigencias técnicas de un proyecto de redacción técnica requieren que el redactor sea muy consciente al momento de presentar errores y elecciones de estilo. El proceso de redacción técnica toma estas demandas en consideración organizando un proyecto con las etapas diseñadas para organizar de forma clara las responsabilidades del redactor.
Preparación
La preparación es la primera etapa en el proceso de redacción técnica. Durante esta etapa, un redactor técnico responde a una serie de preguntas respecto a su proyecto. Estas incluyen consideraciones sobre el nivel de habilidad de la audiencia, qué determina la especificidad técnica del documento final y el propósito de la pieza y qué explica la dirección que va a tomar el redactor en el proyecto. El alcance del proyecto considera la cantidad de material que éste debe cubrir y el medio que se va a usar para presentar la información considera el formato específico de uso como Internet, una presentación en Power Point o un documento formal.
Investigación
La etapa de investigación es la fase en la que el redactor técnico reúne información sobre el proyecto. Esto incluye entrevistar a gente que trabaje en el proyecto, leer información técnica sobre el proyecto e invertir un poco de tiempo en trabajos manuales con respecto al nuevo proyecto, si es posible. Los redactores técnicos pueden regresar a esta etapa en varias ocasiones, en caso de que la información inicial no sea suficiente para cubrir la información necesaria para el proyecto.
Organización
Durante la etapa de organización un redactor técnico revisa toda la información reunida durante la fase de investigación, la divide en secciones y crea un borrador formal para el proyecto de redacción. Esto incluye la división en secciones más grandes en una serie de secciones más pequeñas que cubran de forma clara cada punto necesario. Los redactores técnicos dividen la información investigada a lo largo de estas secciones, asegurando que cada punto contenga suficientes citas de información para incluirlas en un punto independiente sin repetir la información en muchas secciones.
Primer borrador
Los redactores técnicos crean los primeros borradores, los cuales a menudo se escriben en cada sección por separado y usando la investigación organizada en cada sección conforme escriben. La redacción de un borrador en proyectos técnicos especifica las elecciones de redacción, un estilo claro de presentación y la información concisa para los lectores ocupados. Los redactores técnicos usan títulos obvios dividiendo la información de forma clara para los lectores.
Revisión y corrección
Una vez que el redactor técnico termina con el primer borrador, ingresa a la etapa de revisión y corrección en donde lee el borrador y hace los cambios necesarios. El redactor técnico revisa la redacción, la elección de palabras, la puntuación, el uso de voz pasiva y las erratas en el borrador original. Después de que se hagan los cambios, éste regresa a la etapa de revisión y corrección hasta que el documento sea claro, preciso y exacto.
Referencias
- Perl Monks; Introduction to Technical Writing/Documentation; December 2001 (Perl Monks; introducción a la redacción y documentación técnica; diciembre de 2001)
- Reading Room; Technical Writing for IT Security Policies in Five Easy Steps; J. Patrick Lindley; September 2001 (Reading Room; redacción técnica de políticas de seguridad en TI en cinco sencillos pasos; J. Patrick Lindley; septiembre de 2001)
Sobre el autor
Kristyn Hammond has been teaching freshman college composition at the university level since 2010. She has experience teaching developmental writing, freshman composition, and freshman composition and research. She currently resides in Central Texas where she works for a small university in the Texas A&M system of schools.
Créditos fotográficos
Jupiterimages/Comstock/Getty Images