Escritura técnica para aterrorizada
Introducción
A veces puede ser más allá de presupuesto de las compañías o de los individuos para emplear a un escritor profesional para tratar su documentación técnica. Aunque en un mundo ideal toda la documentación técnica se debe producir por un experto altamente entrenado, desafortunadamente no vivimos en un ideal. De la misma manera que mucha gente procurará reparar sus propios aparatos electrodomésticos, mucha gente procurará escribir a calidad documentos técnicos. Apenas como tocando el violín con una tostadora puede dar lugar al electrocution, el procurar escribir documentos técnicos del rasguño sin consejo anterior dará lugar en última instancia a falta. Como una regla del pulgar áspera que usted debe intentar siempre para emplear a un especialista, pero si para cualquier razón usted no puede y usted están el desafortunados pobres que han tenido deberes de la documentación vendidos con engan¢o en ellos, no se desespere. Esta guía del escrito contornea algunas de las habilidades de la base que usted necesitará traer a su escritura, de las paquetes técnicas de las convenciones a estar enteradas de, de software usted puede considerar, y de las cosas definidas a evitar. Esperanzadamente iguale si usted nunca le ha escrito a oración en su vida sobre cualquier cosa vago técnico tiene por lo menos, un cuadro más amplio de lo que exige la escritura técnica.
¿Cuál es escritura técnica?
La escritura técnica unsurprisingly bastante, refiere a la escritura que es técnica. Aunque esto puede parecerse como una definición engañosa, es importante a recordar. Muchos autores técnicos incurren en también la equivocación de crear la documentación que es o demasiado técnica, o también ' literario '. Un buen autor técnico debe poder ajustar el equilibrio entre los dos para satisfacer al usuario del extremo de la documentación. La escritura técnica es mucho como invisible penetrante pero bonito del aire fresco, mucho. En el mundo atado con alambre extraño en el cual nos encontramos, la escritura técnica está por todas partes. Los manuales del software, las guías del usuario para los aparatos electrodomésticos, los prospectos educacionales, los email, las letras, los informes, los informes de noticias técnicos, la estadística y las biografías en deportes de la televisión demuestran que todos son los ejemplos de la escritura técnica a los cuales exponen a la gente encendido a una base diaria. Si usted ha intentado programar los ajustes del tiempo en un video casero y ha arrojado siempre el manual a través del cuarto en repugnancia, usted lanzó un pedazo de escritura técnica (aunque obviamente no muy buena!).
La literatura técnica de muchas veces es producida también por los escritores con no bastante grande un asimiento de la tecnología, o los tecnólogos que carecen una capacidad de escribir. Como un autor técnico anticipado usted debe pisar la línea muy delicada de estar técnico bien informado en su field(s) del especialista así como ser ' buen ' escritor (en comparación con los ' malos ' escritores que pueden ser encontrados generalmente el asaltar de viejas señoras dulces o algo). La documentación técnica se produce generalmente para dos grupos de usuario distintos, a saber usuarios llanos expertos, y los usuarios ingenuos. Pues un autor técnico uno de sus primeras tareas debe clasificar fuera para de qué audiencias usted está escribiendo, a quien me trae hábilmente:
Conozca al enemigo thy
Como va el viejo© clichÃ, cada uno un crítico. Esto es particularmente verdad de la reacción de la mayoría de la gente sana cuando está hecha frente con la escritura técnica. Como fue destacado en el ejemplo del video arriba, la escritura técnica puede ser impenetrable al usuario del extremo. Si éste es el caso, es porque quienquiera escribió la documentación, no incomodó identificar a sus audiencias y escribir a su nivel. Se parece un punto obvio a hacer, pero uno que se pasa por alto a menudo, que el usuario de los documentos sus está creando, puede realmente no ser un experto. Obviamente si usted está creando un documento en un producto particular del especialista para un grupo particular del usuario experimentado (un buen ejemplo podría revisar el software para los administradores del sistema informático) entonces que usted necesitará componer esto es una manera enteramente diversa que si usted está creando por ejemplo, un manual técnico para el software del mercado total tuvo como objetivo a usuario casero inexperto. Una de las primeras tareas que usted debe lograr antes de que usted incluso ponga la pluma al papel, del dedo al teclado, debe identificar quiénes será y construirá el usuario de sus documentos los documentos dirigidos que group(s) particular de la blanco. ¡Si usted consigue esta etapa correcta, debe evitar sus documentos que son lanzados a través de cuartos en la molestia!
El planear para la perfección
Una vez que usted haya identificado el mercado de blanco para los documentos que usted creará, usted necesitará comenzar a planear cómo los documentos serán organizados. Este proceso es en gran parte dependiente en se está produciendo qué documentación, pero usted puede seguir algunas reglas del pulgar ásperas. En primer lugar, si los documentos son apoyar un producto particularmente detallado (tal como una aplicación informática) consiga sus manos sucias en ella tan rápidamente como usted puede. Examinando el producto usted puede formular detalladamente un plan del ataque y comenzar a componer una estructura de organización. Mientras que usted está explorando el producto detalladamente, las notas copiosas de la toma, como hacer esto durante las etapas exploratorias iniciales pueden ahorrarle el tiempo que puede ser absolutamente vital si usted está trabajando al plazo. Incluso en la etapa de planeamiento que usted debe asegurarse allí es una consistencia a la disposición, y estructura de organización para el documento. Seleccione a convenciones de la enumeración, divida en párrafos los estilos, y ahora genere las ideas aproximadas para los propósitos de la disposición, y excepto tiempo vital más adelante.
Deje un bosquejo adentro
Antes de zambullirse headfirst en crear la documentación, bosquejo fuera de cada sección primero. Esto permitirá para reordenar si los documentos que son creados no tienen un ' flujo lógico ' sin seriamente tener impacto en el proyecto. Muchos documentos técnicos (especialmente para productos más detallados) se componen (y en algunos casos prácticamente incontables) de iteraciones numerosas. Esto es porque el producto cambia de puesto y cambia en un cierto plazo, y uno de los deberes principales de un autor técnico debe mantener al corriente de estos cambios, y asegurarse de que están todos bien documentados. Los buenos autores técnicos empujarán siempre sus documentos a través de tantos bosquejos como humano posible, refinando en cada bosquejo, hasta que ellos alcanzan una posición por el que ellos (y su patrón) esté satisfechos que la documentación es oportuna, exacto y una reflexión verdadera del producto o procéselo documenta.
El diablo está en el detalle
Como escritura ya identificada, técnica se llama eso porque es técnico en naturaleza. La pieza de ser técnica es ser exacta, y la parte de precisión es ser tan detallada como humano posible. Incluso si los documentos que usted está creando están para un avanzado y el grupo de usuario tecnológico sofisticado, su documentación debe centrarse en los detalles de un proceso, o al usar un producto. Esto puede ser una hazaña difícil a lograr, pero no si usted escribe a sus audiencias. Nunca asuma que el lector sabe que cualquier cosa sobre el producto o el proceso esté documentada, pero en el caso de usuarios avanzados/expertos tenga por lo menos el sentido común de reconocer el hecho de que no necesitan probablemente ser dichas cómo utilizar el equipo que funcionan encendido una base diaria. Al describir cómo realizar una actividad o una tarea particular, identifique cada etapa implicada (numérelas si esto cabe las convenciones del tipo del documento que usted está creando) y asegurar la exactitud de lo que usted le ha escrito prueba usted mismo, o aún mejorarla, cuerda en un voluntario del mismo nivel de habilidades que el usuario del extremo.
Elija la herramienta derecha para el trabajo
Aunque es posible crear documentos técnicos usando el pergamino y la sangre, no es recomendable. Muchos usos del software del especialista existen para ayudarle a crear la documentación de gran alcance, y la parte de sus deberes como autor técnico, incluye seleccionar la herramienta derecha para el trabajo. Esto depende en gran parte de la naturaleza de los documentos que son producidos, y de la naturaleza de su distribución eventual. Si los documentos se pueden entregar usando el Internet, esto es ciertamente una avenida a considerar. A tal efecto haga uso los paquetes tales como MX del flash y Dreamweaver para alcanzar esta meta. Para la ayuda en línea integrada, usted puede desear crear documentos crudos del HTML, o seleccionar alternativomente un paquete del especialista tal como RoboHelp o similar. En la caja de documentos basados de la impresión, usted necesitará seleccionar una paquete de software bastante de gran alcance para dirigir lo que usted lanzará en él.
Muchos autores técnicos inexpertos dan vuelta inmediatamente hacia Microsoft Word (pues es ubicuo adentro puede los ambientes comerciales y privados). A menos que su documentación vaya a estar debajo de 150 páginas, y de usted sepa crear plantillas y hacer macros, evite a MS palabra. Pues cualquier autor técnico le dirá tiene hábitos repugnantes todos lo que debe para poseer, y puede a menudo ser un paquete inestable a trabajar con. Si usted está creando la documentación pesada de los gráficos, usted puede desear considerar Quark Xpress, o elija potencialmente a líder de industria en el campo, adobe Framemaker. ¡Cualquier software usted selecciona, usted debe asegurarle llega a ser increíblemente perito con él, invirtiendo en el entrenamiento, o usándolo día después del día después del día!
¡Comuniqúese que qué le pagan para hacer!
Mucha gente le dirá que crear la documentación técnica sea aburrido y repetidor. Esta gente, es incorrecta, y posiblemente morons también. Aunque usted puede encontrar el proceso de crear la documentación técnica ' que agujerea ' (si usted hace usted está en el trabajo incorrecto!) no es. Crear documentos técnicos de la calidad es una etapa vital en permitir a gente utiliza a adecuadamente y correctamente tecnología. Aunque ningún usuario acercará a la documentación que usted crea de la misma manera que ella acerca a una novela, usted puede ayudarle en última instancia a alcanzar lo que él desea alcanzar con tecnología. No importa cómo ' embotado ' el proceso puede aparecer ser, permitir que los usuarios alcancen sus metas leyendo sus documentos debe darle acometidas del orgullo y de hecho, felicidad. Mientras usted recuerda los efectos positivos que la tecnología puede tener el las vidas de la gente, cuando usted crea sus documentos usted puede comunicarse más con eficacia, pues usted será más feliz en el proceso comunicativo. A través del ciclo vital de la documentación, usted debe intentar comunicar con los colegas tan a menudo como sea posible (si es aplicable). Déjelos leer sus documentos, escuchar sus críticas, y ajustar sus documentos (si usted no puede discutir su esquina!). Pagan para comunicarse, se cerciora de un autor técnico que usted lo hace, y nunca para olvidarse de porqué su se están comunicando, y quién, en los documentos ellos mismos.
Errores comunes a evitar de hacer
Al crear documentos técnicos allí sea un número de defectos fatales que usted puede hacer. Aunque de ninguna manera es exhaustiva, esta sección detalla algunos de los errores más comunes que los nuevos autores hacen, con la esperanza de que usted evite de hacerlos también:
Siendo Patronising - aunque la documentación técnica debe estar clara, debe nunca patronising. Usted no está creando los documentos que se leerán por los morons sino los consumidores y los clientes. Usted debe escribir siempre al nivel de habilidades de sus audiencias, pero no importa qué la gente llana técnica está encendido, ella no es morons. Incluso los niños consiguen ofendidos cuando patronised, no incurren en esa equivocación con alguien que está pagando su sueldo, niño o de otra manera.
Overuse del humor - la gente no lee los documentos técnicos que se entretendrán, ella los lee en las esperanzas con éxito de terminar un proceso, o de extraer la información. A menos que sea relevante al usuario del extremo, evite el humor donde sea posible. Si usted está escribiendo un libro, una multa y un bueno. Si usted está escribiendo un manual, evite el humor como la plaga, pues a menudo los usuarios faltarán la broma y el extremo justo para arriba que detestan al idiota patronising que escribió la documentación.
Inconsistencia - incluso en la etapa de bosquejo, usted debe asegurarse de que todos los elementos usados en su documento son constantes. Esto aplica tanto al ' tono ' del documento en cuanto a la disposición de él. Asegúrele el uso los sentidos constantes (primera persona, etc.) así como la disposición de página, elementos de las paginaciones, jefes y pies, y el resto de los elementos textuales.
Prueba leída - para el final de crear un pedazo de documentación técnica, usted será probablemente enfermo de la vista de ella. Eso no importa. Qué importa es qué sale de su oficina o casero, es exacto. A tal efecto la prueba leyó el documento a través de todos lo que es bosquejos, y antes de que se distribuya la prueba la leyó otra vez, y otra vez, y otra vez. Nunca confíe en los inspectores del encanto (ellos nunca trabajo) y si usted puede evitarlo, nunca confíe solamente en su propio juicio. Consiga su documento leído por tantos pares de ojos como sea posible antes de la distribución, después de todo, podrían manchar la una cosa que usted ha faltado a través del proceso de la creación.
Conclusión/promoción desvergonzada del uno mismo
La escritura técnica no está sin importar lo que usted puede pensar, un trabajo fácil. Requiere maestría, paciencia y una mezcla muy impar de habilidades. Justo como cualquier otro trabajo, usted puede aprender cómo a hágalo, pero incluso esa cuota necesariamente no le hará ningún bueno en ella. Ser buen autor técnico, usted tiene que ser anal con todo creativo, enfocado con todo comunicativo, y un experto flexible. Ésta, como usted puede imaginarse probablemente, no es ninguna tarea simple. Aunque usted puede pensar que creando documentos técnicos es fácil, la documentación exacta, constante y oportuna el crear a un alto estándar comercial es un papel altamente desafiador. Sin importar su presupuesto, en el funcionamiento largo proporcionará el ROI significativo si usted emplea a especialista. Después de todo, podrán hacer en días, qué usted se rasga el pelo el nuestro procurar lograr en meses de las semanas si no.
Sobre El Autor
Sobre los años Mike Kemp se ha empleado como independiente ÉL periodista (que trabaja para las publicaciones tales como el registro, el Namesfacesplaces, el foco de la seguridad y el Packetstorm), un copywriter, un diseñador de los juegos de video, un interventor de la seguridad, un diseñador de la tela, un diseñador gráfico y ÉL amaestrador. Él ha trabajado en una variedad de posiciones independientes y permanentes para ambos (e.g. dos hombres y compañías pequeños de un perro) a las organizaciones multinacionales a través del Reino Unido y de Europa. Al no trabajar en los varios artículos, los libros, manuales, y clasificado la otra copia para los clientes, Mike se pueden encontrar generalmente el trabajar en una variedad de novelas inéditas. Él ha tenido varios de sus guiones cortos producidos por las compañías independientes de la producción, y está trabajando actualmente en varios las escrituras de la longitud de la característica.
Mike vive sobre todo feliz en un suburbio terrible un-bohemio de Londres con su (y largo-sufriendo) socio a largo plazo, y dos addled gatos. Para aprender más sobre Mike, la gama de proyectos él ha estado implicado adentro, y la otra materia y absurdo clasificados, visitan por favor su homepage personal en www.clappymonkey.com.
Artículo Fuente: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster obtener el código html
Añadir este artículo a su sitio web ahora!
Webmaster Envíe sus artículos
No es necesario que se registre! Completa el formulario y su artículo está en el Messaggiamo.Com Directorio!
