Palabras clave:
escribir, usuario, documentos, manual, instrucción, guía, técnica escribir
Cuerpo del artículo:
Visión general
Nuestros títulos aburridas, estériles y manera de escrito hacen poco para alentar a nuestros usuarios a leer partes de la documentación del producto que sería especialmente beneficioso para ellos. Este artículo presenta dos ejemplos del mundo real, cómo logran sus usuarios y cómo corregir los problemas.
Legal no reduciendo las renuncias &
Aunque las secciones de la documentación Legal y descargo de responsabilidad son importantes para la protección de su empresa (y protección de su empresa debe ser un objetivo primordial en su trabajo), esto es que no lo que estamos hablando aquí. En su lugar, estamos debatiendo los temas de documento que a menudo se pasan por alto, pero son importantes para los usuarios.
Veremos dos ejemplos donde el escritor de documento debe empujar al lector a investigar material adicional. Mi sugerencia es para "anunciar" los temas, utilizando la tentación de escribir, para instar al usuario leer los temas pertinentes.
Una regla de vida (escritura)
Si un usuario conoce una manera de hacer algo, es reacio a aprender sobre otras maneras de molestar. Usted, como un escritor de documento, tiene que vender el lector sobre los beneficios de la forma "otro" (mejor).
Ejemplo: Microsoft Word (tm) estilos
La mayoría de los usuarios avanzados de Microsoft Word (tm) utilizan "estilos", en lugar de formato manual, para dar formato de sus documentos. Los usuarios nuevos y casuales no conocer esta poderosa herramienta (disponible en la mayoría de los procesadores de texto). Documentación para el usuario de Word no alentar el usuario para obtener información acerca de los estilos.
Usuario documento la palabra habla de caracteres de formato manualmente, párrafos, etc.. Más adelante en el documento hay una sección sobre "estilos". Pero ¿por qué debería el usuario, nunca leer esta sección? Estilos parecen ser simplemente otra forma de formato de caracteres, párrafos, etc.. La sección formato sólo les dijo cómo hacerlo.
Los usuarios poder saben que para nada más que unos pocos Carta de página, estilos proporcionan muchos beneficios.
Documentador: Vender el lector sobre temas importantes. Fomentar su usuario para leer el material adicional. Microsoft debería haber agregado algo como esto al final de la sección en formato manual:
"Te recomendamos que uses 'estilos' para dar formato a los documentos más de unos pocos Carta de página. Consulte el Capítulo XX para aprender acerca de los estilos".
Ejemplo: Gas barbacoa seguro apagar
Un titular de Gas barbacoa usuario documento dice: "How to Shut Off su barbacoa".
El lector piensa: "sé cómo hacerlo," y no leer el material.
Si los usuarios están haciendo cosas unsafely o incorrectamente soso titular será hacer nada para ayudarles a corregir sus formas. Vamos a intentar un titular más convincente para ello:
"Mayoría de la gente apaga sus barbacoas Unsafely: aquí es el camino correcto"
O incluso más centrada:
"Usted probablemente apaga su barbacoa Unsafely: aquí es el camino correcto"
Esta redacción suena están vendiendo un producto para el usuario. Pero no está. Utiliza técnicas de marketing para lograr que los usuarios leer material importante.
Por cierto: si tienes una barbacoa de gas, comparar cómo las instrucciones decirle a cerrar, frente a lo realmente apaga la barbacoa.
"Véase también" es demasiado blanda
No caer en la trampa de simplemente agregar secciones "Véase también" cuando proceda. Estos están OK para contar al lector dónde encontrar información adicional, pero no hacen nada para convencer a su lector para leer material adicional importante. Si el material es de beneficio real para el lector luego venderlos en leerlo. Compare estos:
* Consulte también: Estilos, Capítulo XX
* Te recomendamos que uses "estilos" para dar formato a los documentos más de unos pocos Carta de página. Consulte el Capítulo XX para aprender acerca de los estilos.
¿Si se lee el documento de usuario, que de las dos partidas anteriores para obtener información acerca de los estilos tendría? (Si usted la respuesta 'equivocada', entonces pedir a otras personas;-)
La línea de fondo
Vendiendo el lector sobre lo que usted (o sus expertos) consideran importantes (más allá de las declaraciones legales y renuncia de responsabilidad) está agregando sus conocimientos para el documento. En efecto, usted dice, "creo que debe leer este tema porque puede ayudarle". Es algo bueno que decir, especialmente porque refleja su buena actitud para el lector.
