Dans le cadre de mes études en Techniques de la documentation, j'ai eu à réaliser un projet d'intervention chez Les Solutions Huwiz. Le projet consistait à soumettre une proposition de réorganisation de leur base de connaissances internes pour en améliorer la convivialité et le repérage des informations nécessaires au travail des analystes qualité logicielle.
Note: certaines images ont été modifiées pour préserver la confidentialité des projets en cours.
Projet Confluence - Une base de données de type Wiki
1. Confluence
Une base de connaissances
de type Wiki
Par Samuel Paradis et Mylène Roffi, stagiaires en
Techniques de la documentation
Les Solutions Huwiz inc.
298 de Martigny Ouest, bureau 200
Saint-Jérôme, Qc
2. Introduction
Les solutions Huwiz inc. est une entreprise spécialisée dans le secteur de
l’assurance qualité pour des logiciels, principalement les jeux vidéos.
L’entreprise offre plusieurs services:
● Tests de Fonctionnalité: est-ce que l’application fonctionne?
● Tests de Conformité: est-ce que l’application rencontre les normes des
fabricants de consoles?
● Tests de Compatibilité: est-ce que l’application rencontre les standards de
performance?
● Groupes Focus: est-ce que l’application est agréable à utiliser?
3. Confluence
Confluence est un logiciel en ligne de type Wiki, développé par Atlassian.
Il est utilisé pour partager les informations nécessaires aux analystes pour leurs
tests, tant sur les projets en tant que tels que sur le domaine du jeu vidéo en
général.
Tous les employés de Huwiz sont invités à ajouter dans Confluence les
informations jugées pertinentes pour un projet, comme un guide sur comment
atteindre certaines zones d’un jeu, en plus des dizaines de documents sur les
procédures de test, les tutoriels pour les divers outils et les lignes directrices des
divers fabricants des consoles.
4. Avantages
● Plusieurs utilisateurs peuvent mettre à jour un document (une page) en temps
réel.
● Suivi des modifications avec la possibilité de restaurer une version
précédente.
● Regroupe l'information en un seul endroit.
● Réduit le risque de dupliquer l'information ou de transmettre de l'information
caduque.
● Partage l'expérience des employés.
● Propose plusieurs outils pour faire des liens entre les articles.
5. Inconvénients
● Nécessite une certaine modération pour garder la présentation du contenu
constant.
● Peut devenir intimidant à éditer à cause des macros (des outils pour la
présentation des pages et l’automatisation d’opérations complexes)
● Structure d’organisation peu présente, à moins de la créer à l’interne.
6. Le projet
Dans le cadre du cours 393-DE2-LG Projet d’intervention, les étudiants ont été
approchés pour réorganiser Confluence.
Les buts du projet:
● Améliorer le classement: créer une structure hiérarchique pour les pages.
● Améliorer l’indexation: favoriser l’utilisation des étiquettes (mots-clés attachés
à une page).
● Uniformiser la présentation de l’information: s’inspirer des encyclopédies
collaboratives telles que Wikipédia ou PC Gaming Wiki.
7. Le processus de réflexion
Préparation
1. Rencontre avec la direction: déterminer les buts et objectifs de l’intervention.
2. Inventaire de la documentation déjà en place.
3. Création d’un sondage auprès des analystes: comprendre la situation et
l’utilisation au jour le jour.
4. Familiarisation avec Confluence: découvrir les fonctions et possibilités du
logiciel.
5. Recherche de sources d’inspiration: explorer les wikis et trouver des
caractéristiques communes intéressantes pour le projet.
8. Le processus de réflexion (suite)
Préparer une proposition
1. Réflexion séparée par chacun des membres de l’équipe.
2. Mise en commun des hypothèses.
3. Préparation d’une proposition commune.
4. Présentation de la proposition à la direction.
5. Améliorer la proposition en fonction des commentaires.
6. Tester la proposition dans un environnement séparé.
7. Recommencer les étapes 4 à 6 jusqu’à ce que la proposition soit acceptée.
9. Appliquer la solution
Compte tenu de la durée du Projet, il n’a pas été possible de procéder à
l’implantation du plan proposé.
Cependant, afin de préparer celle-ci, les étudiants ont préparé des guides et des
tutoriels pour ceux qui auront à le faire ainsi que quelques pages qui serviront
d’exemples.
10. Avant
● Arborescence modifiée au gré des
pages créées
● Articles en double (anglais/français,
deux pages semblables, etc.)
● Présentation variée en fonction du
créateur de la page
● Mise en page réalisée avec des
macros
● Onglets pour séparer le contenu en
sections
● Structure hiérarchique solide et
flexible
● Articles uniques dont le titre est en
anglais et le corps est en français
(les termes du domaine sont
majoritairement en anglais)
● Présentation uniforme, épurée
● Mise en page simplifiée
● Table des matières automatique
utilisant la mise en forme
Après
11. Le résultat
Voici quelques captures d’écran pour illustrer la situation actuelle (avant) et la
situation recommandée par l’équipe dans la proposition de réorganisation (après).
Notes
Les captures d’écran ont été éditées afin de préserver la confidentialité des activités de l’entreprise, tel
que stipulé dans la clause de non-dévoilement signée au début du projet.
De plus, certains éléments qui demandaient une programmation plus poussée ont été remplacés par des
paramètres fictifs afin de pouvoir visualiser le résultat final.
12. Page d’Accueil - Avant
Notes
● Le tableau des tâches de
la journée est une capture
d’écran d’un fichier Excel.
● Les liens Documentation
et Outils sont peu utilisés.
● Les liens vers les projets
ne sont pas toujours à
jour.
13. Page d’Accueil - Après
Notes
● Le tableau des tâches de
la journée est dynamique
● Ajout d’une section pour
les annonces
● Les liens vers les projets
sont générés par une
macro avec les étiquettes
● Ajout de liens rapides,
activité récente et
étiquettes les plus utilisées
14. Page d’Accueil de la partie Encyclopédie (ajout)
Notes
● La boîte de recherche est
confinée aux articles de
l’Encyclopédie
● Liens rapides vers les
catégories d’articles
● Articles populaires, liens
externes, Aide
● Index des étiquettes
● Actualité
15. Page procédure - Avant
Notes
● Aucune table des matières
● Beaucoup de texte, peu
d’images ou d’exemples
● Mise en forme plus
semblable à des notes de
cours qu’à un wiki
16. Page procédure - Après
Notes
● Ajout d’une table des
matières
● Le texte est réparti en
tableaux plus faciles à lire
qu’une description
● Mise en forme fortement
inspirée des wikis
● Ajout de liens vers d’autres
articles et de tutoriels
imagés
17. Page Glossaire - Avant
Notes
● Tableau par ordre
alphabétique de termes
liés aux jeux vidéos
● Définitions peu mises à
jour
● Peu d’exemple concrets
18. Page Glossaire - Après
Notes
● L’appellation Répertoire
terminologique a été
préférée à Glossaire
● Tableaux par catégories
● Liens vers les articles
individuels avec exemples
● Définitions extraites des
pages individuelles
● Ajout de liens vers des
ressources externes
19. Page Client - Avant
Notes
● Page presque vide
● Aucune information sur le
client
● Contient uniquement une
liste manuelle des projets
du client
20. Page Client - Après
Notes
● Informations essentielles
sur le client
● Informations sur la ou les
bases de données
utilisées pour les rapports
de bogues
● Procédures spécifiques
● Liens automatiques vers
les pages des projets
● Galerie d’images
21. Page Projet - Avant
Notes
● Le logo prend beaucoup
d’espace en haut
● Introduction copiée-collée
du site du projet
● Présence d’onglets vides
lorsqu’il n’y a pas de
données
● Informations essentielles
dispersées dans les
onglets
22. Page Projet - Après
Notes
● Logo avec les informations
rapides sur le projet
● Introduction rédigée par
les analystes (±150 mots)
● Information essentielle au
début
● Création de sous-page
pour les segments
d’information plus longs
(Ressources)
23. Page Projet, mode édition - Avant
Notes
● Beaucoup de macro pour
la mise en page
● Peu flexible
● Intimidant à éditer pour les
analystes
● Difficile de comprendre où
insérer l’information
24. Page Projet, mode édition - Après
Notes
● Peu de macro complexes
● Mise en page minimaliste
● Table des matières
automatiques qui suit la
mise en forme
● Facile à éditer
● Uniquement les sections
pertinentes
25. Page Tutoriel sur Confluence (ajout)
Notes
● Infos rapides à droite
● Introduction et table des
matières
● Ressources
● Aperçu de l’outil
● Utilisation de tableaux et
de captures d’écran pour
organiser l’information
● Liens vers d’autres articles
intégrés au texte