redacción técnica 101 parte 2

En la parte 1 que compartí algunas de mis reflexiones sobre la definición de su público, la creación de un esquema, que define su propósito y las etapas de la escritura. Ahora me gustaría tomar un momento y ampliar el ámbito de la definición de su público. Por ejemplo, lo que usted necesita saber acerca de ellos y por qué.

El primer paso es averiguar el nivel de conocimiento sobre el tema. ¿Son …
• Nivel de Expertos? – En un nivel avanzado en el tema
• Semi-nivel experto? – En un nivel intermedio en el tema
• La no-experto nivel? – No tienen conocimiento previo de la materia

El segundo paso es determinar su papel en la organización. ¿Son …
• Superiores? – El más alto de las figuras de autoridad dentro de la organización, tales como el Presidente o el Vicepresidente o Director. Los que toman decisiones que afectan a toda la organización.
• Los subordinados? – Lectores en un nivel dentro de la organización bajo que el escritor técnico. Lo único que importa es cómo quedará el documento afecta a su puesto de trabajo.
• Peers? – Los lectores en el mismo nivel que el escritor técnico, pero no necesariamente el mismo departamento o terreno.

Y el tercer paso es averiguar por qué se va a leer el documento técnico en el primer lugar. ¿Es porque …
• tienen que? o se les ha ordenado por su manager?
• son verdaderamente interesados ??en el tema?
• sólo se va a utilizar como referencia al completar sus tareas de trabajo diarias?

Usted se estará preguntando por qué estos pasos son aún importante para un escritor técnico. Bueno, la razón es porque si usted escribe o el diseño de su documento en el contexto equivocado color o diseño que podría definir el proyecto en su totalidad.

Por ejemplo, usted no desea escribir un documento a los superiores, sin conocimiento de la materia en términos muy técnicos, ni tampoco quiero escribir de una manera condescendiente tampoco. Tiene que haber un equilibrio profesional entre los dos que participará el alumno y ayudarles a asimilar la información de manera eficiente y utilizar el documento técnico eficaz.

Veamos otro ejemplo. Estás escribiendo para un equipo de sus compañeros que tienen un nivel intermedio avanzado conocimiento. ¿Qué cree usted que sería la respuesta de los lectores si ha creado un documento que explica incluso el menor término técnico como lo que es un “ratón” o cómo hacer “clic”? Ellos probablemente se aburriría y ofendido al mismo tiempo, ¿no te parece?

De nuevo, la clave está en definir su público haciendo tantas preguntas como sea posible. Si usted termina con demasiados niveles y funciones de organización dentro de su público, es posible que necesite crear tres documentos separados, como una guía para principiantes, intermedio Guía del usuario y la Guía del usuario avanzado.

En la Parte 3 Yo quiero centrarme en cómo reunir los recursos y de dónde, y cuáles son ayudas gráficas o señales dentro de la documentación técnica y la manera de crearlos. Hasta la próxima …

recursos: escritura técnica: principios, estrategias, y las lecturas de Diana c. reep (5 ª ed.) Pearson Education, inc. 2003.