Vous êtes ici : Accueil Modéliser Rédaction du rapport

Rédaction du rapport

Comment rédiger son rapport

Un rapport qui serait rédiger strictement et uniquement en UML / SysML n'aurait que peu de sens. Il est important d'accompagner les modèles de quelques explications textuelles.

Afin de faire du modèle UML / SysML un véritable outil de travail et ainsi dépasser le simple stade du rapport, il faut le rendre interactif et permettre aux collaborateurs qui travaillent sur le projet d'échanger autour de ce document et de le faire évoluer au fur et à mesure de l'avancement du projet.

Pour reprendre l'analogie avec les architectes c'est exactement ce qui ce passe avec les plans sur les chantiers quand les artisans réalisent le plan et le modifient au fur et à mesure qu'ils rencontrent les réalités du terrain.

L'une des façons les plus simple pour mettre en œuvre cette interactivité est l'intranet.

En effet il permet de créer des pages avec des liens et ainsi de placer sur une même page diagrammes, explications, modèles UML / SysML  et codes en téléchargement tout en créant des liens entre les pages et les diagrammes.

Ceci requiert une charge de travail supplémentaire mais tout à fait rentable sur des projets qui vont faire collaborer des personnes pendant toute la durée du projet.

Pour le rendre compréhensible et facile à consulter il est bon de le structurer en respectant la forme générale du plan ci dessous :

Exemple de rapport UML :

Partie I – Description du projet

  • Description rapide de l'entreprise qui souhaite se doter de la solution et de son existant.
  • Description rapide des objectifs du projet et de ses contraintes.
  • Présentation des acteurs qui vont interagir avec le système.
  • Présentation des fonctionnalités attendues du système (diagrammes des cas d'utilisations).
  • Descriptif textuel ou graphique (diag activité par exemple) fonctionnalité par fonctionnalité (cela constitue la base du cahier de recette).
  • Explication du fonctionnement dynamique de chaque fonctionnalité (diagrammes de séquence, diagrammes d'activité, diagrammes d'état).
  • Présentation des besoins techniques (diagrammes de déploiement, diagrammes de uses cases, de séquence, d'état et diagrammes d'activité).

Partie II – Analyse

  • Description de l'architecture générale du projet, des principaux packages de leurs rôles et de leurs interfaces.
  • Description package par package des diagrammes de classe qui les constituent.
  • Présentation des diagrammes d'état et des diagrammes d'activités détaillés.

 

Exemple de rapport SysML :

Partie I – Description du projet

  • Description rapide de l'entreprise qui souhaite se doter de la solution et de son existant.
  • Description rapide des objectifs du projet et de ses contraintes.
  • Présentation des acteurs qui vont interagir avec le système.
  • Présentation des fonctionnalités attendues du système (diagrammes des cas d'utilisations).
  • Descriptif textuel fonctionnalité par fonctionnalité (cela constitue la base du cahier de recette).

Partie II – Analyse

  • Architecture fonctionnelle : Description des fonctions à développer dans le système pour répondre aux fonctionnalités (Uses Case).
  • Remarque : Pour créer une architecture logique/fonctionnelle on va utiliser le diagramme de bloc.
  • Architecture logique dynamique : Description du comportement de chacune des fonctions ainsi que des modes de fonctionnement du système.
  • Architecture physique : Description structurelle du système. On part de la boîte noire du système puis on fait le description des sous-ensembles physiques qui  vont le constituer. Par exemple pour une voiture on a la voiture en boîte noire puis on décompose. Dans le cas d'un équipement embarqué on a le boîtier puis on décompose les différentes cartes qui constituent le boîtier.
  • Répartition des fonctions (architecture logique) sur l'architecture physique et choix d'implémentation.  On fait une allocation des fonctions logiques sur les sous-ensembles physiques puis on choisit de les implémenter en hard/ soft/ mécanique/ hydraulique...




Actions sur le document
Références
 
Site réalisé et hébergé par www.optragroup.fr