Cómo escribir Manuales Técnicos

Una explosión en la tecnología ha impulsado la necesidad de manuales técnicos , pero la mayoría son o tan difícil o tan aburrido de leer que los usuarios les echan a un lado y terminan llamando a centro de soporte técnico de la compañía . De hecho , los manuales tienen tan mala reputación que muchos consumidores simplemente llaman a la línea de ayuda del producto antes de siquiera consultar el manual. Si usted puede escribir un manual técnico que ayuda al usuario a cumplir su cometido en un lenguaje claro y fácil de entender , sólo puede llegar a los consumidores a leer y guardar centro de soporte técnico una vez más el llamado de su empresa en busca de ayuda . Instrucciones Matemáticas 1

Entrevista a los expertos en la materia (PYME) para descubrir " la verdadera historia " detrás del producto . Cuando explican cómo funciona el producto en términos técnicos , pídales que le expliquen lo que eso significa para el consumidor . El consumidor compra la tecnología para ayudarles a hacer algo. El manual tiene que ayudarles a utilizar su tecnología para hacer ese algo. Ellos no se preocupan por la avanzada ingeniería detrás de él .
2

Explicar el problema está resuelto. Muchos manuales técnicos dedican páginas y páginas que explican todas las características técnicas de sus productos , dejando de lado a explicar por qué un consumidor va a querer usar esas características. Explicar por qué el consumidor debe preocuparse por una característica particular. Por ejemplo , esta función nueva y mejorada le permite comprobar su correo electrónico mientras navega por Internet --- y es mucho más fácil de usar que la función de edad.
3

Escribir para ayudar a los consumidores a lograr una actividad. Hacer las explicaciones breves y sencillas e incluyen ilustraciones . Recuerde , la gente no quiere leer los manuales; quieren utilizar el producto para realizar su actividad.
4

Escribe en un estilo sencillo y coloquial . Explique la actividad como si estuviera hablando con su mejor amigo. Su tono debe sonar algo como esto : " Esta es una característica realmente grande Déjame decirte por qué Esto es lo que puedes hacer con él . . . "
5

Trate de crear " ¡ajá! " momentos para el usuario , como en , " ¡Ajá! Así es como se hace eso ! "
6

Edite su manual para eliminar secciones excesivamente prolijos o técnicos . Asegúrese de que su escritura es clara, sencilla y fácil de entender. Ejecutarlo por un amigo o colega que tiene poca experiencia con el producto . Pídale que hacer los pasos necesarios y si es fácil de seguir .
7

Que sea agradable de leer . Mantenga su luz por escrito y conversacional y no tenga miedo de añadir un poco de humor o una anécdota divertida . El más "divertido " el manual es leer , los más probables consumidores leen --- y menos probable será que llamar a la línea de ayuda del producto .