Instrucciones de paso a paso gratis 
A veces, no puede evitar usar términos técnicos, como para una aplicación de software de generación de gráficos con gráficos de Fibonacci y los gráficos circulares y de barras más comunes. En tal caso, es útil definir el término y proporcionar información básica, como una explicación de qué son los gráficos de Fibonacci y su uso en el análisis financiero. 
Si el problema es complejo, divídalo en partes pequeñas. Haga una lista de cada parte con instrucciones sobre cómo arreglarlo o cómo manejarlo, y trátelos uno tras otro. La fragmentación de la información de esta manera se denomina "fragmentación". 
Los procedimientos deben estar escritos en una estructura consistente en las instrucciones del manual. Comience con una descripción general de la tarea, luego describa lo que el usuario debe hacer y lo que debe percibir como resultado. Los pasos deben numerarse e introducirse con verbos de acción, ya que los pasos están escritos en cada sección de este artículo. Los materiales de referencia pueden incluir listas de opciones, consejos, soluciones y preguntas frecuentes. Se pueden incluir glosarios e índices aproximadamente al final del manual, aunque se puede proporcionar una lista de términos de uso común en la portada. El índice puede omitirse si el manual tiene menos de 20 páginas. 
Una vez que haya creado una imagen gráfica, puede guardarla en un formato comprimido adecuado para su programa de procesamiento de texto o DTP. También querrá reducir el tamaño físico de la imagen para que sea un poco más fácil de colocar en la página, sin sacrificar los detalles. (Si es necesario, puede dividir la imagen original en partes y mostrar las partes relevantes, junto con el texto de apoyo.) Si utiliza varios gráficos en los procedimientos, hágalos de un tamaño uniforme, con las mismas medidas de largo y ancho o reducidos de la misma manera. Esto hará que las imágenes sean más atractivas para el usuario. Además, cuando tome capturas de pantalla, asegúrese de que la computadora use un esquema de color estándar al capturar imágenes, si el manual del usuario muestra capturas de pantalla en color. Mientras que los programas de edición de gráficos como Photoshop y Paint Shop Pro ofrecen la posibilidad de tomar una captura de pantalla, programas específicos como SnagIt le brindan la posibilidad de modificar, catalogar y subtitular imágenes fácilmente. 
En general, coloca el título o el título del capítulo en el encabezado o pie de página, posiblemente con el título en la página de la izquierda y el título del capítulo en la página de la derecha. También coloque los números de página en el encabezado o pie de página, ya sea cerca del borde (encabezado o pie de página) o en el centro (solo en el pie de página). Puede hacer que cada primera página de una sección o capítulo se diferencie de las demás páginas colocando el número de página correspondiente en la parte inferior central de la página y las demás páginas en la esquina superior de la página. Es posible que desee indicar el texto explicativo en cuadros coloreados o sombreados para distinguirlo del resto del texto. Elija un color o nivel de sombreado sin comprometer la legibilidad. Opte por márgenes bastante amplios en todos los lados, con espacio adicional en los bordes que se unirán. 
El grapado es adecuado para manuales compuestos por hojas de papel plegadas: 21 x 27,5 cm, 21 x 35 cm o 27,5 x 42,5 cm. Los manuales producidos a bajo costo de 48 páginas o menos se agrupan de esta manera. La puntada de lomo se usa más comúnmente para las guías de referencia de terceros que para los manuales del propietario que se incluyen con los productos no automotrices, aunque algunos manuales del propietario más completos están encuadernados de esta manera. (Paint Shop Pro venía originalmente con un manual de usuario encuadernado con grapas cuando lo publicó JASC Software.) La encuadernación en espiral es adecuada para los manuales del propietario diseñados para usarse en entornos más hostiles, como al aire libre, donde los manuales grapados o cosidos se desmoronarían. Algunos manuales encuadernados en espiral tienen páginas plastificadas para evitar que se rompan si el manual se moja o se ensucia. 
Los procesadores de texto y los programas de autoedición también brindan la capacidad de crear "estilos", fuentes predeterminadas y formatos para encabezados, pies de página, encabezados y texto sin formato. Puede elegir uno de los nombres de los estilos preestablecidos (por ejemplo, `Head1`, `Normal`, `Quote`), o crear un estilo personalizado con su propio nombre. Trate de seguir las convenciones de los nombres de estilo existentes tanto como sea posible, si usa varios estilos para la misma clase de texto. (Por ejemplo, Microsoft Word etiqueta los estilos de texto de encabezado como "Título1", "Título2", etc., desde el titular principal hasta los diferentes niveles de subtítulos.) Intente crear previamente todos los estilos para no tener que interrumpir el proceso de escritura para crearlos de nuevo.
Crear una guía
Contenido
Los manuales de usuario son documentos en papel o electrónicos (PDF o XPS) con instrucciones sobre cómo hacer o usar algo. Si bien los manuales de usuario a menudo se denominan manuales de software, también se incluyen con mucha frecuencia en las computadoras y otros dispositivos electrónicos, como televisores, estéreos, sistemas telefónicos y reproductores de MP3, así como en electrodomésticos y equipos de jardinería. Los buenos manuales de usuario informan a los usuarios sobre las funciones de un producto y cómo usar esas funciones de manera efectiva, y están organizados para que sean fáciles de leer y consultar. Las siguientes son algunas cosas a tener en cuenta al crear contenido eficaz y diseñar el diseño de una guía del usuario.
Pasos
Parte 1 de 3: crear documentación útil para el usuario
1. Definir el usuario. Para escribir una guía de usuario exitosa, debe desarrollar un perfil de su usuario, ya sea formalmente creando un perfil escrito o informalmente, tomándose el tiempo para hacer suposiciones razonables sobre las características de su usuario. Dicho perfil es útil cuando forma parte de un equipo que escribe la documentación del usuario, y también puede ser útil cuando desarrolla el producto desde el concepto hasta la forma final. Las cosas a considerar al desarrollar un perfil de usuario incluyen:
- Dónde el usuario utilizará el manual, como en casa, en la oficina, en un sitio de construcción remoto o en el automóvil. Esto puede determinar no solo el contenido, sino también el estilo del manual del usuario.
- Cómo los usuarios utilizarán el manual. Si el manual se consultará en raras ocasiones o si solo tiene fines informativos, debe adoptar principalmente la forma de un documento de referencia. Si es algo a lo que los usuarios se referirán con frecuencia al principio, la sección de referencia debe ir acompañada de una "Trabajar"-sección e instrucciones sobre las tareas más comunes para las que se utilizará el producto.
- Cuántos usuarios tienen experiencia con el producto o qué les gusta a otros sobre él. Si su producto es nuevo o muy diferente de productos similares, debe incluir una explicación de cuán diferente es de otros productos, así como instrucciones sobre cómo comenzar. Si el producto tiene características con las que otros usuarios suelen tener problemas, como varias aplicaciones informáticas, debe proporcionar la información y los detalles adecuados de forma comprensible.
2. Al escribir, concéntrese en la necesidad del usuario, de una manera que el usuario pueda entender. A menos que el usuario tenga conocimientos técnicos, probablemente sea mejor evitar un lenguaje muy técnico y optar por una explicación clara y sencilla. El texto también debe organizarse de manera que imite la mentalidad del usuario; hacer una lista de las funciones del producto agrupadas por función a menudo tiene más sentido que agrupar las funciones que se usan más.
3. Explique el problema que el usuario está tratando de resolver, luego presente la solución. Ofrecer una función como solución a un problema común funciona muy bien con un producto comercial, pero una vez que el usuario tiene el producto, quiere saber cómo usarlo. Indicar problemas específicos que puede encontrar el usuario, indicarlos en el manual de usuario y seguir con instrucciones para solucionarlos.
Parte 2 de 3: partes de un manual de usuario
1. Agregue portadas y portadas apropiadas. Necesitará una página de portada para cualquier manual que sea más que una tarjeta de referencia y una página de título para un manual que contenga más información que una hoja de papel doblada (cuatro o más páginas).
- Si el manual tiene derechos de autor, coloque un aviso de derechos de autor tanto en la portada como en la página del título.
- Si hay condiciones adjuntas al uso del manual y el producto correspondiente, inclúyalas en el interior de la portada.
2. Poner referencias a documentos relacionados en el prefacio. Si la documentación del usuario consta de más de un manual, consulte los otros documentos aquí, con los números de versión correctos. El prefacio es también el lugar donde una posible sección "Como usar esta guia" llega.
3. Incluya una tabla de contenido si el manual tiene más de 10 páginas.
4. Coloque las instrucciones/procedimientos y el material de referencia en el núcleo del manual. En la mayoría de los casos, todos los procedimientos y materiales de referencia tienen sus propias secciones, pero puede remitir al usuario a contenido específico de una sección a otra. De esta manera el usuario puede encontrar la información que busca más rápido.
5. Si es necesario, utilice imágenes para apoyar el texto. Los gráficos o capturas de pantalla pueden ilustrar mejor ciertos puntos del manual que el texto, especialmente en procedimientos complejos en los que el usuario necesita una confirmación visual de que los pasos se han realizado correctamente. Los gráficos se pueden producir usando software de diseño o software de gráficos, cámaras digitales y software de edición de fotos, o en el caso de capturas de pantalla, capturadas usando la capacidad de captura de pantalla de su PC o un programa de gráficos.
Parte 3 de 3: Diseñe una guía de usuario legible
1. Elija algunas fuentes legibles. Si bien las computadoras pueden admitir varias fuentes diferentes, el propósito de una guía del usuario es que sea fácil de leer. Elegir solo una pequeña cantidad de fuentes que funcionen bien juntas es la mejor manera de lograr este objetivo. Las fuentes se pueden dividir en 2 tipos: serif (serif) y sans serif (sans serif).
- Las fuentes Serif cuentan con pequeños adornos en los extremos de las líneas principales que componen la letra. Las fuentes Serif incluyen fuentes como Times New Roman, Baskerville y Book Antiqua. Las fuentes Serif son más adecuadas para grandes fragmentos de texto con un tamaño de fuente de 10 a 12 en el cuerpo principal de un manual impreso.
- Las fuentes sans serif muestran solo las líneas que forman las letras, sin adornos. Las fuentes sans serif incluyen fuentes como Arial, Calibri y Century Gothic. Las fuentes sans serif se pueden usar para grandes fragmentos de texto en tamaños de 8 a 10 puntos en un PDF o manual en línea, aunque la falta de sans serif que se muestra en 12 puntos o más hace que sea más difícil de leer. Sin embargo, pueden ser efectivos en un tamaño más grande para mostrar títulos y encabezados, y también son excelentes en tamaños más pequeños para notas al pie y números en columnas y tablas.
- En general, use fuentes regulares como Arial o Times New Roman para su manual de usuario, aunque puede usar una fuente decorativa para citas o títulos importantes, cuando escriba un manual para un juego de fantasía o ciencia ficción. (En el caso de citas llamativas, a menudo puede usar una de las fuentes simples y la cita llamativa está en cursiva.)
- Una vez que haya elegido ciertas fuentes para usar, cree una página de muestra en papel para verificar si las fuentes coinciden bien. También querrá mostrar este ejemplo a quien tenga que aprobar el manual antes de continuar escribiéndolo.
2. Presta atención al diseño. Una vez que haya elegido una de las fuentes del manual, tendrá que decidir dónde colocar todo en las páginas.
3. Piense en el tipo de encuadernación para el manual del usuario. Si su guía del usuario tiene más de 4 páginas, entonces las páginas deben estar unidas de alguna manera. Si bien una grapa en la esquina puede ser suficiente para documentos internos, las guías de usuario externas que vienen con un producto generalmente están encuadernadas de 3 maneras:
4. Cree un documento de plantilla para su manual. Muchos programas de procesamiento de texto y autoedición le permiten crear un documento de plantilla para su manual de usuario de modo que, a medida que escribe, el texto aparece automáticamente en la fuente que seleccionó para la parte del manual en la que está trabajando. (De hecho, este artículo se escribió inicialmente usando una plantilla de Microsoft Word.) La mayoría de estos programas también incluyen una colección de plantillas predefinidas que puede personalizar para satisfacer sus necesidades, en lugar de crear la plantilla desde cero.
Consejos
- Siempre que sea posible, use códigos de campo o variables de texto. Puedes asignar valores a los códigos de campo, como el nombre de un producto, el manual o el título de un capítulo, y colocarlos dentro de tu documento, en lugar del texto a mencionar. Cuando obtiene una vista previa o imprime el manual, la variable se reemplaza por el texto. Si se cambia el nombre del producto o si cambia el nombre del manual o de un capítulo, es más fácil cambiar la información ajustando el valor de la variable de texto que buscando y reemplazando.
Artículos de primera necesidad
- Procesador de textos o programa dtp
- Software de gráficos o programa de grabación de pantalla
Artículos sobre el tema. "Crear una guía"
Оцените, пожалуйста статью
Popular
