Guide du développeur

Introduction

Ce guide est destiné aux développeurs et son but est de décrire les composants du logiciel, notamment les objets et les fonctions. Mais il permet aussi d’avoir une vue d’ensemble sur le développement du code et sur les perspectives possibles.
Notre guide permettra également à chacun de contribuer au développement du logiciel, s’il le souhaite.

Organisation du programme

Le dossier est composé de 2 fichiers javascript. Un parser nommé parser.js et un nommé projet.js contenant toutes les fonctions et commandes. Ce dernier est divisé en deux parties, dans la première se trouvent les fonctions; celles-ci sont appelées par la deuxième partie du code où se trouvent les différentes commandes.

Développement du logiciel

Vous devez implémenter de notre logiciel à l’aide de NodeJS et du langage de programmation JavaScript. Pour utiliser notre outil, ouvrez l’invite de commande “Node.js prompt command” puis placez-vous dans le répertoire où se trouvent les fichiers javascript et les données. Installer ensuite les modules vega-lite, colors, vega et caporal pour permettre une utilisation optimale de notre logiciel.

Pour apporter des améliorations à notre projet :

• Modifiez le numéro de version à chaque fois
• Mettez à jour le fichier texte ReadMe.txt
• Vérifiez le bon fonctionnement des autres fonctions et/ou pouvant avoir été altérées par vos modifications
  > par exemple showSymbols, showBusyDay, showTopInterloc, showTopObjet sont liées dans le code
• Commentez vos modifications

Pistes d’améliorations et perspectives d’évolution

Nous pourrions, dans le futur, proposer quelques pistes de changements pour perfectionner le code. Voici quelques améliorations possibles :

1. Amélioration du ReadMe en explicitant clairement quelle commande saisir pour accéder aux spécifications choisies

2. Modifier les commandes pour y intégrer les fonctions et simplifier le code, pour permettre une évolution et une maintenance plus efficace du logiciel

3. Simplifier le parser en évitant les affichages par son biai et donc permettre plus de modifications

4. Pouvoir afficher un top choisi par l’utilisateur → top10, top 20 ou top 36 par exemple pour les options shoTopInterloc et showTopObjet

5. Pouvoir afficher la fonction du collaborateur dans la commande contact

6. Pouvoir afficher le nombre de mails échangés entre deux collaborateurs donnés sur une période donnée dans la commande count

7. Extraire les listes et les données en format .txt en plus de les afficher dans l’invite de commande

8. Créer un diagramme en fonction des arguments saisis par l’utilisateur → nombre d’échanges en fonction du nom du collaborateur ou de sa fonction, nombre d’échanges en fonction du jour…