Tutoriel QSOS. Version /02/ PDF

of 35
284 views
PDF
All materials on our website are shared by users. If you have any questions about copyright issues, please report us to resolve them. We are always happy to assist you.
Document Description
Version /02/ Table des matières 1 Note de licence 4 2 Historique des modifications 4 3 Introduction 4 4 Gérer les templates Généralités sur les templates Créer
Document Share
Document Transcript
Version /02/2013 1 Table des matières 1 Note de licence 4 2 Historique des modifications 4 3 Introduction 4 4 Gérer les templates Généralités sur les templates Créer un nouveau template Installer FreeMind Récupérer le souche du template Ajouter des axes d évaluation Modifier l axe Metadata Modifier l axe Maturité Sauvegarder le template Contribuer le template Modifier un template existant Gérer les évaluations Généralités sur les évaluations Créer une nouvelle évaluation Installer XulEditor Utiliser XulEditor Sauvegarder une évaluation Contribuer une évaluation Modifier une évaluation existante Appliquer une nouvelle version de template Visualiser une évaluation en mode Web Visualisation au format XML Visualisation au format HTML Visualisation au format FreeMind Document distribué sous licence FDL 2 6 Gérer les comparaisons Créer une nouvelle comparaison Pondérer une comparaison Visualiser une comparaison en mode Web Visualiser un tableau comparatif Visualiser un graphique dynamique en radar Visualiser un quadrant QSOS Exporter une comparaison aux formats OpenDocument Exporter au format ODS Exporter au format ODP Exporter au format ODT Annexe : framework Drakkr 34 Document distribué sous licence FDL 3 1 Note de licence Copyright c 2013 Atos. Vous pouvez copier, redistribuer et/ou modifier ce document selon les termes de la Licence de Documentation Libre GNU, Version 1.2 publiée par la Free Software Foundation. Une copie de la licence en langue anglaise est consultable sur le site une traduction française non officielle est consultable sur le site Web de Wikipedia (http://fr.wikipedia. org/wiki/fdl). 2 Historique des modifications Version Date Auteurs Commentaires /02/13 Raphaël Semeteys Conception et rédaction initiales. 3 Introduction L objectif de ce tutoriel est de vous guider dans l application de la démarche proposée par la méthode QSOS en utilisant les outils mis à votre disposition par le projet communautaire. Ainsi ce tutoriel est constitué d un ensemble de cas d usage auxquels vous pouvez être confrontés. Ces cas d usage ne se présentent pas toujours forcément dans l ordre dans lequel ils sont listés ici. Vous pouvez donc utiliser le tutoriel soit comme un scénario complet, soit comme une liste à consulter en fonction de vos besoins. 4 Gérer les templates 4.1 Généralités sur les templates Un template définit la structure ou la grille d analyse d une évaluation QSOS. Il est constitué de critères répartis sous forme d arbre selon plusieurs axes. Les axe intitulés Maturité et Metadata sont imposés par la méthode QSOS. L axe Maturité est un ensemble organisé de critères systématiquement utilisé pour évaluer la maturité du logiciel et du projet en charge de son développement. Et ce, quel que soit le logiciel ou le type de logiciel concernés. Pour le détail des critères composant l axe Maturité, consultez la méthode QSOS elle-même. Ainsi, Document distribué sous licence FDL 4 Figure 1 Axe Maturité imposé aux templates même si vous modifiez cet axe dans votre template, ces modifications seront écrasées pour garantir sa conformité avec la méthode. L axe Medatata est décrit plus loin au chapitre Modifier l axe Metadata. Il est réservé à la gestion d un ensemble d informations propres au template lui-même (métadonnées), telles que ses auteurs, sa version, sa date de création, sa dernière date de modification ou encore sa langue. 4.2 Créer un nouveau template Installer FreeMind Le logiciel libre FreeMind est utilisé pour créer et modifier les templates sous forme de cartes heuristiques (ou MindMaps). Il s agit d un logiciel développé en Java et donc utilisable sur un grand nombre de plates-formes. Prière de vous reporter à la documentation officielle du projet 1 pour le détail de son installation. Attention cependant, la version minimale de FreeMind requise par QSOS est Récupérer le souche du template Pour créer un nouveau template, il vous faut absolument partir de la souche correspondant à votre langue. Ces souches respectent la convention de nommage suivante : template_[langue].mm. Ainsi, la souche française est template_fr.mm. Elles sont publiées sur le site officiel du projet QSOS, à l adresse suivante : Ajouter des axes d évaluation Une fois la souche téléchargée, ouvrez le document.mm avec FreeMind. Vous retrouvez les deux axes imposés par QSOS : Maturité et Metadata. 1. Document distribué sous licence FDL 5 Pour ajouter de nouveaux axes d évaluation à votre template, il vous suffit d ajouter et organiser des nœuds de manière hiérarchique, tout en respectant impérativement le formalisme suivant : un nœud intermédiaire permet d organiser et hiérarchiser vos critères, outre son titre, vous pouvez préciser sa description détaillée via un sous-nœud mis au format Bulle. Figure 2 Format Bubble pour la description d un nœud un nœud final (donc une feuille), correspond à un critère d évaluation, il doit respecter les conventions suivantes : 1. les descriptions des critères doivent là aussi être entourées ; 2. les descriptions des notes 0, 1 et 2 doivent être repérées via des icônes idoines. Figure 3 Formalisme de description des critères Document distribué sous licence FDL 6 Libre à vous de créer et d organiser les critères d évaluation propres à une famille de logiciel. Le nœud principal de votre template doit être nommé selon cette famille, c est ce nom qui identifie le template de manière unique. Figure 4 Préciser le nom du template Modifier l axe Metadata Figure 5 Axe Metadata imposé aux templates Pensez à modifier l axe Metadata de votre template en précisant les informations suivantes : version : incrémentez cette valeur (selon le formalisme n.m) à chaque modification devant être reportée sur des évaluations QSOS existantes ; language : langue de votre template (selon le formalisme fr, en, etc.) ; author : auteurs du templates, identifiés par leurs noms complets (name) et leur courriel ( ) ; creation : date de création du template (selon le formalisme AAAA-MM-JJ) ; update : date de la dernière modification du template. Document distribué sous licence FDL 7 4.2.5 Modifier l axe Maturité Il vous est impossible de modifier cet axe qui est imposé par la méthode QSOS. Même si vous modifiez les critères obtenus via la souche de votre template, ces modifications seront écrasées par la suite Sauvegarder le template Le fichier FreeMind de votre template est au format.mm. Vous pouvez donc le sauvegarder et le manipuler à votre guise Contribuer le template Lorsque vous considérez que le template est complet - au moins pour une première version, vous pouvez alors le proposer à la communauté QSOS. Pour ce faire, connectez vous à l adresse suivante : app/connect.php. Figure 6 Connexion à O3S Ceci nécessite de disposer d un compte sur l application O3S. Si vous n en possédez pas encore, créez en un en cliquant sur le lien Sign On. Figure 7 Envoi du template dans le référentiel O3S À partir de ce moment, votre template est utilisable par la communauté pour créer de nouvelles évaluations. Reportez-vous au chapitre Créer une nouvelle évaluation. Document distribué sous licence FDL 8 Le template est automatiquement stocké dans le dépôt Incoming du référentiel QSOS. S il est considéré de bonne qualité, il sera validé par la communauté et déplacé dans le dépôt Master. Pour contribuer une nouvelle version de votre template, procédez de la même manière (en vérifiant de bien incrémenter la valeur du nœud version de l axe Metadata). 4.3 Modifier un template existant Les templates déjà existants sont stockés dans le référentiel communautaire de QSOS. Ils sont regroupés dans deux dépôts Git distincts : le dépôt Incoming : réservé à la publication, au partage et à la manipulation d évaluations et de templates par la communauté. Il est accessible par tous via O3S et seule la création d un compte utilisateur dans l application est nécessaire ; le dépôt Master : dédié au stockage des évaluations et aux templates considérés comme de qualité et ayant été validés par un modérateur de la communauté QSOS. Vous pouvez, en vous connectant à 03S 2, naviguer dans ces deux dépôts et télécharger les templates de votre choix. Figure 8 Navigation dans le référentiel des templates Une fois un template récupéré, utilisez FreeMind pour le modifier. Reportez-vous au chapitre Créer un nouveau template pour plus de détails sur ce sujet. 5 Gérer les évaluations 5.1 Généralités sur les évaluations Une évaluation QSOS est basée sur un template d une version donnée, dont elle hérite la structure et la description des critères. C est un fichier au format.qsos qui est manipulé via l outil XulEditor (cf. Installer XulEditor). 2. Document distribué sous licence FDL 9 Une évaluation basée sur une version de template peut être mise à jour par une autre version de ce même template, sans perdre les données d évaluation existantes (cf. Appliquer une nouvelle version de template). 5.2 Créer une nouvelle évaluation Installer XulEditor XulEditor peut être installé de deux manières : comme une extension Firefox ; comme une application autonome de type XulRunner. Si le premier mode d installation est plus simple, le deuxième offre l avantage de permettre de lancer plusieurs instances de XulEditor. Installer XulEditor en tant qu extension Firefox Il vous suffit d ouvrir le fichier d installation 3 depuis votre navigateur Firefox 4. Une fois l extension installée, elle peut être lancée à partir du menu «Outils/Editeur QSOS» du navigateur Firefox. Installer XulEditor en tant qu application autonome Pour pouvoir utiliser XulEditor en tant qu application autonome vous devez avoir auparavant installé Mozilla Xulrunner. Reporter vous au site officiel de Mozilla 5 pour le faire. Récupérez ensuite l archive de l application 6 et décompressez là où vous le désirez. L application XulEditor peut ensuite être lancé via les scripts xuleditor ou xuleditor.bat en fonction de votre système d exploitation Utiliser XulEditor Depuis l onglet Fichier, vous pouvez créer une nouvelle évaluation à partir d un template provenant soit de votre disque dur, soit du référentiel QSOS. C est ce deuxième cas qui est détaillé ici. Pour ce faire, cliquez sur le bouton Template distant et naviguez dans le référentiel des templates QSOS Au moment de la rédaction de ce tutoriel, la version la plus à jour de XulEditor est la 2.0. Pensez à installer la version la plus à jour au moment où vous lisez ce tutoriel. 5. https://developer.mozilla.org/en-us/docs/xulrunner 6. Document distribué sous licence FDL 10 Figure 9 Onglet Fichiers de XulEditor Document distribué sous licence FDL 11 Figure 10 Navigation dans le référentiel des templates QSOS Document distribué sous licence FDL 12 Vous pouvez filtrer les templates du référentiel en fonction du dépôt concerné (Master ou Incoming) et de la langue. Une fois le template sélectionné, vous pouvez alors commencer à saisir votre évaluation en complétant les champs des différents onglets. L onglet Général contient les informations relatives au logiciel évalué (nom, version, licence principale, etc.) et à l évaluation elle-même (template, auteurs). Figure 11 Onglet Général de XulEditor Vous remarquez que le nom et la version du template utilisés pour l évaluation apparaissent mais ne peuvent être modifiés. Pour plus de détail sur comment mettre à jour le template d une évaluation existante, reportez-vous au chapitre Appliquer une nouvelle version de template. L onglet Critères vous permet de naviguer dans l arbre des critères d évaluation et de les évaluer : en proposant un score entre 0 et 2 en fonction de la signification décrite par les auteurs du template que vous utilisez ; en précisant la raison et la source de votre notation. Pensez à motiver vos scores dans le champ Commentaires. Cela rend votre évaluation plus pertinente, plus utile et augmente ainsi ses chances d être rapidement Document distribué sous licence FDL 13 Figure 12 Onglet Critères de XulEditor Document distribué sous licence FDL 14 validée par la communauté QSOS. L onglet Graphe permet de naviguer de manière graphique dans l arbre des critères, sous forme de radar où vous pouvez cliquer sur les nœuds pour en voir les sous-critères ou naviguer via le fil d Ariane. Figure 13 Onglet Graphe de XulEditor Les critères colorés en rouge sont ceux n ayant pas encore été évalués. Cela vous permet de rapidement identifier les éléments manquants pour compléter votre évaluation Sauvegarder une évaluation Depuis l onglet Fichier de XulEditor vous pouvez sauvegarder votre évaluation sur votre disque dur (bouton Enregistrer en local) pour éventuellement l éditer plus tard (bouton Evaluation locale) Contribuer une évaluation Lorsque vous considérez que votre évaluation est complète - au moins pour une première version, vous pouvez alors la proposer à la communauté QSOS. Document distribué sous licence FDL 15 Deux méthodes sont possibles. La première est, de manière similaire aux templates, de vous connectez au backend QSOS 7. Figure 14 Envoi de l évaluation dans le référentiel QSOS Ceci nécessite de disposer d un compte sur l application O3S. Si vous n en possédez pas encore, créez en sur ce même site Web. Si vous disposez d un compte sur 03S, vous pouvez également enregistrer votre évaluation dans le référentiel QSOS directement depuis XulEditor, via le bouton Enregistrer sur le serveur de l onglet Fichier. Figure 15 Envoi dans le référentiel O3S depuis XulEditor 7. Document distribué sous licence FDL 16 Figure 16 Trace de votre contribution visible dans O3S À partir de ce moment, votre évaluation est visible de la communauté, dans le dépôt Incoming du référentiel QSOS. Si elle est considérée comme complète et objective, elle sera validée par la communauté et déplacée dans le dépôt Master. Pour contribuer une nouvelle version de votre évaluation, procédez de la même manière. 5.3 Modifier une évaluation existante XulEditor vous permet de modifier une évaluation QSOS provenant soit de votre disque dur, soit du référentiel QSOS. C est cette dernière méthode qui est décrite ici. Depuis l onglet Fichier, cliquez sur le bouton Evaluation distante. Vous pouvez alors naviguer dans le référentiel QSOS en filtrant les évaluations en fonction du type de logiciel concerné, du dépôt concerné (Master ou Incoming) et de la langue. Une fois l évaluation sélectionnée, vous pouvez alors la manipuler et la modifier dans XulEditor. Vous ne pouvez écraser une évaluation qui n est pas la vôtre. Le référentiel ne l autorise pas mais vous indique qui est l utilisateur qui a contribué l évaluation. Vous pouvez alors le contacter. Si jamais vous n arrivez pas à contacter cet utilisateur ou que vous restez sans retour de sa part, contactez un des validateurs de la communauté qui pourra alors arbitrer et vous débloquer. TODO : ajouter l adresse de la mailing list des validateurs. 5.4 Appliquer une nouvelle version de template XulEditor vous permet de mettre à jour le template utilisé par une évaluation. Cela permet d injecter des évolutions apportées au niveau du template mais aussi de faciliter la traduction de l évaluation (en appliquant un template déjà traduit). Pour réaliser cette opération, vous devez tout d abord ouvrir l évaluation à mettre à jour (boutons Evaluation locale ou Evaluation distante de l onglet Document distribué sous licence FDL 17 Figure 17 Navigation dans le référentiel des évaluations QSOS Figure 18 Tentative d écrasement d une évaluation Document distribué sous licence FDL 18 Fichier). Sélectionnez ensuite la nouvelle version de template à appliquer, qu elle provienne de votre disque dur (bouton Template local) ou du référentiel QSOS. C est ce dernier cas qui est décrit ici. Le bouton Template distant vous permet ainsi de naviguez dans le référentiel des templates QSOS. Figure 19 Navigation dans le référentiel des templates QSOS Vous pouvez filtrer les templates du référentiel en fonction du dépôt concerné (Master ou Incoming) et de la langue. Si vous sélectionnez un template de type différent de celui initialement utilisé pour réaliser l évaluation, XulEditor refuse de l appliquer et vous affiche un message d erreur. Si le nouveau template est dans une langue différente de celle du template initial, XulEditor vous demande confirmation avant de modifier votre évaluation. Et dans tous les cas, avant de modifier votre évaluation, XulEditor vous demande confirmation. Document distribué sous licence FDL 19 Figure 20 Erreur lors de l application d un mauvais type de template Figure 21 Demande de confirmation si le template est de langue différente Figure 22 Demande de confirmation de la modification Document distribué sous licence FDL 20 Notez qu il n est pas interdit d appliquer un template de version plus ancienne que le template actuellement utilisé. 5.5 Visualiser une évaluation en mode Web L application Web O3S permet, entre autres possibilités, de visualiser les évaluations du référentiel QSOS en mode Web. Cette application offre de nombreuses autres fonctionnalités, liées aux comparaisons QSOS. Reportez-vous au chapitre Gérer les comparaisons pour une description plus détaillée d O3S. Considérons ici que vous avez navigué dans O3S jusqu à l évaluation que vous désirer visualiser en mode Web. Figure 23 Page d accueil d O3S 03S propose trois formats de visualisation d une évaluation : format XML (.qsos) ; format HTML ; format FreeMind (.mm) Visualisation au format XML Lorsque vous sélectionnez dans O3S ce mode de visualisation, que vous utilisez Firefox et que l extension XulEditor est installée, cette dernière vous propose alors d ouvrir directement l évaluation dans l éditeur. Dans tous les cas, le fichier XML est également affiché par votre navigateur. Document distribué sous licence FDL 21 Figure 24 Visualisation au format XML Visualisation au format HTML Lorsque vous sélectionnez dans O3S ce mode de visualisation, l évaluation est affichée dans votre navigateur sous forme de page HTML. Cette page permet de plier et déplier les branches de l arbre des critères pour faciliter la lecture de l évaluation Visualisation au format FreeMind Lorsque vous sélectionnez dans O3S ce mode de visualisation, l évaluation est affichée dans votre navigateur sous forme de carte heuristique au format FreeMind (.mm). Cette page vous permet de réaliser les actions suivantes : naviguer dans l arbre des critères évalués en cliquant sur les éléments de la carte heuristique pour les plier/déplier ; utiliser le menu de navigation pour réaliser une recherche par mot clé ou pour déplacer la fenêtre de visualisation par rapport à l intégralité de la carte heuristique (en effet, certaines évaluations - une fois complètement dépliées - peuvent dépasser le cadre de la fenêtre de visualisation) ; utiliser le menu d affichage pour agrandir/réduire la taille de la police de caractères, pour ajuster la taille de la carte à celle de la fenêtre de visualisation et changer la couleur du fond de la carte ; sauvegarder le fichier.mm sur votre dur, en cliquant sur le titre de la carte heuristique. Bien qu il s agisse d un fichier au format FreeMind, notez bien que vous ne visualisez pas et ne sauvegardez pas un template QSOS mais bien une représentation Document distribué sous licence FDL 22 Figure 25 Visualisation au format FreeMind sous forme de carte heuristique d une évaluation. Notez que ce type de visualisation requiert que votre navigateur support le format Flash. 6 Gérer les comparaisons La méthode QSOS a
We Need Your Support
Thank you for visiting our website and your interest in our free products and services. We are nonprofit website to share and download documents. To the running of this website, we need your help to support us.

Thanks to everyone for your continued support.

No, Thanks
SAVE OUR EARTH

We need your sign to support Project to invent "SMART AND CONTROLLABLE REFLECTIVE BALLOONS" to cover the Sun and Save Our Earth.

More details...

Sign Now!

We are very appreciated for your Prompt Action!

x