Escritura técnica 101 Parte I

Escritura técnica ha sido una de mis pasiones desde hace años. De hecho, me empecé como persona Servicio de asistencia a la documentación de instrucciones técnicas para los empleados y las nuevas contrataciones, y luego se trasladó hacia el trabajo del proyecto que documenta código de programación y especificaciones técnicas de los proyectos más grandes. I &'; he escrito también un curso de un colegio de la comunidad local en mi área y aprendí también. Quería compartir algunas de mis ideas de este curso ya que muchos participantes encontraron útil. Incluso hicieron una reseña en el periódico US1 Princeton! -D

De todos modos, estoy divagando y hellip; en mi opinión, hay 4 claves para la redacción técnica y se refieren a ella como método DOPS. Vamos y' s revisar cada punto

D es para definir su audiencia y- No sólo usted necesita saber que usted está escribiendo para, pero lo que necesita saber su nivel y la conciencia del tema conjunto de conocimientos. 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 en que se escriba. 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 Esquema. Personalmente creo que esta es la clave del éxito. Veo tantos escritores simplemente se sientan y empiezan a escribir sin dirección y te puedo decir en el flujo de su documento. Usted simplemente no puede seguir su y" tren de pensamiento y " ;. Tómese el tiempo para perfilar el documento completo del contenido de la página de título e incluso notas gráficas, a los títulos de las secciones y contenidos, todo el camino hasta el apéndice, dejando el TOC (Tabla de contenido) que se complete la última. Confía en mí, verá una gran diferencia en el flujo de sus documentos

P es para Definir el Propósito y- No me gusta usar siglas dentro de siglas, pero me gusta referirme a esto como la teoría Triip. Su propósito para crear el documento podría ser la de enseñar, Aconsejar, Informar, interés, o persuadir. Por ejemplo, si usted es el escritor técnico para una nueva aplicación de software 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, se trata de enseñar. Aquí y' s otra: Si usted es contratado como escritor técnico para crear un documento diseñado para permitir a los empleados saben sobre nuevas políticas y procedimientos, ¿cuál es su propósito? En este caso, la respuesta es informar. You &'; re no hacer una recomendación de que se siguen los procedimientos o tratando de interesar a ellos o persuadirlos a seguir las políticas y procedimientos; usted necesita simplemente informarles.

S es para las etapas de la escritura. Creo que hay 3 pasos para las etapas, 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 para el documento, incluyendo la evaluación de su público y el esquema detallado con tal vez un par de bocetos, usted puede comenzar a crear su proyecto de documento. Si no es nuevo en la redacción técnica usted sabe muy bien que su primer documento creado es siempre un proyecto. Usted tendrá muchas, muchas revisiones por varias personas antes de la aprobación del documento final. Espero yo no y' t asustar a nadie fuera todavía!

Así que ahí lo tenemos, el método DOPS por Cheryl McNeil. Hay mucho más para la redacción técnica, pero pensé que me acaba de dar un adelanto de lo que está por venir en mi próximo artículo, la Parte II de la redacción técnica 101. Hasta la próxima y hellip;

Recursos para la creación de outlines:

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
.