Contenido
Los manuales de instrucciones son una excelente aplicación en el campo de la escritura técnica. Un buen manual de instrucciones le dará al usuario todo lo que necesita para ser capaz de dar secuencia a una determinada tarea de manera eficiente y con seguridad.
instrucciones
-
Identifique a las personas para quienes la tarea será destinada y escriba pensando en el nivel de comprensión de ellas. Saber su público objetivo es una parte fundamental en la escritura técnica.
-
Escriba un resumen delante del manual si tiene más de algunas páginas. Si el manual es demasiado largo, incluya un índice en la parte trasera.
-
Escriba una breve introducción que describa la tarea en términos cualitativos. Dale al usuario una idea de la tarea y cuál será el resultado final. Esta oportunidad debe ser usada para proporcionar consejos importantes que ayudarán al usuario a hacer la tarea correcta y eficientemente.
-
Cuando sea necesario, proporcione una lista de equipos y elementos relevantes que el usuario necesitará para completar la tarea. Si su manual de instrucciones es para el montaje de un producto y se adjunta al producto que se va a montar, incluya una lista separada de todas las partes que se hayan suministrado al usuario.
-
Cita claramente cualquier riesgo significativo que pueda causar heridas, muerte, daños a la propiedad y otros peligros. Utilice un lenguaje apropiado con las leyes del lugar donde se vendrá el manual.
-
Escriba cada acción de la instrucción en un paso distinto, proporcionando toda la información que el usuario necesitará para completar ese paso. La escritura debe ser literal, directa al punto y no puede ser ambigua.
-
Si hay espacio en su manual, incluya figuras y diagramas cada vez que sea aclarar un paso difícil para el usuario.
-
Si lo considera necesario, cree e incluya una lista de consejos para guiar al usuario a completar la tarea.