lo pobre de la casa documentos de usuario le costará dos veces y qué hacer al respecto

visión de conjunto

Muchas organizaciones producen en herramientas internas o modificar comercialmente disponibles herramientas para su propio uso. Estas herramientas deben quedar documentados por lo que son de utilidad para otros en la organización.

Si esta documentación no se crea ni se escribe mal, no te cuesta dos veces:

* El costo inicial (atribuido a cualquier documento de usuario pobre) es el costo de responder a las preguntas de los usuarios (apoyo técnico).

* El segundo costo, se debe a la pérdida de tiempo de sus empleados tratando de entender el documento del usuario pobre.

Costos psicológicos también afectan tanto al exterior y el usuario dentro de la empresa.

el costo inicial: apoyo técnico

Este es el costo que incurren cada vez que se producen pobres (o no) los documentos del usuario. Surge para cualquier usuario cuando él / ella necesita asistencia técnica. Para los usuarios externos, el costo es de su personal de soporte técnico, líneas gratuitas de teléfono, etc

Para usuarios internos el costo es el tiempo empleado por el promotor o modificador de la herramienta para responder a las preguntas de su su / compañero de trabajo. Se trata de un alto costo de asistencia técnica … estas personas se les suele pagar más de su personal de soporte técnico. Así, este primer costo es aún mayor para los pobres en casa-documentación de mala calidad para la documentación a disposición del público.

el segundo costo: el tiempo de los usuarios y los recursos

Para usuarios fuera de su empresa, el segundo costo es asumido por los propios usuarios o sus empleadores. Estos usuarios están confundidos gastar tiempo de su empresa: el tiempo perdido tratando de conseguir que el producto funcione, y el tiempo dedicado a tratar con su soporte técnico.

Para sus usuarios internos, este costo es asumido por la empresa. Es su empleado – en su momento – que está perdiendo sus recursos de la empresa tratando de usar un producto arcano o documento. Aquí es donde su deficiente in-house documentación que cuesta el doble.

costos psicológicos afectan a todos los lectores

Además de estos costos de tiempo y monetarias, están los costos psicológicos causaron por la documentación del usuario pobre.

Para usuarios frustrados fuera de su empresa, sus resultados documentación pobres en una percepción negativa de su empresa y sus productos. Esto puede resultar en la pérdida de negocio.

Para los usuarios dentro de su empresa, el costo psicológico disminuye moral de los empleados, como se evidencia de estas afirmaciones posibles:

* Nuestra compañía produce esta basura?

* Estas personas no son un fuerte como yo pensaba que eran.

* Si otros empleados pueden producir estas cosas confusas, entonces puedo trabajar en ese mismo nivel.

Así, la mala voluntad fuera de su empresa le puede costar ventas futuras, la mala voluntad dentro de su empresa puede llegar a costar en la moral del empleado disminuido.

solución: revisiones informales

Una vez que alguien escribe un documento del usuario de una herramienta dentro de la empresa, este documento debe ser informalmente crítica.

auto-revisión

El autor puede realizar la primera revisión en su su / propia.

Utilice el procesador de textos corrector de ortografía para corregir errores comunes. Puede utilizar corrector del procesador de textos de gramática, sin embargo la mayoría de ellos son inexactos.

Antes de hacer esta revisión, el documento deja reposar durante un día o dos. Esto le ayudará a olvidar lo que significó en su escritura clara. Al hacer la revisión y te encuentras preguntando “¿qué quiero decir?” se le han encontrado un lugar en el documento que necesita una revisión.

Al hacer la revisión, imagínese que usted es usuario de la herramienta y el lector del documento. Imagínese las tareas que el usuario de la herramienta quiere hacer. ¿El documento que el lector pueda encontrar lo que él / ella necesita? Es precisa la escritura (describe correctamente la herramienta), clara y completa? Realice los cambios que mejorarían el documento.

revisión externa

Luego, si es posible, utilice un revisor externo (dentro de su empresa). Para ello, el escritor debe:

1. Buscar a un usuario potencial de la herramienta. Esto debe ser alguien que no está familiarizado con la herramienta, y lo más parecido a la audiencia objetivo de la herramienta como razonable.

2. Ha opina que utilizar el documento para guiar a él / ella en el uso de la herramienta. Solicitar comentarios sobre el documento. Tenga en cuenta los cambios sugeridos, adiciones, supresiones, aclaraciones solicitadas por el revisor. Algunas preguntas que hacer pueden incluir:

* ¿El documento le dirá lo que necesita saber?
* Es fácil encontrar lo que necesita en el documento?
* ¿El documento de respuestas a sus preguntas? Si no es así, ¿qué preguntas son respondidas?
* ¿Está el documento fácil de seguir? Si no es así, ¿dónde están las áreas problemáticas?

3. El escritor debe hacer los cambios necesarios.

Si no puede realizar esta “semiformal” revisión, a continuación, obtener cualquier persona que no sea usted simplemente leer el documento y hacer sugerencias de mejora.

precaución

Asegúrese de que el proceso de revisión no se convierta en una inhibición de los Documentos del usuario por escrito para usuarios internos. Estrés una cooperativa – mecanismo cuyo resultado es un trabajo de calidad – no adversarial. No trate de crear el usuario documento perfecto.