Cómo hacer un manual (de verdad)

Para una versión humorística de este texto podéis ver el Manual sobre cómo hacer un manual sobre cómo hacer un manual.

En nuestra web está disponible un documento bastante curioso llamado “Cómo hacer un manual sobre cómo hacer un manual sobre cómo hacer un manual“. A pesar de lo que pueda parecer, ese texto está redactado en tono humorístico, y difícilmente puede servirle de ayuda a alguien.

Para solucionar esto, y viendo que algunas personas (muchas) se sienten confusas al leer el manual y no saben por donde empezar, hemos decidido publicar un verdadero manual sobre “Cómo hacer un Manual“. Así pues, empieza el verdadero Cómo Hacer un Manual, de verdad.

1. El Tema

Lo primero que hay que saber es el tema que queremos tratar en nuestro manual. Aunque parezca obvio, si no tenemos un tema bien definido lo más probable es acabar tratando aspectos que originalmente no se querían tratar. Debemos tener claro el tema genérico y el nivel de concreción que va a tener nuestro manual. No es lo mismo hacer un manual de introducción a la química que un manual sobre química inorgánica avanzada.

También hay que evitar irse por las ramas.

2. El Público

Si ya tenemos el tema escogido, debemos definir nuestro público objetivo (nuestro Target) y comprobar que se adapta a nuestro tema. No es lo mismo hacer un manual para principiantes que para expertos en una materia. Nuestro público determinará el lenguaje que usaremos en la redacción del manual.

El tema y el público objetivo están estrechamente relacionados. Por ejemplo, no podemos pretender escribir un manual sobre integrales y derivadas para niños de 10 años. Hay que tener esto en cuenta puesto que es determinante en el éxito o fracaso de nuestro manual.

3. El medio

El medio de difusión de nuestro manual es también sumamente importante. No tiene nada que ver un manual online con un manual impreso. Si publicamos un manual online, debemos tener claro que la gente no lee los textos largos por falta de tiempo y de motivación, por lo que es mejor hacer párrafos cortos y sencillos. Los medios tradicionales como los libros son muy distintos, y no vamos a tratarlos aquí.

Cuando ya hemos escogido el tema, el público y el medio, lo más recomendable es buscar manuales ya hechos que coincidan con el nuestro. Esto nos puede ayudar a tomar ideas y a no olvidarnos cosas al redactar nuestro manual.

4. La estructura

La redacción es la parte a la que dedicamos más tiempo, pero lo primero que hay que hacer antes de escribir cualquier cosa es organizar nuestras ideas. Si estamos escribiendo un manual, seguramente sabemos qué es lo que buscan o quieren conseguir los posibles lectores de ese manual.

Hay que tener en cuenta que los lectores, posiblemente, saben mucho menos que tu del tema. Hay que explicarles todo paso a paso: adaptando el mensaje al más tonto de los posibhles lectores. Por esto una correcta estructuración de los contenidos les ayudará a no perderse. Lo más básico que podemos hacer es elaborar una lista de puntos importantes que queremos tratar y posteriormente ordenarlos. Estos puntos importantes pueden convertirse en capítulos de nuestro manual.

5. Redactar el Manual

Con el tema y el público bien definido, y una estructura adecuada, ya sólo falta empezar a escribir el manual. Esta es la parte más complicada del proceso y también es la que más depende de la persona que escribe. Para redactar un buen manual se necesita mucha paciencia y perseverancia, y la creatividad y talento de cada uno influirá directamente en el resultado final.

Para cada capítulo de la estructura que hemos definido, se puede escribir una pequeña introducción. Cuanto más compleja y larga sea la introducción, más lectores vagos perderemos, pero los interesados en el tema probablemente estén más satisfechos. Además, resulta útil y bastante eficaz intentar mantener un flujo de información a través de nuestro texto, es decir, hacer referencias a lo que ya hemos escrito para que el lector entienda las relaciones entre cada capítulo.

Como ya habéis visto, es mejor hacer párrafos cortos cuando se está escribiendo para publicar online. También es interesante intentar resumir después de cada tema los contenidos de los que se han hablado, pero solamente si es difícil entenderlos o si la extensión del capítulo impide retener correctamente su contenido. En caso de escribir capítulos cortos y breves, es mejor redactar unas conclusiones finales para todo el manual, resumiendo lo que se ha explicado a lo largo de este en unas pocas frases. Esto es especialmente útil para los más vagos (los que no se van a leer el manual entero).

6. Después de publicar

Es importante no olvidarse de lo que hemos escrito una vez ha sido publicado. Los usuarios y lectores pueden aportar grandes ideas o mejoras y es de gran utilidad tenerlos en cuenta para hacer pequeños cambios. Además, las personas cometen errores, y es mucho más probable que otros detecten nuestros fallos que no hacerlo nosotros mismos.