Cómo escribir un manual

Contenido

Pasos
Consejos

Escribir un manual puede parecer una tarea abrumadora, pero es más fácil de lo que piensas! Los pasos de este artículo se pueden usar para cualquier tutorial escrito, ya sea una instrucción bastante simple (cómo aplaudir) o muy complicada (cómo construir un semiconductor).

Pasos

Método 1 de 4: Conocer el tema

Imagen titulada Encuentra un trabajo si tienes una discapacidad Paso 3

1. Esto es lo más importante que hacer. Puede parecer obvio, pero el conocimiento es la clave para escribir un manual exitoso. Por ejemplo, si está escribiendo un manual para una cámara fija, es útil saber que el número de apertura y la velocidad de obturación no son solo dos funciones separadas, lo son, pero saber cómo interactúan las dos ayudará mucho. más fácil para usted describir cada función en relación con el todo.

Imagen titulada Éxito en el mercadeo en red Paso 16

2. Habla con expertos. Si su papel es simplemente un escritor y no un experto en el tema, involucre a personas con conocimientos durante todo el proceso y asegúrese de que revisen y revisen su trabajo. Sus conocimientos y consejos son invaluables.

Imagen titulada Conviértete en una pequeña modelo Paso 7

3. Pruebe un enfoque práctico. Tener la capacidad de hacer realmente las cosas sobre las que escribe al menos le dará una idea de qué es exactamente lo que el usuario querrá saber.

Imagen titulada Piensa como un diseñador gráfico Paso 12

4. Leer sobre el tema. Aprenda la jerga y conozca bien el producto sobre el que está escribiendo.

Consulte guías de productos similares para ver cómo otros escritores han abordado el tema.

Busca similitudes entre los escritores. Esto le brindará más información sobre las funcionalidades comunes y las formas habituales en que se aborda la descripción del producto.

Busque diferencias notables. Estas son probablemente las funcionalidades que son exclusivas de un producto en particular. Su producto puede o no tener estas funcionalidades, o tener otras formas de resolver el problema. Puede describir estas formas y así aumentar el valor del producto. Si bien su trabajo puede ser escribir una instrucción, mostrar a los clientes el valor de su compra es una excelente manera de alentarlos a seguir leyendo.

Devorar revistas comerciales. Descubra cómo las personas que usan los productos trabajan con ellos día a día. Es posible que deseen que haya una funcionalidad que resuelva su problema específico. Si tu producto es la solución, tienes que mostrarlo claramente.

Método 2 de 4: Diseña un diseño para tu manual

1. romperlo en pedazos. Ya sea que se trate de una guía simple y rápida que explica todo paso a paso, o de una guía completa para una cámara digital de 35 mm, dividir la información en fragmentos pequeños tiene múltiples beneficios:

Puedes centrarte en las partes individuales del todo. Su objetivo es familiarizar al usuario con la forma de aprender el proceso. Puede decir cómo se debe realizar la función en un tutorial al final si lo desea. También puede dejar que el usuario lo descubra por sí mismo.

2. Usa un orden lógico. Por ejemplo, no es una buena idea describir cómo funciona el flash de una cámara hasta que haya mostrado cómo colocar la lente, insertar el rollo de película, encender la cámara y enfocar. Esto es especialmente útil si no conoce muy bien el tema.

Imagen titulada Escribe un bosquejo biográfico Paso 2

3. Use esto como su plantilla de tabla de contenido.

Imagen titulada Defenderse de la apropiación de reclamos de nombre o semejanza Paso 15

4. Revisa tus pasos de nuevo. Una vez que haya diseñado un diseño con secciones lógicas, revíselas para asegurarse de haber cubierto todos los temas.

Imagen titulada Consigue un trabajo en otro estado Paso 11

5. Reúna sus suministros. Asegúrese de tener las cosas que describe disponibles y que estén listas para usarse como describe en el manual. Si está haciendo una caja de papel, tenga a mano papel, tijeras, cinta adhesiva, pegamento y una regla. Si estás escribiendo sobre una cámara, asegúrate de haberla desarmado. El producto sobre el que escribe ya debería estar de vuelta en la caja, si es posible.

Método 3 de 4: comienza a escribir

Imagen titulada Solicitar una subvención empresarial Paso 8

1. Escribe la introducción. La introducción establece el tono de todo el manual y le da al usuario una idea de qué tipo de manual está a punto de leer. ¿Es su introducción entretenida y fácil de leer o clara, simple y formal?? Depende de tus lectores. Tienes mucho más espacio para jugar con el lenguaje cuando enseñas a los niños a hacer una caja de papel que cuando le enseñas a un médico cómo realizar una cirugía a corazón abierto. Así que establezca el tono temprano y manténgalo mientras escribe todo el manual.

Imagen titulada Conectar los auriculares a la PS3 Paso 19

2. Realice cada paso mientras escribe. Esto no solo le da a su texto un aspecto honesto y real, sino que también le asegura que no olvidará nada.

Si por alguna razón no es factible llevar a cabo los pasos, piénselo bien y busque el consejo de un experto.

Imagen titulada Hacer un sistema operativo de computadora Paso 1

3. numerar los pasos. Esto facilita que sus lectores sigan el texto y recuperen información si se pierden.

Si está escribiendo en papel, asegúrese de dejar espacio entre cada paso para que pueda agregar más información. Recuerde volver a numerar sus pasos cuando agregue nuevos pasos.

Imagen titulada Spot Fake News Sites Paso 8

4. Agregar consejos y advertencias. Mientras escribe, puede darse cuenta de que cuando un usuario realiza un paso casualmente, podría causar un problema.

Si por el contrario crees que ciertos conocimientos harán más fácil o interesante la tarea del usuario, añádelo.

Imagen titulada Conectar los auriculares a la PS3 Paso 17

5. Pon a prueba tu manual. Lleve a cabo las cosas sobre las que ha escrito usando solo sus instrucciones escritas. Si encuentra que a sus instrucciones les falta la información necesaria en ciertos lugares, agréguela. Repita este paso hasta que haya realizado todos los pasos y pueda hacer lo que está tratando de enseñar a los lectores sin tener que agregar más información.

Considere dejar que uno o dos amigos usen su manual. Obsérvelos cuidadosamente mientras aprenden a usar el producto. Vea qué pasos siguen rápidamente. Averigüe dónde se pierden, confunden o hacen mal el trabajo. Escuche lo que tienen que decir y luego ajuste su guía en consecuencia.

6. Corrija su manual. No desea enviar al revisor final (ya sea un editor o su socio) un manual lleno de errores molestos.

Método 4 de 4: Dar formato al texto

Imagen titulada Escriba una propuesta de subvención Paso 16

1. Empezar en el nivel superior. Una vez que haya descrito claramente todos los pasos necesarios, revise su manual para encontrar los encabezados claramente reconocibles de las diferentes categorías.

Dales un título y escribe dónde están en tu manual.

Imagen titulada Escriba una propuesta de subvención Paso 18

2. Escriba una tabla de contenido, si corresponde. Como ejemplo, mira la forma en que está organizado wikiHow. La página de inicio tiene una lista de las diferentes categorías. Cuando elija una determinada categoría, verá las muchas subcategorías y allí encontrará los artículos. Cuanto más detallada sea su guía, más categorías y subcategorías necesitará. Un artículo sobre cómo silbar no necesita uno. Un texto sobre cómo tallar una flauta de madera, por otro lado, necesita un poco de. Finalmente, un artículo sobre cómo tocar la flauta necesita muchos!

Imagen titulada Escriba una propuesta de subvención Paso 7

3. Corrija su manual de nuevo. Sí, ya lo has hecho a fondo. Si lo hace por segunda vez, sin duda encontrará algunos otros pequeños errores o lugares donde su manual simplemente no es claro.

Para obtener una guía más completa, también puede usar esta opción para anotar todos los temas menores y usar esta información para crear un índice.

Imagen titulada Defenderse de la apropiación de reclamos de nombre o semejanza Paso 2

4. Piensa en un título.

Consejos

Incluso si algo te parece completamente claro, todavía tienes que escribir los pasos! Te ayudará a evitar saltarte algo que el usuario no sabe. Es mejor agregar información adicional que omitir pasos importantes.
Si está escribiendo un manual muy detallado que requiere que divida el texto en capítulos, como una instrucción sobre cómo tocar la flauta, su primer paso podría ser enumerar todos los capítulos, como Elegir una flauta, Ensamblar y mantener la flauta, Producir notas musicales, Digitación, Tu primera pieza musical, y así. Luego aplica las reglas básicas para escribir un manual a cada capítulo, porque cada capítulo es, por así decirlo, un manual separado!
Proporcione ilustraciones con sus instrucciones siempre que sea posible! Si no puede agregar imágenes, consulte algo familiar como ejemplo. abeja Paso 2 de "Dar formato al texto" por ejemplo, este artículo hace referencia al diseño para ilustrar cómo puede crear una tabla de contenido.
Si es posible, haga que un principiante pruebe su manual y escriba cada pregunta que haga la otra persona. Esto lo ayudará a completar las piezas que faltan y hará que su manual sea mucho más útil.
Escribir cada sección en una página separada (o en una computadora) hará que la edición sea mucho más fácil. Puede reorganizar su manual más fácilmente si tiene espacio para trabajar y puede encontrar sus notas para personalizarlas. Deje 3 o 4 líneas en blanco en la computadora (pulsando varias veces) introducir clave presionando) entre todos los pasos para que pueda encontrar fácilmente las divisiones entre las diferentes partes.