redacción técnica 101 Parte I

Escritura técnica ha sido una de mis pasiones desde hace años. Yo en realidad comenzó como una persona servicios de asistencia documentar instrucciones técnicas para los empleados y las nuevas contrataciones, y luego se trasladó a la documentación de trabajo del proyecto de código de programación y especificaciones técnicas para proyectos más grandes. También he escrito un curso de una universidad local de mi zona y lo enseñó también. Quería compartir algunas de mis ideas en este curso ya que tantos participantes encontrado útil. Incluso se hizo una revisión en el periódico US1 Princeton! 😀

De todos modos, estoy divagando … en mi opinión hay cuatro claves para la escritura técnica y me refiero a él como el método DOPS. Vamos a revisar cada punto.

D es para definir tu audiencia – No sólo usted necesita saber que usted está escribiendo para, pero lo que necesita saber su nivel de conocimiento y conciencia sobre el tema establecido. Por ejemplo, si usted está enseñando a MS Word para altos ejecutivos y ellos ni siquiera saben cómo utilizar Outlook o navegar en Windows, puede que tenga que volver a evaluar su contenido y el idioma que está escribiendo pulg Trate de mantenerse alejado de los complejos términos técnicos y comienzan con una revisión básica de las barras de herramientas o incluso la forma de abrir la aplicación.

O es para Contorno. Personalmente creo que esta es la clave del éxito. Veo tantos escritores simplemente sentarse y comenzar a escribir sin rumbo y se nota en el flujo de su documento. Usted simplemente no puede seguir su “tren de pensamiento”. Tómese el tiempo para perfilar el documento completo del contenido de la página del título e incluso notas gráficas, los títulos de las secciones y contenidos, todo el camino hasta el apéndice, dejando la TOC (Tabla de Contenidos) que se completó el pasado. Confíe en que usted va a ver una gran diferencia en el flujo de sus documentos.

P es para la definición de su propósito – No me gusta usar acrónimos en el interior de las siglas, pero me gustaría referirme a esto como la teoría Triip. Su propósito al crear el documento podría ser enseñar, recomendar, informar, interés, o persuadir. Por ejemplo, si usted es el escritor técnico para una nueva aplicación informática para el departamento de Recursos Humanos, y su trabajo es escribir un documento para los empleados que vayan a utilizar esta nueva aplicación, ¿cuál es su propósito? En este caso, es el de enseñar. Aquí hay otro: Si usted es contratado como escritor técnico para crear un documento diseñado para que los empleados sepan acerca de las nuevas políticas y procedimientos, ¿cuál es su propósito? En este caso, la respuesta es informar. Usted no está haciendo una recomendación que siguen los procedimientos o tratando de interesarlos o persuadirlos de seguir las políticas y procedimientos, que hay que simplemente informarles.

S es para las Etapas de la Escritura. Creo que hay tres pasos a los escenarios, por así decirlo, y no no tengo un acrónimo de éste. LOL Los 3 pasos son planificar, redactar y revisar. Después de completar todo el plan de trabajo, incluyendo la evaluación de su audiencia y el esquema detallado con tal vez unos cuantos bocetos, usted puede comenzar a crear el documento borrador. Si usted no es nuevo para la escritura técnica es muy consciente de que su primer documento creado es siempre un borrador. Usted tendrá muchas revisiones, muchos por varias personas antes de que el documento final sea aprobado. Espero no asustar a nadie fuera todavía!

Así que ahí lo tienen, el método DOPS por Cheryl McNeil. Hay mucho más a la escritura técnica, pero pensé que me daría un adelanto de lo que vendrá en mi próximo artículo, la Parte II de la redacción técnica 101. Hasta la próxima …

Los recursos para la creación de contornos:

http://owl.english.purdue.edu/handouts/general/gl_outlin.html
http://www.albany.edu/eas/170/outline.htm
http://wiki.ehow.com/write-an-outline