Palabras clave:
documentación para el usuario, nuevo escritor, escribir, manuales de usuario, cómo escribir
Cuerpo del artículo:
VISIÓN GENERAL
En la documentación de usuario, usted dirigir su lector para realizar tareas con su producto. Si no digas a tu lector qué esperar cuando esas tareas, usted tendrá un lector desconcertado, insatisfacción y costosas llamadas al servicio técnico.
EJEMPLO: FILTRO DE AGUA DE ÓSMOSIS INVERSA
Compré y instalar un filtro de agua de ósmosis inversa. Las instrucciones me dijeron para llenar y vaciar entonces (las instrucciones tontamente utilizado el término "volcado," que habría causado la destrucción del sistema) el tanque.
El filtro tenía una capacidad de aproximadamente 100 litros por día. Por lo tanto esperaba el relleno inicial (tanque de 4,5 galones) a tomar menos de una hora. Después de aproximadamente una hora aún estaba llenando el tanque. Preocupados, llamé al soporte técnico. Me dijeron que tarda unas dos horas para llenar el tanque.
Una línea en la documentación de usuario habría eliminado esa llamada: "el tanque inicialmente dura 2 horas para llenar". Sin saber qué esperar que yo y tal vez otros usuarios, desperdicia tiempo y dinero para llamar a la línea de asistencia técnica.
EJEMPLO: ACTUALIZAR EL SOFTWARE DEL ROUTER
Tuve algunos problemas con mi router Cable/DSL (Internet-Ethernet). El panel de control interno muy fácil buscar y descargar actualizaciones para el software interno. El sistema me dijo que tardaría unos minutos para comprobar si hay actualizaciones (buenas), pero me ha dicho cuánto tiempo llevaría la actualización para realizar una vez he descargado el archivo.
El usuario no dice qué esperar en términos de tiempo es un error. Empecé la actualización y tras unos minutos de operación (trabajaba?) Canceló el proceso. Lo reinició nuevamente y decidieron esperar más para ver qué pasaba. Tardó unos minutos completados ya y con éxito.
Sólo tomaría una simple frase como "la actualización de software puede tardar hasta cinco minutos para completar" para reducir la ansiedad del usuario.
INDICADORES de progreso (como se muestra en un entorno de ventanas) a menudo son inútiles. Algunos van más allá de 100%, otros son logarítmicas: se mueven rápidamente en el tratamiento temprano y esperar, aparentemente al final, durante mucho tiempo mientras es completar el procesamiento. Considere la posibilidad de avanzar indicadores se refieren a la hora de operación, no el número de archivos.
Algunos indicadores de progreso o actividad no tienen nada que ver con el programa que están asociadas. He usado los comprobadores de virus que han terminado anormalmente, sin embargo, por mantener mover el indicador de actividad. Asegúrese de que los indicadores de progreso o actividad reflejan la actividad del programa asociado.
DESCARGAS DE ARCHIVOS HACERLO
No es un concepto nuevo de decirle al usuario qué esperar. Si nunca has descargado archivos, el sitio de descarga a menudo dirá cuánto el archivo tendrá para descargar, basada en la conexión a Internet.
EJEMPLO: INDICADORES DE SU PRODUCTO
Mientras la mayoría de los ejemplos de "contando al usuario qué esperar" ocupa el tiempo necesitada para completar una actividad, otros pueden estar relacionados con los indicadores y el rendimiento del producto.
Tengo un pequeño cargador inteligente que tiene una luz roja para cada una de las posiciones de la batería. Lamentablemente, es imposible entender el funcionamiento de estas luces, y no hay ninguna descripción de cómo funcionan.
Esto es lo que sucede. Cuando inserte primero la batería, se enciende la luz. Poco tiempo después (la carga todavía tiene muchas horas para ir), apaga la luz. En algún momento hacia el final del ciclo de carga la luz puede volver.
Esto es claramente confuso para el usuario. La expectativa del usuario es que cuando se apaga la luz, la carga se ha completado. Esto resultaría en un montón de frustración del usuario, como los usuarios intentará utilizar pilas "cargadas" que no fueron acusadas. Los desarrolladores del cargador de batería deben explicar el funcionamiento de estas pantallas.
LA LÍNEA DE FONDO
Diga a los usuarios qué esperar ya que utilizan el producto. A menudo esta información es la cantidad de tiempo necesario para que una operación completar. Para otros productos, tendrá que indicar al usuario qué significan los indicadores.
No deje sus documento lectores figura confundido o a la izquierda para cosas por cuenta propia. Ello reducir la comodidad de los usuarios con su producto y aumentar los costos de soporte técnico.
