No importa cuán ingenioso sea un inventor, programador o racionalizador, a veces sus creaciones simplemente no pueden usarse para el propósito previsto. La razón de esto es el manual de instrucciones redactado incorrectamente o su ausencia total. Pero incluso los inventores ingeniosos a veces escriben instrucciones tales que, aparte de los especialistas limitados, nadie puede leer estos artículos. Entonces, ¿cómo redacta correctamente un documento tan necesario?
Es necesario
- - conocimiento al cien por cien del dispositivo o producto de software para el que se está redactando el manual;
- - conocimientos en el campo de la lingüística;
- - habilidades de escritura.
Instrucciones
Paso 1
Un manual de usuario o, en otras palabras, un manual de operación es un documento diseñado para brindar asistencia en el uso de un determinado sistema a sus usuarios. Para compilar un manual de usuario, es necesario conocer el sistema descrito al cien por cien, pero mirarlo con los ojos de un estudiante ignorante. Suponga que se escribe un manual de usuario para una utilidad de software que aún no tiene análogos. Imagina que es la primera vez que utilizas este programa. Por donde empiezas ¿Qué es lo primero que debe saber? Organice este conocimiento en categorías de importancia.
Paso 2
Al dividir toda la información relacionada con su creación en grupos, ha elaborado un plan para escribir un manual de usuario. Comience a describir el trabajo en su programa desde cero, dejando para el final los detalles más difíciles, como reprogramar funciones o lidiar con errores críticos. En esta etapa, debe tener listo el contenido del manual del usuario, una de las partes obligatorias de este documento.
Paso 3
Si el manual que está creando está destinado a ser utilizado en una gran empresa, debe prestar atención a los estándares corporativos adoptados allí. Por ejemplo, en muchas empresas rusas no se aceptan manuales de usuario sin soporte ilustrativo, es decir, imágenes que expliquen lo que está escrito. Además del contenido, el manual del usuario debe contener otras partes obligatorias: - Anotación, es decir, una explicación de los objetivos generales del manual y del producto descrito; - una introducción, que describe los documentos relacionados con el manual del usuario y cómo para utilizar el manual; - secciones que explican el uso del producto en las diferentes etapas de su uso, por ejemplo, primeros pasos, reparación o mantenimiento; - sección de preguntas frecuentes y respuestas a las mismas; - glosario o índice temático.
Paso 4
Por lo general, un escritor técnico está involucrado en la creación de un manual de usuario, una persona que tiene todos los conocimientos necesarios tanto en el idioma como en el producto que se describe. Como redactor técnico sin formación, hay que tener en cuenta algunas reglas. En primer lugar, no debe abusar de términos especiales que no sean comprensibles para un usuario normal. En segundo lugar, se debe detallar y explicar cada término utilizado. En tercer lugar, debe escribir de la manera más clara y concisa posible. Finalmente, un escritor técnico debe poder mirar su propio texto a través de los ojos de un usuario común para poder ver las deficiencias de su propio texto.
Paso 5
Es bueno probar el texto terminado del manual del usuario en la práctica ofreciéndolo a una persona que no tuvo nada que ver con el producto descrito. Mediante esfuerzos conjuntos, es posible eliminar todas las deficiencias y trampas del documento.
