Cómo elaborar un manual

Información del autor

Escribir un manual de instrucciones puede parecer una tarea demandante, pero es más fácil de lo que crees. Estos consejos se pueden aplicar a cualquier manual de instrucciones escrito, desde los más simples hasta los más complicados.

Método 1

Método 1 de 4:
Conoce el tema

1
Esta es la clave. Puede ser obvio, pero el conocimiento del tema es la clave para escribir un manual exitoso. Por ejemplo, si estás escribiendo un manual de una cámara, saber que el F-stop y que la velocidad de obturación no solo son funciones separadas – porque lo son- pero saber cómo ambas interactúan hará mucho más fácil la forma en que describirás cada función.
2
Habla con expertos. Si tu papel es simplemente ser el escritor en lugar de ser un experto en la materia, involucra a gente con el conocimiento necesario durante el proceso y asegúrate de que revisen tu trabajo. Su conocimiento y consejo son invaluables.
3
Intenta hacer un acercamiento práctico. Si es posible, pon en práctica sobre lo que estas escribiendo, al menos de esta manera puedes sentir lo que el usuario aprenderá.
4
Lee sobre el tema. Aprende a platicar sobre lo que se platica, y conoce el producto del cual estas escribiendo.
- Los manuales o productos similares te enseñarán como otras personas han abordado el tema.
  - Busca similitudes entre los escritores, lo que indica que ambos tiene una funcionalidad común y enfoques comunes para describir algo.
  - Buscar diferencias que destaquen. Estas pueden ser funciones que son únicas en un producto. Tu producto puede o no puede tener estas funciones, o puede tener maneras alternativas de resolver el problema que puedes describir, realzando el valor del producto. Aunque tu trabajo sea escribir como hacer algo, mostrarle al cliente el valor de su compra es una buena manera de motivarlos a continuar leyendo.
- Lee revistas de comercio. Descubre como la gente usa estos productos trabaja con ellos día a día. Puede que ellos deseen que exista una función que resuelva un problema en particular, y si tu producto es la solución, debe ser destacado.

Método 2

Método 2 de 4:
Planea el diseño de tu manual

1
Desglosa Paso a paso. Ya sea escribiendo una hoja de instrucciones paso a paso o un manual para una cámara digital, desglosar cada paso tiene sus beneficios:
- Te permite enfocarte en partes individuales. Tu meta es familiarizar al usuario al aprender el proceso. Puedes dejar la parte de cómo realizar la función para el final del tutorial, si así lo deseas, o dejar que el usuario lo descubra por sí solo.
2
Sigue una secuencia lógica. No sería bueno si por ejemplo, describes como el flash de una cámara funciona hasta que hayas explicado cómo colocar los lentes o cargar la película, encender la cámara y ajustar el enfoque. Esto es útil especialmente si no estás familiarizado con el tema.
3
Utiliza esto como modelo para tu tabla de contenidos.
4
Revisa tus pasos. Una vez que hayas definido las secciones lógicas, revísalas para asegurarte de que has cubierto todo.
5
Reúne tus provisiones. Ten el artículo que estás describiendo a mano y listo para ser usado mientras lo describes en el manual. Si estás haciendo una caja de cartón, debes tener, papel, tijeras, cinta adhesiva, pegamento y regla a la mano. Si estás escribiendo sobre una cámara, asegúrate de tenerla desmontada. Si es posible, el producto del que estas escribiendo debe estar empacado.

Método 3

Método 3 de 4:
Empieza a escribir

1
Escribe la introducción. Esto fijará el tono de todo el manual, y le dará una idea al usuario del tipo de manual que leerá. ¿Será entretenido o sin sentido? Dependerá de la persona que lee. Hay mucho más espacio para el juego verbal cuando escribes un manual para niños que cuando escribes un manual para un doctor. Establece el tono y mantén ese tono durante todo el manual.
2
Realiza cada paso mientras vas escribiéndolo. No solo te da algo de honestidad y autenticidad al escribir sino también te aseguras de no dejar cabos sueltos.
- Si por alguna razón, no es posible realizar el paso, analízalo profundamente y consulta con un experto.
3
Enumera los pasos. Esto facilita al lector que siga tus instrucciones, y para alguna referencia en el futuro si se pierde.
- Si lo estás escribiendo en un papel, asegúrate de dejar espacios para agregar anotaciones en cada paso. Recuerda reenumerarlo si agregas más pasos
4
Incluye consejos y advertencias. Mientras escribes puedes darte cuenta que si el usuario realiza un paso sin cuidado, puede ocasionar algún problema.
- Además si hay algún consejo que ayudará al usuario a facilitar alguna tarea o que lo haga más interesante, agrégalo.
5
Ponlo a prueba. Usando tus instrucciones escritas, ponlo a prueba. Si te das cuenta que algo le falta a tus instrucciones, agrega la información necesaria. Repite este paso hasta que todos estén completos, y puedas realizar lo que tratas de enseñar sin tener que agregar notas.
- Considera hacer que un amigo o dos usen el manual. Obsérvalos detenidamente cuando aprendan a usar el producto. Ve si en algún punto se pierden, se confunden o fallan. Escucha lo que tienen que decir, luego ajusta el manual.
6
Corrige tu manual. No querrás enviar tu manual (ya sea una agencia o tu esposa) con un sin número de errores.

Método 4

Método 4 de 4:
Formato

1
Empieza desde el principio. Una vez que tengas todos los pasos detallados, revisa el manual para encontrar los encabezados obvios.
- Coloca títulos, y anota su ubicación.
2
Escribe la tabla de contenidos, si es necesario. Observa la forma en que wikiHow lo hace como ejemplo, la pagina principal ofrece muchas secciones de encabezados. Cuando accedes a cada sección, enlista varias sub categorías, y las sub categorías listan artículos. Mientras más detallado sea tu manual, más categorías y sub categorías necesitará. (Cómo silbar, no necesita ninguna, mientras como tallar un silbato necesita algunas y como tocar una flauta necesita muchas.)
3
Vuelve a corregir una vez más. Si, ya lo hiciste una vez. Hacerlo una segunda vez indudablemente hará evidente pequeños errores o lugares en dónde tu manual no es lo suficientemente claro.
- Para realizar un manual mas entendible, puedes tomar esta oportunidad para anotar pequeños temas y usar esa información para crear un índice.
4
Selecciona el título.

Consejos

Si escribes un manual detallado que requiere de capítulos, tales como “Cómo tocar la flauta” el primer paso es listar los capítulos, como “Seleccionar la flauta, ensamblaje y cuidado, utilizar los dedos, tu primera pieza musical” etc. Puedes aplicar la regla básica para escribir un manual en cada capítulo porque cada capítulo es como escribir un manual por separado.
Aún cuando algo parezca obvio para ti, escríbelo en los pasos. Evitará que dejes espacio vacios sobre algo que el usuario no sabe. Es mejor incluir información extra en lugar de omitir pasos importantes.
Cuando sea posible, ilustra tus instrucciones. Si no puedes adjuntar imágenes, refiere al lector a algo común como ejemplo. Por ejemplo en Formato, paso 2 en estas instrucciones, el diseño de wikiHow es usado para ilustrar la tabla de contenidos.
Si puedes, haz que un aprendiz pruebe tu manual y que escriba cada pregunta que tenga. Esto te ayudará a llenar los espacios vacios y hacer tu manual más útil.
Escribir cada sección en hojas separadas (o en una computadora) hará que editarlo sea más fácil. Puedes arreglarlo fácilmente si tienes espacio para trabajar y puedes encontrar tus marcas de edición. En la computadora, deja de 3 a 4 líneas de por medio (al teclear Enter varias veces) de esta manera puedes agregar notas.