Este artículo describe estas actitudes y presenta métodos para superarlos. El resultado es documentos de usuario más eficaz y más satisfecho de los usuarios.
1. "Todo el mundo sabe"
La actitud de "Todo el mundo sabe que" hace suposiciones sobre el...
Palabras clave:
técnico escribiendo, manual de usuario, documento de instrucción
Cuerpo del artículo:
Visión general
Documentos de usuario incompleta decepcionar a sus lectores. Dos actitudes de muchos escritores técnicos como resultado documentos incompletos de usuario. Estas dos actitudes son:
. "Todo el mundo sabe que", y
. "El usuario puede entenderlo"
Este artículo describe estas actitudes y presenta métodos para superarlos. El resultado es documentos de usuario más eficaz y más satisfecho de los usuarios.
1. "Todo el mundo sabe"
La actitud de "Todo el mundo sabe" hace suposiciones sobre el conocimiento de los lectores. Estos supuestos causan su dolor de lector.
Este es un ejemplo de un posible "todo el mundo sabe". ¿Sabe usted:
Tomates. La mayoría de nosotros mantenerlos en un refrigerador. Sin embargo, almacenarlos en un refrigerador arruinará el gusto y la nutrición de tomates. Tomates se deben almacenar en un mostrador de la cocina a temperatura ambiente, hasta que se cortan. Una vez cortadas, tomates deben almacenarse a continuación en la nevera.
¿Todo el mundo sabe? ¿Lo suponemos que se sabe sobre su producto?
A veces los documentos de usuario tienen que superar la experiencia de usuario. Todos piensan que saben cómo correctamente (segura) cerrar una barbacoa... no! Se describe el método de apagado seguro en barbacoa más documentos de usuario, pero no "publicidad" (fuerza presentados) en los documentos del usuario.
Es rara vez cierto que "todo el mundo sabe". Sólo porque encontramos algo evidente, no significa que todo el mundo sabe que algo.
¿Este es otro ejemplo: cómo utilizar un (producto combinado--'2 en una') acondicionado champú y pelo? Cuando el champú, el champú es masajear en el cuero cabelludo y enjuagado inmediatamente. Cuando acondicionado el cabello, el acondicionador es masajear en el cabello y permanece en el cabello durante unos dos minutos. ¿Ahora, lo que los usuarios hacen del producto combinado: aclarar rápidamente, o dejar que el producto a permanecer en el pelo?
Si tiene la actitud de "Todo el mundo sabe" cuando se escribe, se tienden a dejar de lado el material necesario de su documento de usuario. Va a realizar un flaco favor a los lectores y para su escritura.
Cuando en duda si "todo el mundo sabe algo," asumir que no lo hacen. A continuación,
. Agregar texto explicando el tema, o
. diga al lector donde encontrar información que explicará el tema
Otra precaución
Tenga cuidado suponiendo que sólo porque explicó algo antes de documentar su usuario, tu lector recordará (o incluso leído) esa información. Es raro que los usuarios pueden leer la documentación del producto de principio a fin.
En caso de duda, agregue una referencia a la anteriores (antecedentes). Diga a su lector donde encontrarlo, o proporcionar un vínculo a ella si el documento es electrónico.
Aquí es un experimento de pensamiento: usted es un usuario de productos: ¿con qué frecuencia leer la documentación del producto de principio a fin? Si lo hace siempre, entonces pedir a otras personas. (La gran cosa acerca de este hecho, que los usuarios no leer la documentación de principio a fin--es que produce una gran flexibilidad en la escritura, formato y edición de la documentación del producto).
2. "El usuario puede entenderlo"
El usuario no desea tener que averiguar cosas. El usuario no está leyendo una novela de misterio o cualquier otra literatura, donde quiere reflexionar sobre lo que está sucediendo.
Cuando alguien utiliza su producto, que están utilizando para satisfacer sus propias necesidades. El producto puede ser fundamental para su vida, pero para los usuarios, su producto es un medio para un fin. Y no quieren tener que descifrar la documentación del producto.
Aquí hay un ejemplo simple. Un mensaje le indica que debe llamar a alguien, pero el mensaje abandona el número de teléfono. Se espera que para encontrar el número de teléfono por su cuenta. El escritor probablemente sabía el número de teléfono, pero dejó. Este "supervisión de información" obtiene caro dentro de una empresa, cuando el correo electrónico se envía a muchos empleados... cada buscar el número de teléfono en su propia.
Mi desprecio de mascota favorita: fechas. En la memoria reciente "sobrevivimos" la transición del año 2000. Sin embargo todavía escribimos fechas táctica. Utilizamos "06" durante un año, en lugar de "2006". Cuando vemos las cosas como "11/07/04" ¿cuál es la fecha en la a que se refiere? Es que el 4 de noviembre de 2007, el 11 de abril de 2007, o algunos otro permutación de los números. Las normas para el formato de las fechas varían en todo el mundo. Este es un ejemplo de dos supuestos:
. "todo el mundo sabe que" (porque no hay un formato de fecha "estándar"--no hay), y
. "El usuario puede entenderlo" (por ver si mis otras fechas proporcionan pistas sobre el formato)
No dejar las cosas para el usuario/lector averiguar por sí mismos. Le lleva sólo unos momentos para incluir el material de sus necesidades de lector y salvará a muchos lectores muchas horas en descubrir cosas.
Hazlo:
La literatura de escritura le "sabe el lector". Aquí es donde se utiliza ese conocimiento para mejorar su escritura.
O bien
. encontrar a alguien que es como tu lector prevista, o
. "lo mejor" para actuar como su lector previsto (puede hacerlo si es necesario)
En la lectura y evaluar el documento, buscar lugares donde
. la escritura asume que "todo el mundo sabe"
. la escritura espera que el lector pueda "entenderlo"
. la escritura hace saltos que no puede seguir su lector
. la escritura hace la suposición de que el lector ha leído y recordado todo el documento
Corregir estos lugares. Sólo tarda unas palabras o frases.
Todo el mundo será más feliz.
