Escritura técnica 101 Parte 2

En la Parte 1 compartí algunos de mis pensamientos sobre la definición de su público, la creación de un esquema, la definición de 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 su nivel de conocimiento sobre el tema. ¿Son y hellip;
nivel experto? y- en un nivel avanzado en la materia objeto de nivel
semi-experto? y- en un nivel intermedio en el tema
nivel no experto? y- no tienen ningún conocimiento previo de la materia objeto

El segundo paso es averiguar su papel en la organización. ¿Son y hellip;
• Superiores? y- la más alta de las figuras de autoridad dentro de la organización, tales como el Presidente o Vicepresidente o el Director. Los que toman decisiones que afectan a toda la organización Restaurant &toro; Los subordinados? y- lectores en un nivel dentro de la organización más bajo que el escritor técnico. Lo único que importa es cómo el documento afecta a su trabajo Restaurant &toro; Los compañeros? y- lectores en el mismo nivel que el escritor técnico, pero no necesariamente el mismo departamento o de campo.

Y el tercer paso es averiguar por qué van a leer el documento técnico en el primer lugar. ¿Es porque y hellip;
• ¿Tienen que? o se han ordenado por su manager
&bull?; son realmente interesados ​​en el tema Restaurant &bull?; sólo va a utilizar como referencia al completar sus tareas de trabajo diarias?

Usted se estará preguntando por qué estas medidas son aún importantes 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, el color o el diseño que podría definir el proyecto completo.

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

Vamos y'. S vistazo a otro ejemplo. Usted está escribiendo para un equipo de sus compañeros que tienen un nivel intermedio de conocimientos avanzados. ¿Qué crees que sería la respuesta de los lectores si ha creado un documento que explica incluso el término técnico más bajo, como lo que es a &'; ratón y' o cómo a “ click &" ;? Probablemente sería aburrido y ofendidos, al mismo tiempo, don &'; t crees

Así que de nuevo, la clave está en definir su público al pedir tantas preguntas como sea posible?. Si usted termina con demasiados niveles y roles organizacionales dentro de su público, es posible que deba crear 3 documentos separados, como una guía para principiantes, intermedios y Guía del usuario Guía del usuario avanzado
.

En la Parte 3 Quiero se centran en cómo reunir recursos y de dónde, y cuáles son ayudas o pistas dentro de la documentación técnica y cómo crearlos gráficos. Hasta la próxima y hellip;

Recursos: Escritura Técnica:. Principios, estrategias, y lecturas de Diana C. Reep (. 5 ed) Pearson Education, Inc. 2003. Hotel