La introducción define el manual. Explique quién debe leer el documento y que es no quiere decir , qué información se incluye , y en qué circunstancias es útil . Para los manuales de productos , suponga el lector ha comprado el producto y está listo para aprender a usarlo. Mantenga la introducción corta por lo que el usuario llega a los aspectos técnicos del manual lo más rápido posible .
Contornos
Manuales Técnicos menudo dispuestas en secciones y subsecciones , que también hacer un esquema ideal. Lista de todos los tramos previstos para el manual y se incluye subsecciones detallados cuando sea necesario . No tenga miedo de reorganizar las secciones a medida que avanza . Sólo porque usted pensó en un primer tema no significa que el lector necesita que algo de información primero. El orden final de las secciones debe reflejar la progresión natural el usuario hará mientras se aprende el tema . Utilice un sustantivo y verbo en la sección partida para definir el tema y la acción dentro de la sección .
Estar activo
Cada paso en un manual técnico encarga al lector en una sola acción que , cuando se realiza con otros pasos , conduce a una acción completa . Cuenta los pasos o tienen "balas" gráficas para indicar las medidas . En algunas situaciones , los pasos pueden ser sub-etapas identificadas por números o letras en los pasos básicos . Los escritores tienen cierta discrecionalidad en la forma en que se identifican los pasos , pero deben ser coherentes a lo largo del manual.
Manténgalo
simple
Utilice el lenguaje más sencillo que transmite adecuadamente la información . Usted no sabe quién va a leer el manual y lo bien que están versados en la jerga técnica del tema . Evite los altos niveles de detalle o detalles no necesarios para transmitir la información. Las oraciones largas , más de 20 palabras , tienden a desalentar lectores. Las sentencias de menos de 10 palabras pueden dar al documento un sonido de cortar.
Ilustrar el tema
Use fotografías, cuadros o gráficos para ilustrar el tema . Estas imágenes pueden valer más que mil palabras y tienden a llamar la atención del lector . Si las imágenes gráficas no son posibles, utilizar frases descriptivas . Ejemplos verbales e ilustraciones también permiten al lector a visualizar el tema.