Cómo crear la documentación del usuario

Escribir documentación sobre cómo utilizar un programa de ordenador es fundamental para el tanto al usuario final y cualquiera que trate de capacitar a las personas en el nuevo programa. La documentación debe ser clara y fácil de entender. Usted no quiere que los usuarios tengan que adivinar cómo utilizar el programa. documentación para el usuario necesita un equilibrio de ambos pasos escritos y visuales. Los siguientes pasos le proporcionará una descripción de cómo crear una guía de usuario estándar.

Instrucciones

1 Escribe una breve descripción de su nuevo programa --- incluir su propósito, lo que las plataformas del programa se ejecutará en y todos los requisitos de memoria. Enumerar varios puntos de la bala que indican las principales características del programa.

2 Esbozar cómo desea que la documentación del usuario para mirar. Incluya todos los encabezados y pies de página posibles a otro dentro de la documentación, números de página y la forma en la cubierta debe mirar. Este esquema también le ayudará con poner la guía juntos.

3 Escribir su primera sección - cómo instalar el programa. Estado cada paso claramente de insertar el disco compacto en la computadora para qué hacer una vez que se instala el software. Proporcionar capturas de pantalla del proceso de instalación. No dejar de lado las medidas y la lista de los posibles errores que pudieran ocurrir. Incluir una tabla de consejos para la solución de problemas.

4 Establecer claramente los pasos para obtener el programa a ejecutar. Incluya qué icono para hacer clic y lo que la pantalla principal se verá así. Proporcionar una captura de pantalla de la pantalla de apertura.

5 Escriba su tercera sección - la forma de operar con el programa. Describir las funciones de menú, la forma de acceder a la ayuda, si está disponible, cómo guardar archivos, de cómo imprimir, cómo salir del programa y cualesquiera otras funciones básicas. Incluir capturas de pantalla a lo largo de esta sección también. Utilice Inglés sencillo y no espere que el usuario final pueda asumir nada. Si el programa de interfaz con otro programa o paquete, explicar esta conexión.

6 Componer una simple tabla de contenidos y un índice de la documentación de uso de palabras clave. Escribe esta sección una vez que tenga las secciones del núcleo anteriores realizados. El índice proporciona al usuario una manera rápida de recuperar la información sin tener que buscar en toda la guía.

7 Crear un glosario de términos de las palabras técnicas o jerga que necesitan ser definidos por el usuario. A continuación, el diseño de la cubierta para ir en la parte frontal de la guía.

8 Editar su documentación - comprobar la ortografía, la gramática y el flujo general de información. Que realicen la revisión y aprobar la documentación relativa a otra persona para verificar su trabajo. Imprimir y obligar a la versión final.