Deslizándose entre las tapas de un documento técnico

Cuando se prepara un largo manual de usuario, incluir todos los lectores de información necesitan y hacen que la información sea fácil de encontrar. Los siguientes son pautas para qué incluir.

Tabla de contenidos

Cada vez que el manual es más de 15 páginas, incluye una tabla de contenido para ayudar a los lectores a encontrar fácilmente lo que necesitan. Utilice líderes (.......) Para conectar a los sujetos a los números de las páginas para que los lectores pueden dirigir sus ojos a través de la página.

Algunos escritores usan números de capítulo internos. Por ejemplo, el capítulo 1 se numera 1-1, 1-2, 1-3, 1-4- Capítulo 2 se numera 2-1, 2-2, 2-3, 2-4, y así sucesivamente. Esto es diferente de la numeración consecutiva (1, 2, 3, 4). Utilice números de capítulo internos cuando se anticipa la actualización de uno o más capítulos. Si lo hace, le impide volver a numerar (y reimpresión) todo el manual.

Glosario

Si hay un indicio de que sus lectores no pueden entender toda la terminología en el manual, incluye un glosario al final. Definición de una palabra la primera vez que lo utilice no siempre es adecuada porque los lectores no leerán el manual de principio a fin como si fuera la gran novela americana. Van a utilizar para consultarlo cuando tienen una pregunta.

Si usted escribe la ayuda en línea, utilice las ventanas emergentes de términos. Si usted escribe documentos web, crear un enlace al glosario.

Índice

No todos los manuales necesitan un índice. El contenido del manual es el factor de compuerta, no la longitud. Ponte en la mentalidad del lector y pregunte: Si estuviera leyendo este documento, sería un índice ser útil? Si usted piensa que un índice le ayudaría, incluir uno. Sé muy sensible a las palabras lógicas que el lector puede buscar.

He aquí una historia de una mujer que compró un coche nuevo. Condujo a unas 25 millas cuando ella pasó por encima un poco de vidrio y tiene una rueda pinchada. La mujer quería cambiar el neumático a sí misma y sacó el manual del propietario. Comprobó en las siguientes letras en el índice:

• F para plana

• t para neumáticos

• j para jack

• c Para cambiar

La mujer no podía encontrar la información y no podía creer que el manual descuida una entrada tan importante. Ella finalmente se rindió y llamó a la American Automobile Association (AAA). Cuando regresó a casa, comenzó a revisar cada entrada de índice. Sí, había una entrada para cambiar una rueda pinchada. Fue bajo h para "Cómo cambiar..."

Al escribir para la Web, incluirá un mapa del sitio o algo equivalente.

Solución de problemas

No importa lo bien que escribe un manual técnico, los lectores tendrán problemas. La manera de abordar estos problemas es incluir una sección sobre resolución de problemas. Tabla 1 es una gran sección de solución de problemas de la Guía de usuario de la cámara Kodak DC215 Digital Zoom. Rompe el problema, la causa y la solución.

Tabla 1: Solución de problemas de la cámara digital con zoom Kodak DC215

Cuando se incluye una sección sobre la solución de problemas - o preguntas frecuentes (FAQ) en un documento electrónico - que perdonas la gente en el oído Help desk coliflor. Aquí está la manera de pensar a través de lo que debe incluirse en la sección de solución de problemas:

• Si esta es la primera edición del manual, pensar en las preguntas o problemas que sus lectores puedan tener. Asegúrese de incluir preguntas que los evaluadores tenían durante la alfa y beta testing.

• Si se trata de una segunda o tercera edición, preguntar a la gente en la mesa de ayuda para las preguntas más frecuentes.

Formulario de comentarios

Para mejorar la calidad de su manual para la siguiente impresión y mejorar la calidad de su propia escritura, incluir un formulario de comentarios. Esta forma da a los lectores la oportunidad de hacerle saber lo que le gusta y lo que no de el manual y para hacerle saber de los errores que encontraron.

No molesten si le da retroalimentación principalmente negativo. Los lectores que están satisfechos con el manual general no se molestan en responder. Los lectores que no están contentos quieren saber. Tome esta retroalimentación constructiva y utilizarla como una oportunidad para mejorar su técnica de escritura. No tome como algo personal.