Manual de Usuario de Software

6
Practica #1 Organización de Lenguajes y Compiladores Organización de Lenguajes y Compiladores 1 Practica #1 MANUAL DE USUARIO Por: Julian Augusto Sandoval García 2010-25409

description

Ejemplo de un manual de usuario para un programa creado en java

Transcript of Manual de Usuario de Software

Page 1: Manual de Usuario de Software

Practica #1 Organización de Lenguajes y Compiladores

Organización de Lenguajes y Compiladores 1

Practica #1

MANUAL DE USUARIO

Por: Julian Augusto Sandoval García

2010-25409

Page 2: Manual de Usuario de Software

Practica #1 Organización de Lenguajes y Compiladores

1. Proposito del Documento

El propósito de este documento está dirigido a entregar las pautas de operación del sistema

Práctica#1 para la clase de Organización de Lenguajes y Compiladores 1. La aplicación permite

ejemplificar la primera etapa de un compilador la cual consiste en un analizador léxico.

Por medio de manipulación de ficheros con estructura XML cargaremos datos a una interfaz creada

en java la cual por medio del analizador léxico y de otros métodos creara un árbol de carpetas y

ficheros con contenido. Todo ello a partir de instrucciones sencillas

Este documento explicara las funciones mencionadas anteriormente y otras más con el mayor

detalle posible para facilitar el uso de la aplicación.

Esta práctica está realizada bajo el entorno de Java con el fin de permitir una interacción más

transparente y eficaz tanto para usuarios de las dependencias como para sus creadores.

2. Uso de la Aplicación

2.1. Objetos básicos de la aplicación

Page 3: Manual de Usuario de Software

Practica #1 Organización de Lenguajes y Compiladores

Menú Archivo: Contiene las opciones básicas del editor de texto tales como:

1. Nuevo: Este comando crea un nuevo fichero de texto.

2. Abrir: Abre la ventana de selector de archivos que permite la búsqueda del fichero

deseado.

3. Guardar:

3.1 Guardar: Almacena la información contenida sobre el editor de texto.

3.2 Guardar Como: Abre el selector de archivos para seleccionar el nombre y la ubicación para

el almacenamiento del archivo.

Menú Ayuda: en este se encuentra un comando, que al ser presionado mostrara la

información básica de la aplicación y del autor.

Botón Analizar: Contiene los principales métodos de la aplicación los cuales son ejecutados

en base al texto sobre el editor de texto. (Para conocer más acerca de los métodos ejecutados se

recomienda la lectura del manual técnico.)

Botón de Errores: Muestra los errores encontrados durante el recorrido del analizador

léxico sobre un documento HTML.

Botón Salir: Cierra la aplicación por completo.

Botón Limpiar: Limpia el texto que se encuentra sobre el editor de texto.

Editor de Texto: Área de texto dentro de la aplicación que muestra la información de los

ficheros abiertos o por crear.

Page 4: Manual de Usuario de Software

Practica #1 Organización de Lenguajes y Compiladores

2.2. Utilizando la Aplicación

1. Ejecutamos el archivo .jar “Practica_1”

2. Al abrirse la ventana principal se mostrara toda la interfaz gráfica descrita en el apartado

Uso Básico de la Aplicación

3. Para que las funciones principales de la aplicación funcionen debemos tener sobre el editor

de texto, la estructura del árbol de carpetas. Para ello contamos con las opciones de

escribirlo manualmente o seleccionar un archivo con la información ya contenida.

Ingresamos al menú Archivo y luego a la pestaña abrir.

4. Al abrirse el panel de selector de archivos seleccionaremos el archivo deseado.

5. Al seleccionar el archivo y presionar el botón abrir, el texto contenido dentro del fichero

será mostrado en el editor de texto.

Page 5: Manual de Usuario de Software

Practica #1 Organización de Lenguajes y Compiladores

6. Para pasar los métodos sobre el fichero presionaremos el botón analizar y el árbol de

carpetas será creado en el directorio indicado.

Page 6: Manual de Usuario de Software

Practica #1 Organización de Lenguajes y Compiladores

7. Para comprobar si se detectaron errores durante en analizador léxico, presionaremos el

botón ver errores.

3. Dudas o Comentarios

Para resolver cualquier duda o comentario por favor escribir al correo [email protected]