* El costo de la segundo, surge el tiempo perdido de sus empleados tratando de...
Palabras clave:
escritura técnica, documentos internos
Cuerpo del artículo:
VISIÓN GENERAL
Muchas organizaciones producen herramientas internas o modificación herramientas disponibles en el mercado para su propio uso. Estas herramientas deben obtener documentadas por lo que son de utilidad para otros en la organización.
Si esta documentación no se crea o está mal escrita, te cuesta dos veces:
* El primer costo (atribuido a cualquier documento de usuario pobres) es el costo de responder a preguntas de los usuarios (soporte técnico).
* El costo de la segundo, surge el tiempo perdido de sus empleados tratando de comprender el documento de usuario pobres.
Costos psicológicos también afectan el usuario interno y externa.
EL PRIMER COSTO: SOPORTE TÉCNICO
Éste es el costo que incurre cuando no se produce pobres (o) documentos del usuario. Para cualquier usuario surge cuando necesita apoyo técnico. Para los usuarios externos, el costo es su personal de soporte técnico, al número gratuito de teléfono, etc..
Para los usuarios internos el costo es el tiempo dedicado por el desarrollador o el modificador de la herramienta para responder a las preguntas de su compañero empleado. Esto es un técnico caro gastos... estas personas de apoyo normalmente cobran más de su personal de soporte técnico. Así, este primer costo es aún mayor para pobre documentación interna que mala documentación lanzada al público.
EL COSTO DE SEGUNDO: LOS USUARIOS DE TIEMPO Y RECURSOS
Para usuarios fuera de la empresa, el costo de la segundo es asumido por los usuarios propios o sus empleadores. Estos usuarios confundidos están gastando tiempo de su empresa: el tiempo perdido intentando conseguir el producto para trabajar, y el tiempo dedicado a tratar con el soporte técnico.
Para los usuarios internos, este costo corre a cargo de su empresa. Es su empleado--en su momento--que está perdiendo sus recursos de empresa trata de utilizar un producto arcano o documento. Aquí es donde la documentación interna deficiente cuesta dos veces.
COSTOS PSICOLÓGICOS AFECTAN A TODOS LOS LECTORES
Además de estos tiempo y costos monetarios, existen los costos psicológicos causados por mala documentación para el usuario.
Para los frustrados usuarios fuera de la empresa, la documentación de pobre resultados en una percepción negativa de la empresa y sus productos. Esto puede resultar en pérdida de negocio.
Para los usuarios dentro de su empresa, el costo psicológico es moral de los empleados de disminución, como lo demuestran estas declaraciones posibles:
¿* Nuestra compañía produjo esta basura?
* Estas personas no son una fuerte como pensé que eran.
* Si otros empleados esto pueden producir confundir las cosas, entonces puedo trabajar en ese mismo nivel.
Por lo tanto la mala voluntad fuera de la empresa puede costar ventas futuras; la mala voluntad dentro de su empresa puede costar en la moral de los empleados de disminución.
SOLUCIÓN: COMENTARIOS INFORMALES
Una vez que alguien escribe un documento de usuario para una herramienta interna, ese documento debe revisarse informalmente.
SELF-REVIEW
El autor puede realizar el primer examen en su propia.
Utilizar el corrector ortográfico de su procesador de palabras para corregir errores comunes. Puede utilizar corrector gramatical del procesador de textos, sin embargo, la mayoría de ellas es inexacta.
Antes de hacer esta revisión, que el documento reposar un día o dos. Esto le ayudará a olvidar lo que entiende en su escritura clara. Cuando haces el examen y te encuentras preguntando "¿qué refería aquí?" habrá encontrado un lugar en el documento que necesita una revisión.
Cuando se realiza la revisión, imagina que eres usuario de la herramienta y el lector del documento. Imaginar las tareas que el usuario de la herramienta quiere hacer. ¿El documento permite al lector encontrar lo que necesita? ¿Es precisa la escritura (describe correctamente la herramienta), claro y completo? Realice los cambios que mejoren el documento.
REVISIÓN EXTERNA
A continuación, si es posible, utilice un revisor externo (dentro de su empresa). Para ello, el escritor debe:
1. Encontrar 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 de la herramienta como razonable.
2. Que ese revisor utilice el documento que le guía en el uso de la herramienta. Solicitar comentarios sobre el documento. Tenga en cuenta los cambios sugeridos, adiciones, eliminaciones, aclaraciones solicitadas por el revisor. Algunas preguntas pueden incluir:
¿* El documento decirle lo que necesita saber?
* ¿Es fácil encontrar lo que necesita en el documento?
* ¿El documento responde a sus preguntas? Si no, qué preguntas sin respuesta?
¿* Es fácil seguir el documento? ¿Si no es así, donde están las áreas problema?
3. El escritor debe hacer cambios que sean necesarios.
Si no puede realizar este examen "semiformal", entonces conseguir alguien que no sea simplemente leer el documento, y formular propuestas para la mejora.
PRECAUCIÓN
Asegúrese de que el proceso de revisión no se hace una inhibición que escribir la documentación de usuario para los usuarios internos. Destacar un mecanismo cooperativo de--no contradictorio--cuyo resultado es un trabajo de calidad. No intente crear el documento de usuario perfecta.
