====== Elaborar Manuales de Usuario ====== {{:mda:dsp:mda-pr-1.0-dsp-elaborardocumentacion.png?900x747|}} ====== Objetivos ====== El objetivo de este proceso es el **crear manuales de la aplicación** que cubran los requisitos que se entregan en la release. Se podrá hacer tanto manuales entregables, ya sea en documentos o videos, como enlaces de ayuda (paginas o videos), insertados en la propia aplicación. Los videotutoriales serán cortos, explicando cómo hacer tareas muy específicas. ====== Roles ====== Los siguientes son los roles participantes en este proceso: ^ Rol ^ Tareas que interviene ^^^ |**Formadores**| | | |MDA-TR-1.0-DSP-Crear Video Tutoriales | | |MDA-TR-1.0-DSP-Crear Ayudas Html | | |MDA-TR-1.0-DSP-Crear Manuales | ====== Tareas ====== ===== MDA-TR-1.0-DSP-Crear Ayudas Html ===== **La ayuda online (html) se puede crear mediante una [[mda:dsp:mda-pr-1.0-dsp-elaborardocumentacion#hacer_las_ayudas/|Wiki/Confluence]]**. Otra opción es crear las páginas html de la ayuda dentro de la propia aplicación. En cada pantalla de la aplicación aparecerá un icono de ayuda {{:mda:dsp:despliegue8.png|}} en el que se ligarán las ayudas en html/wiki/confluence. Estas ayudas estarán en línea para el usuario y podrán ser utilizados en el curso de formación de la aplicación. Habrá una página principal en la que cuelguen el indice de todas las ayudas. {{:mda:dsp:despliegue9.png|}} ==== 1. Dar de alta en JIRA ==== Crear un **JIRA** con los siguientes datos, y **registrar las horas de trabajo de cada participante** en dicha tarea: ^ Tipo ^ Sumario ^ Disciplina ^ Proceso ^ Label ^ Version Fijada ^^^ | //Tarea// | // Hacer ayuda en HTML// | // Despliegue// | //DSP-Elaborar Manuales// | HTML |//[Versión del proyecto]// | ==== 2. Hacer las ayudas==== **Recomendamos crear la ayuda mediante una [[http://wiki.um.es/|Wiki]]** (poner jira del tipo "Petición de Servicio" a Telemática para que nos creen la wiki, al proyecto "DJ-AT-Telemática (TLMS)", componente "WIKIGRP", con el asunto "Crear wiki para la ayuda de la aplicación Nombre_Aplicación"). **Otra opción es usar Confluence** para crear la ayuda online (html), en cuyo caso puedes crearla en el espacio destinado para tu aplicación, como puede ser el espacio del pórtico de dicha aplicación, o el espacio de tu grupo. También pueden estar integradas en la aplicación, en cuyo caso tendremos que desarrollarlas dentro del codigo fuente del proyecto, y estarán versionadas al estar dentro de la rama principal. En general tendrán un indice principal y varios puntos por cada funcionalidad / historia de la aplicación. Se podrá añadir un apartado FAQ con preguntas frecuentes de la aplicación. **Ejemplos:** * [[https://wiki.um.es/wikis/unica/doku.php|Ayuda de la aplicación UNICA]] * [[https://wiki.um.es/wikis/apium/doku.php|Ayuda de la aplicación APIUM]] ===== MDA-TR-1.0-DSP-Crear Video Tutoriales ===== La **[[mda:dsp:mda-pr-1.0-dsp-elaborardocumentacion#mda-tr-10-dsp-crear_ayudas_html|ayuda online (html/wiki/confluence)]]** puede completarse con vídeo tutoriales cortos que expliquen las funcionalidades más complejas que tenga la aplicación. ===== MDA-TR-1.0-DSP-Crear Manuales ===== Además de la documentación en linea en wiki/confluence/html y/o vídeos, se debe entregar un manual en PDF. **[[mda:dsp:mda-pr-1.0-dsp-elaborardocumentacion#mda-tr-10-dsp-crear_ayudas_html|Si la ayuda se crea mediante una wiki/confluence]], se puede generar un PDF de la wiki/confluence con la ayuda, que haría las veces de manual**. Si la ayuda no está en Wiki/confluence, habrá que crear el manual de usuario siguiendo la plantilla que se adjunta en este apartado. ==== 1. Dar de alta en JIRA ==== Crear un **JIRA** con los siguientes datos, y **registrar las horas de trabajo de cada participante** en dicha tarea: ^ Tipo ^ Sumario ^ Disciplina ^ Proceso ^ Label ^ Version Fijada ^^^ | //Tarea// | // Hacer manuales de ayuda en un Documento// | // Despliegue// | //DSP-Elaborar Manuales// | MAN |//[Versión del proyecto]// | ==== 2. Crear Manual de Usuario ==== ^ Plantilla ^ SIGLAS ^ Nomenclatura ^ Ubicación ^^^ |[[https://svn.um.es/svn/MNCS/NuevaMNCS/MEDEA/web_iuturna/Proyecto/Fuentes/Documentacion/6.Despliegue/ManualUsuario.ott|ManualUsuario]]| MAN | XXX-MAN-1.2.3-ManualUsuario | ///Proyecto/Documentacion/6.Despliegue //|| **2.1.** Escribir la sección del documento: * "//2.1.1 Introducción//", en la que se debe describir de manera resumida el alcance del documento de prueba. **2.2.** Por cada funcionalidad que se quiera documentar, escribir un punto con su propio encabezado, aunque también se podrá englobar funcionalidades por area o como mejor sea entendible por el usuario. Es impotante tener cubierta todos las funcionalidades de la aplicación recogidas en el documento de requisitos en el manual de usuario. **2.3.** Exportar el manual a formato PDF para que sea más accesible a todos los usuarios de la aplicación. Se podrá incluir un enlace desde la misma aplicación. ====== Artefactos ====== ===== De entrada ===== ^ Plantilla del Artefacto ^ SIGLAS ^ Nomenclatura ^ Ubicación ^^^ |[[https://svn.um.es/svn/MNCS/NuevaMNCS/MEDEA/web_iuturna/Proyecto/Fuentes/Documentacion/2.Requisitos/DocumentoRequisitos.odm|DocumentoRequisitos]]| REQ | XXX-REQ-1.2.3-DocumentoRequisitos | ///Proyecto/Documentacion/2.Requisitos //|| ^**NOTAS**: * XXX: Código del proyecto. * 1.2.3: Número de version del documento.^ ===== De Salida ===== ^ Plantilla del Artefacto ^ SIGLAS ^ Nomenclatura ^ Ubicación ^^^ |Ayuda Html| | | Rama del codigo fuente del proyecto || |[[https://svn.um.es/svn/MNCS/NuevaMNCS/MEDEA/web_iuturna/Proyecto/Fuentes/Documentacion/6.Despliegue/ManualUsuario.ott|ManualUsuario]]| MAN | XXX-MAN-1.2.3-ManualUsuario| ///Proyecto/Documentacion/6.Despliegue // | ^**NOTAS**: * XXX: Código del proyecto. * 1.2.3: Número de version del documento.^ ====== Herramientas ====== ^ Herramienta ^ Version ^ Utilizada en ^ Descarga ^^^ |OpenOffice Writer | 3.3 |Crear Manuales | http://es.openoffice.org/ || |FrameWork FundeWeb | 1.2.3 (Ultima Versión) |Creación Ayuda en HTML| [[https://fundeweb.um.es/prototipo/paginas/downloads/downloads.seam | Portal FundeWeb - Descargas ]]| ====== Métricas ====== Las métricas del proyecto se guardarán dentro de la carpeta del proyecto en //Proyecto/Documentacion/1.Gestionproyecto/1.4.Metricas//. Las métricas de este proceso en concreto se almacenan en la Hoja //DSP//. ^**NOTA:** Todos los tiempos se miden en horas, salvo que se indique expresamente lo contrario.^ ===== Tiempo dedicado a crear ayuda html ===== - Entra en Jira en el navegador de incidencias. Realiza una query simple y selecciona todas las tareas del proyecto. * project = //ClaveDelProyecto// * Disciplina-Proceso = //DSP-Elaborar Manuales// * label = //HTML// Pulsa el botón //Search// Usa la [[https://svn.um.es/svn/MNCS/NuevaMNCS/MEDEA/web_iuturna/Proyecto/Fuentes/Documentacion/1.GestionProyecto/PlantillaSeguimiento.ots|Plantilla de Seguimiento]] tal y como se indica en el apartado [[mda:Calcular_Tiempos|Calcular tiempos con Jira]]. ===== Tiempo dedicado a crear manuales de ayuda===== - Entra en Jira en el navegador de incidencias. Realiza una query simple y selecciona todas las tareas del proyecto. * project = //ClaveDelProyecto// * Disciplina-Proceso = //DSP-Elaborar Manuales// * label = //MAN// Pulsa el botón //Search// Usa la [[https://svn.um.es/svn/MNCS/NuevaMNCS/MEDEA/web_iuturna/Proyecto/Fuentes/Documentacion/1.GestionProyecto/PlantillaSeguimiento.ots|Plantilla de Seguimiento]] tal y como se indica en el apartado [[mda:Calcular_Tiempos|Calcular tiempos con Jira]]. ===== Numero de paginas de ayuda html===== Número de paginas de ayuda html ===== Numero de paginas de manual de Usuario===== Número de paginas de manual de Usuario