Mejorar le...
Palabras clave:
Editor, mejorar la redacción, edición manual de usuario, edición
Cuerpo del artículo:
Visión general
El editor debe ser parte integrante de su equipo de redacción. No creo que de él como un juez, sino como un recurso para ayudarle en todas las fases del proyecto escrito. Este artículo le ayudará a superar el temor de su editor y cómo utilizar eficazmente su editor durante el proceso de escritura.
Cuidado con su Editor
Algunos de los cambios que podría sugerir un editor podrían hacer que el documento de usuario más difícil para el lector a entender.
Mejora tu escritura
Una vez su editor ha pasado las tareas básicas de edición mecánicas de:
* gramática
* puntuación
* la ortografía
* edición de una hoja de estilos,
puede trabajar en "mejorar su escritura".
El editor puede creer que una forma de hacer más interesante la escritura es utilizar sinónimos cuando usted referencia a algo. Así se podría llamar algo un bin"chip" en una parte de su texto, y su editor podría sugerir utilizando un término diferente, como la "trampa de residuos", más adelante en el documento. Esto debe hacer que su escritura "más interesante".
No desea interesante escribir en sus documentos de usuario! Desea claro, sencillo y muy fácil de entender la escritura. Si realiza la escritura más interesantes utilizando el sinónimo ("residuos trampa") forzar su lector a tener que pensar en si o no son lo mismo. Recomiendo que utilice el mismo texto cada lugar en el documento de usuario donde se hace referencia a lo mismo. No sinónimos aquí!
Si el lector quería ser entretenidos o tienen sus pensamientos provocadas, luego podría leer una novela.
No deje que su editor hacer su escrito más interesante o más inteligente si esos esfuerzos dificulta el material para el lector a entender.
Erudición
Otro lugar de su editor es "erudición." Es decir, cuando un editor que intenta hacer la documentación de usuario de sonido más formal. Que no renuncia, legal y la información de seguridad, el documento de usuario debe sonar amistoso, con un tono coloquial.
Por ejemplo, un editor puede sugerir cambiar las contracciones (como el "no") en su forma más formal ("no"). No hacerlo! Las contracciones son conversacionales y no se debe evitar.
Si se piensa, leer la documentación del usuario para cualquier producto de la mayoría de las personas está bajo alguna forma de estrés:
* que cualquiera desea continuar con la utilización del producto, o
* algo ha ido mal.
Un documento formal pondrá el usuario. El documento no debería ser tonto o impertinente; Sin embargo, debe proporcionar la información que las necesidades del usuario en una conversación, fácilmente comprensible estilo. La información necesaria debe ser fácil de encontrar.
Aunque la mayoría gramatical de procesador de textos son lamentablemente inadecuados, muchas de estas damas es posible darle una puntuación de legibilidad (puede que tenga que establecer una opción para habilitar esta característica). Edición debería ayudar a aumentar la legibilidad (indicada por una disminución en la lectura nivel de grado) del documento. Si aumenta la lectura grado nivel, pedir a su editor de la edición por qué puntuación que ha cambiado.
Qué hacer
Proporcionar su editor con la información que permitirá a hacer el mejor trabajo. Aquí hay algunas cosas que contar su editor:
* La audiencia para el documento de usuario
* Informe a su editor que desea un estilo informal de documento de usuario
* ¿Qué estilo manual o guía a utilizarse en la edición
* La programación y el progreso del proyecto
* Formato para compartir y editar el texto (asegúrese de que el editor puede leer su electrónica documentos--hacer esto cuando usted contrata el editor)
(Cuando se trata con alguien fuera de su organización, debe tener firmado un acuerdo de no divulgación. Se trata además de cualquier otro elemento contractual entre el extraño y su organización.)
Conozca su Editor
El editor no es el profesor de la escuela. En sus días de escuela, el profesor como editor fue un juez. Su objetivo era impresionar a su profesor con su escritura. Estaban trabajando para un grado. Así puede haber llegado a temer su editor.
Cambiar su forma de pensar! Ahora, su editor está de su parte. Su editor trabajará con usted para producir el mejor guión posible. No tendrá que preocuparse excesivamente por la gramática. Le meta es conseguir la información "en papel" tan clara y completamente posible. El editor sugiere cambios para pulir el texto.
Por lo tanto no temen su editor. Hacer su parte del editor de su equipo de redacción.
Editor de amor
Contratar su Editor en el proyecto
Contratar su editor temprano en la vida del proyecto. Hay al menos dos beneficios a la contratación de pronto el editor:
* En primer lugar, el editor se prepararán para la tarea de edición. Habrá tenido tiempo para conocer el producto, audiencia y Guía de estilo de la organización.
* Segundo, su editor puede ayudarle con su escrito, como se describen a continuación...
Permitir que la ayuda del Editor de usted
Si ejecuta en problemas acerca de cómo escribir algo, llame a su editor. Es muy probable que su editor puede proporcionar una redacción eficaz para que todo el bloque. Esa es la razón por qué tienes el editor en el proyecto de principios. Aquí es otro...
Una recomendación
Recomiendo que trabajan en pequeñas piezas del documento de usuario y distribuir esas pequeñas piezas (borradores) al equipo de desarrollo para comentarios. A continuación utilice sus comentarios para mejorar la redacción y el material mejorado a circular. Continuar esto para unos ciclos. Yo lo llamo "iterativo, escritura interactiva." Se trata de un método eficaz para escribir rápidamente y con precisión.
Si se siente incómodo sobre que circulan borradores para el equipo de desarrollo de producto para su revisión, aquí es una solución. Tienen a su editor realiza una edición rápida del borrador antes de que se pongan en circulación para comentarios. Sus "borradores" será muy bueno y el equipo se concentrará en el contenido, no el texto o la gramática (y son de comentarios sobre el contenido que desee en el equipo).
La línea de fondo
No creo que su editor como enemigo al acecho al final de la ruta de producción del documento. En su lugar, dan cuenta de que su editor puede ser un valioso miembro de su equipo de redacción y que está de su lado. Debe:
* Se trajo temprano en el proyecto de escritura
* Mantenerse consciente de la situación del proyecto de escritura
* Se utiliza como un escrito, así como una edición, recursos
Sugerencia: Es mucho más agradable para el escritor (usted) trabajar con documentos electrónicos "marcado de arriba", en lugar de documentos impresos marcada. Investigar la capacidad de "varios revisores" de su procesador de textos. Al emplear esta capacidad requiere que usted y su editor de utilizan el software de procesamiento de texto igual o compatible.
Nota: no soy un editor, ni debo representar cualquier editores. Pero como escritor, valoro edición.
