Descargar el PDF
Descargar el PDF
Aunque muchas veces son ignorados por los usuarios de computadoras, los archivos de ayuda proporcionan información clave acerca de cómo utilizar la aplicación del software al cual están asociados. Al hacer clic en “Ayuda”, un usuario puede obtener una visión general de las características del programa, una descripción de la pantalla a la cual está mirando, instrucciones de cómo utilizar el programa para realizar determinadas tareas o leer listas de preguntas frecuentes acerca del programa y sus respuestas. Escribir un archivo de ayuda requiere tanto de la habilidad para trabajar con las aplicaciones del software así como también de la habilidad para explicar las cosas de manera de que los usuarios puedan entender. A continuación se presenta una guía de cómo hacer un archivo de ayuda.
Pasos
Descargar el PDF
-
1Obtén una copia del software que estás por documentar. Si es posible, también deberías obtener una copia de las especificaciones escritas del programa, aunque no todos los desarrolladores de software trabajan con ellas. En algunos casos, el programador se desvía de las especificaciones, basado en el poco tiempo que tiene para desarrollar o porque no es capaz de codificar una característica en particular.
-
2Obtén una herramienta de autoría de ayuda. Cuando es posible crear un archivo de ayuda a mano, con un texto enriquecido de formato (.rtf), la mayoría de los autores de archivos de ayuda utilizan una aplicación de software para escribir los archivos de ayuda, tales como RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare o HelpLogix. La mayoría de las herramientas para el autor de ayuda incluyen un editor de texto o trabajan con un programa de procesador de texto como Microsoft Word y le proporcionan una interfaz al usuario que deja que el autor vea cómo se verá el archivo de ayuda. Algunas herramientas para el autor de ayuda también incluyen editores gráficos para crear capturas de pantalla e incluirlas en el archivo de ayuda.
-
3Crea el archivo del proyecto de ayuda. Tu herramienta para autores de ayuda va a crear el archivo del proyecto de ayuda por ti, basándose en el nombre del archivo que le proporciones y otra información. El archivo principal del proyecto de ayuda contiene información acerca de otros archivos, lo que incluye un archivo de contenidos, un índice, uno o más archivos de imágenes y otros archivos.
-
4Ajusta el tamaño de la ventana de ayuda. A menos que estés escribiendo el archivo de ayuda para que aparezca en el buscador de la Web del usuario, el archivo de ayuda aparecerá en tu propia ventana. Tu herramienta de ayuda te permitirá ajustar las dimensiones verticales y horizontales de la ventana a cierto tamaño que le permita al usuario leer el archivo de ayuda sin que se interponga con la aplicación en sí misma.
-
5Escribe los temas de ayuda. Para hacer esto necesitarás revisar las especificaciones y el programa en sí mismo. A medida que creas cada tema, tu herramienta de ayuda lo agregará al archivo de ayuda en la parte de contenido e índice.
-
6Incluye capturas de pantalla si es necesario. Muchas de las funciones de cierto programa se explican mejor con una combinación de gráficos y texto. Puede crear capturas de pantalla ya sea con la aplicación que viene con tu herramienta de ayuda o con una aplicación por separado.
-
7Crea un archivo mapa si es necesario. Algunos programas incluyen botones de “Ayuda” para que cuando el usuario haga clic se muestre el tema en el archivo de ayuda y describa específicamente cómo funciona esa pantalla.
-
8Compila el archivo de ayuda. Al compilar se crea el archivo de ayuda que se incluirá en el programa.
-
9Prueba el archivo de ayuda. Una vez que se compila el archivo es necesario que revises si todo funciona correctamente.
-
10Dale el archivo de ayuda al desarrollador para que lo incluya en el programa.Anuncio
Consejos
- En empresas con grandes departamentos técnicos, muchos autores de archivos de ayuda pueden ser asignados a un proyecto, algunos con temas en áreas específicas, otros que creen capturas de pantalla y un director que periódicamente revisa el trabajo. Empresas más chicas probablemente contraten a un solo autor de archivos de ayuda.
Anuncio
Cosas que necesitarás
- Archivo de ayuda del software
- Editor de capturas de pantalla del software
Anuncio
¡Suscríbete al boletín gratuito de wikiHow!
Encontrarás instructivos útiles en tu bandeja de entrada cada semana.
¡Suscríbeme!
