Cmo elaborar un manual4 mtodos:Conoce el tema Planea el diseo de
tu manual Empieza a escribir FormatoEscribir un manual de
instrucciones puede parecer una tarea demandante, pero es ms fcil
de lo que crees. Estos consejos se pueden aplicar a cualquier
manual de instrucciones escrito, desde los ms simples hasta los ms
complicados.
AnuncioPasos
Mtodo 1 de 4: Conoce el tema
1.
1
Esta es la clave.Puede ser obvio, pero el conocimiento del tema
es la clave para escribir un manual exitoso. Por ejemplo, si ests
escribiendo un manual de una cmara, saber que el F-stop y que la
velocidad de obturacin no solo son funciones separadas porque lo
son- pero saber cmo ambas interactan har mucho ms fcil la forma en
que describirs cada funcin.
Anuncio2.
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 asegrate de que revisen
tu trabajo. Su conocimiento y consejo son invaluables.
3.
3
Intenta hacer un acercamiento prctico.Si es posible, pon en
prctica sobre lo que estas escribiendo, al menos de esta manera
puedes sentir lo que el usuario aprender.
4.
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 ensearn como otras
personas han abordado el tema.
Busca similitudes entre los escritores, lo que indica que ambos
tiene una funcionalidad comn 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.
5.
5
Lee revistas de comercio.Descubre como la gente usa estos
productos trabaja con ellos da a da. Puede que ellos deseen que
exista una funcin que resuelva un problema en particular, y si tu
producto es la solucin, debe ser destacado.
AnuncioMtodo 2 de 4: Planea el diseo de tu manual
1. 1
Desglosa Paso a paso. Ya sea escribiendo una hoja de
instrucciones paso a paso o un manual para una cmara digital,
desglosar cada paso tiene sus beneficios:
2.
2
Te permite enfocarte en partes individuales.Tu meta es
familiarizar al usuario al aprender el proceso. Puedes dejar la
parte de cmo realizar la funcin para el final del tutorial, si as
lo deseas, o dejar que el usuario lo descubra por s solo.
3.
3
Sigue una secuencia lgica.No sera bueno si por ejemplo,
describes como el flash de una cmara funciona hasta que hayas
explicado cmo colocar los lentes o cargar la pelcula, encender la
cmara y ajustar el enfoque. Esto es til especialmente si no ests
familiarizado con el tema.
4.
4
Utiliza esto como modelo para tu tabla de contenidos.5.
5
Revisa tus pasos.Una vez que hayas definido las secciones
lgicas, revsalas para asegurarte de que has cubierto todo.
6.
6
Rene tus provisiones.Ten el artculo que ests describiendo a mano
y listo para ser usado mientras lo describes en el manual. Si ests
haciendo una caja de cartn, debes tener, papel, tijeras, cinta
adhesiva, pegamento y regla a la mano. Si ests escribiendo sobre
una cmara, asegrate de tenerla desmontada. Si es posible, el
producto del que estas escribiendo debe estar empacado.
AnuncioMtodo 3 de 4: Empieza a escribir
1.
1
Escribe la introduccin.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 ms espacio para el juego verbal cuando escribes un manual
para nios que cuando escribes un manual para un doctor. Establece
el tono y mantn ese tono durante todo el manual.
Realiza cada paso mientras vas escribindolo. No solo te da algo
de honestidad y autenticidad al escribir sino tambin te aseguras de
no dejar cabos sueltos.
2.
2
Si por alguna razn, no es posible realizar el paso, analzalo
profundamente y consulta con un experto. Enumera los pasos. Esto
facilita al lector que siga tus instrucciones, y para alguna
referencia en el futuro si se pierde.
3.
3
Si lo ests escribiendo en un papel, asegrate de dejar espacios
para agregar anotaciones en cada paso.Recuerda reenumerarlo si
agregas ms pasos
Incluye consejos y advertencias. Mientras escribes puedes darte
cuenta que si el usuario realiza un paso sin cuidado, puede
ocasionar algn problema.
4.
4
Adems si hay algn consejo que ayudar al usuario a facilitar
alguna tarea o que lo haga ms interesante, agrgalo. Ponlo a prueba.
Usando tus instrucciones escritas, ponlo a prueba. Si te das cuenta
que algo le falta a tus instrucciones, agrega la informacin
necesaria. Repite este paso hasta que todos estn completos, y
puedas realizar lo que tratas de ensear sin tener que agregar
notas.
5.
5
Considera hacer que un amigo o dos usen el manual.Obsrvalos
detenidamente cuando aprendan a usar el producto. Ve si en algn
punto se pierden, se confunden o fallan. Escucha lo que tienen que
decir, luego ajusta el manual.
6.
6
Corrige tu manual.No querrs enviar tu manual (ya sea una agencia
o tu esposa) con un sin nmero de errores.
AnuncioMtodo 4 de 4: Formato
1. 1
Empieza desde el principio. Una vez que tengas todos los pasos
detallados, revisa el manual para encontrar los encabezados
obvios.
2.
2
Coloca ttulos, y anota su ubicacin.3.
3
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 seccin,
enlista varias sub categoras, y las sub categoras listan artculos.
Mientras ms detallado sea tu manual, ms categoras y sub categoras
necesitar. (Cmo silbar, no necesita ninguna, mientras como tallar
un silbato necesita algunas y como tocar una flauta necesita
muchas.)
4. 4
Vuelve a corregir una vez ms.Si, ya lo hiciste una vez. Hacerlo
una segunda vez indudablemente har evidente pequeos errores o
lugares en dnde tu manual no es lo suficientemente claro.
5.
5
Para realizar un manual mas entendible, puedes tomar esta
oportunidad para anotar pequeos temas y usar esa informacin para
crear un ndice.6. 6
Selecciona el ttulo.AnuncioConsejos
Si escribes un manual detallado que requiere de captulos, tales
como Cmo tocar la flauta el primer paso es listar los captulos,
como Seleccionar la flauta, ensamblaje y cuidado, utilizar los
dedos, tu primera pieza musical etc. Puedes aplicar la regla bsica
para escribir un manual en cada captulo porque cada captulo es como
escribir un manual por separado.
An cuando algo parezca obvio para ti, escrbelo en los pasos.
Evitar que dejes espacio vacios sobre algo que el usuario no sabe.
Es mejor incluir informacin extra en lugar de omitir pasos
importantes.
Cuando sea posible, ilustra tus instrucciones. Si no puedes
adjuntar imgenes, refiere al lector a algo comn como ejemplo. Por
ejemplo enFormato, paso 2en estas instrucciones, el diseo 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 ms til.
Escribir cada seccin en hojas separadas (o en una computadora)
har que editarlo sea ms fcil. Puedes arreglarlo fcilmente si tienes
espacio para trabajar y puedes encontrar tus marcas de edicin. En
la computadora, deja de 3 a 4 lneas de por medio (al teclear Enter
varias veces) de esta manera puedes agregar notas.