El propósito, contenido y estructura de los manuales

Definición

Boris trabaja en el departamento de TI de una gran empresa y está a punto de implementar un nuevo programa de software personalizado que será utilizado por la mayoría de los empleados. Dado que el software es nuevo y propiedad de la empresa, los empleados no solo no tendrán experiencia en su uso, sino que tampoco habrá ayudas de aprendizaje externas disponibles.

En consecuencia, parte del trabajo de Boris será preparar un manual para los empleados. Un manual es un documento que proporciona instrucciones o pautas sobre cómo realizar una actividad y sirve como libro de referencia sobre la actividad.

Contenido y finalidad

Los manuales son documentos flexibles que se pueden utilizar para diferentes propósitos:

• Los manuales de políticas explican y describen los principios y reglas de una organización. Por ejemplo, el manual de políticas de una empresa puede abordar cuestiones como la visión y misión de la empresa, el código de ética de la empresa y las pautas de los empleados relacionadas con las actividades laborales, la compensación y los beneficios.
• Los manuales de procedimientos explican cómo se debe realizar una actividad laboral. Por ejemplo, una empresa puede tener un procedimiento para denunciar un incidente de acoso sexual o discriminación en el lugar de trabajo. Tenga en cuenta que un manual de políticas le dice qué es una política y quizás por qué está implementada, mientras que un manual de procedimientos puede indicarle cómo llevar a cabo una actividad relacionada con la política.
• Los manuales de operaciones son similares a los manuales de procedimientos, pero se centran en las actividades laborales diarias. Por ejemplo, el gerente de un restaurante puede tener un conjunto de actividades que debe realizar antes de abrir el negocio.
• Los manuales del usuario y los manuales del operador sirven como guía y referencia para el uso de una herramienta o equipo en particular. El documento que Boris está redactando para proporcionar instrucciones y orientación para el uso del nuevo software de la compañía se incluye en esta definición.
• Los manuales de servicio y mantenimiento proporcionan instrucciones sobre cómo mantener y reparar el equipo. Por ejemplo, una fábrica puede tener un manual de servicio y mantenimiento para sus cintas transportadoras.
• Los manuales de capacitación están escritos para brindar orientación a las personas nuevas en una organización o actividad laboral específica.
• Los trabajadores de los lugares de trabajo remotos utilizan los manuales de campo. Estos manuales están diseñados para ser autónomos, proporcionando todas las políticas, procedimientos e instrucciones que un trabajador necesita en el lugar de trabajo. Al mismo tiempo, los manuales de campo están diseñados para ser lo más cortos y concisos posible porque los trabajadores no quieren cargar con una biblioteca con ellos.

Materia delantera

La primera parte de un manual se conoce como su portada . La primera sección es la página de título, que debe estar escrita de tal manera que notifique al lector de qué trata el manual. A menudo se incluye una imagen visual del tema del manual para transmitir este punto. Por ejemplo, si el manual trata sobre el funcionamiento de una fotocopiadora en particular, se puede incluir una imagen de la fotocopiadora en la página de título. La página de título también debe estar fechada con un número de versión para realizar un seguimiento de las revisiones. También se debe incluir el autor del manual. Además de la página del título, un manual puede incluir:

• Una sección sobre el alcance, que le dice al lector lo que cubre el manual y, ya sea directamente o por inferencia, lo que no cubre.
• Una tabla de contenido, especialmente si el manual tiene más de unas pocas páginas.
• Una lista de equipos, herramientas y piezas si el manual proporciona orientación sobre la instalación, reparación o mantenimiento.
• Y si el manual cubre un tema peligroso, como la manipulación de equipos o productos químicos peligrosos, tendrá una sección de alertas, advertencias y consideraciones especiales.

Cuerpo

El núcleo del manual es su cuerpo . Aquí es donde Boris proporcionará una guía paso a paso a los usuarios del nuevo software. Boris seguirá las recomendaciones descritas por Dobrin et al. en su obra “Comunicación técnica en el siglo XXI”.

Boris se asegurará de agrupar los pasos similares de una manera lógica. Por ejemplo, comenzará con los pasos para instalar el programa de software. Luego pasará a explicar los pasos para realizar las funciones básicas del programa que utilizarán todos los empleados. A continuación, discutirá los pasos para lograr las funciones más avanzadas del programa que solo usarán unos pocos empleados seleccionados. Finalmente, discutirá los pasos que los empleados con privilegios de administrador deben realizar para realizar ciertas tareas especiales, como agregar acceso para un nuevo empleado.

También formateará el cuerpo para que sea fácil de leer, haciéndolo claro y conciso mediante el uso de verbos de acción y numeración. Limitará cada paso a una acción y se asegurará de que cada paso esté separado visualmente de los demás. Boris incluirá elementos visuales como capturas de pantalla y diagramas de flujo de las pulsaciones de teclas o clics del mouse para ayudar a los empleados a comprender el texto. También realizará los pasos que escribe en el software para asegurarse de que los pasos realmente hagan lo que dicen que harán.

Materia trasera

Después de completar el cuerpo del manual, Boris pasará a la parte posterior del manual , que es la sección final de un manual. Aquí, Boris puede agregar un glosario si hay una gran cantidad de términos técnicos que serán desconocidos para los empleados. También puede agregar un índice para ayudar a los empleados a encontrar rápidamente información específica, como iniciar sesión en el software desde una ubicación remota. Boris también agregará una sección de resolución de problemas para abordar las respuestas a problemas comunes. Finalmente, algunos manuales tendrán información de mantenimiento como parte de la parte posterior.

Resumen de la lección

Repasemos lo que hemos aprendido. Un manual proporciona instrucciones o pautas sobre cómo realizar una actividad y sirve como libro de referencia sobre la actividad. Los diferentes tipos de manuales incluyen:

• Manuales de políticas
• Manuales de procedimiento
• Manuales de operaciones
• Manuales de usuarios y operadores
• Manuales de servicio y mantenimiento
• Manuales de formación
• Manuales de campo

Los manuales se estructuran en tres componentes generales: la forma frontal, la corporal y la trasera. La portada contiene la página de título, la sección de alcance, advertencias y precauciones, así como una tabla de contenido. El cuerpo del manual describe los pasos que el lector debe realizar para participar en la actividad que cubre el manual. Finalmente, el asunto anterior puede incluir una sección de solución de problemas, una sección de mantenimiento, un glosario y un índice.

Descripción general de los manuales

Resultado de aprendizaje

Cuando termine la lección, tendrá la oportunidad de:

• Definir manual
• Describir los distintos tipos de manuales.
• Identificar cómo se compone un manual