Etiqueta: documentación

Nomenclatura de componentes Swing

En general, para definir elementos de Java Swing debemos eliminar las J inicial y las vocales, y extraer las tres consonantes más significativas del nombre del control. A continuación figura la lista de componentes y sus prefijos asociados:

1. Nomenclatura de Swing Containers
Contenedor Prefijo
JInternalFrame ifrm
JPanel pan
JScrollPane scp
JTabbedPane tpn
JToolBar tlb
2. Nomenclatura de Swing Controls
Control Prefijo
JButton btn
JButtonGroup btg
JCheckBox cbx
JComboBox cmb
JLabel lbl
JList lst
JPasswordField pwd
JProgressBar pgb
JScrollBar scb
JTable tbl
JTextArea txa
JTextField txt
JTextPane txp
JTree jt
JDateChooser jdc
JCalendar jcl
JRadioButton jrb
3. Nomenclatura de Swing Menus
Menu Prefijo
JMenu mnu
JMenuBar mnb
JMenuItem mni
4. Nomenclatura de Swing Windows
Window Prefijo
JColorChooser cch
JDialog dlg
JFileChooser jfc
JFrame frm
JOprionPane opt
5. Otros
Window Prefijo
DefaultTableModel dtm
JDialog dlg
JFileChooser jfc
JFrame frm
JOprionPane opt

Ejercicio UT4E1 Documentación de una aplicación móvil

Diseña un manual de usuario con un procesador de texto para la aplicación móvil que tú elijas. El documento deberá contener:

  1. Una portada con el dato identificativo del documento (aplicación, versión, fecha).
  2. Prólogo (información de uso de la documentación).
  3. Tabla de contenidos.
  4. Tabla de ilustraciones.
  5. Páginas de contenidos (funcionamiento de la aplicación).
  6. Sección de FAQ.
  7. Fuentes de información relacionadas (si procede).
  8. Glosario.
  9. Índice.

Diseña también una guía rápida de la aplicación en una sola página. Ten en cuenta las cuatro premisas:

  • Contraste.
  • Repetición.
  • Alineación.
  • Proximidad.

Utiliza las capturas necesarias para ilustrar el documento.

Para realizar la tabla de contenidos, ilustraciones e índice puedes consultar los siguientes tutoriales:

Puntuación:

  • Requisitos: contiene todos los apartados indicados en el enunciado.
  • Usabilidad: el manual contiene estilos, tabla de contenido e índice siguiendo el procedimiento indicado en clase.
  • Eficiencia de código: puesto que no hay código en la práctica, se valorará que la guía rápida sea atractiva y comprensible para el usuario.
  • Documentación: el manual contiene una correcta portada y fuentes de información relacionadas (webs de consulta, sitio de descarga de la aplicación).
  • Mejoras.