Squelette de Rapport et README

This commit is contained in:
PACT
2022-09-22 14:17:23 +02:00
committed by TG
parent b06bd558b7
commit 5ce5c7e5e1
26 changed files with 947 additions and 0 deletions

View File

@@ -0,0 +1,13 @@
=== Interface utilisateur graphique
Il peut y avoir une ou plusieurs interfaces utilisateur (UI en anglais),
ou interface graphique, ou interface homme machine (IHM) : une interface
sur ordinateur et/ou une interface sur mobile ou tablette (Android),
selon le nombre dappareils en jeu.
En lien avec un diagramme de séquence, une description simple de chaque
écran/page est nécessaire. Il est recommandé de faire des dessins, même
dessins au crayon, photographiés ou scannés, car ce sont les meilleurs
supports de discussion : on appelle souvent ces dessins un
« storyboard ». Une description textuelle fait le lien entre tous les
éléments de lIHM (ou des IHMs).

View File

@@ -0,0 +1,23 @@
=== Description des interfaces (PAN1 / PAN2)
Pour le PAN1, il faut identifier et décrire sommairement toutes les
interfaces entre modules.
Pour le PAN2, il faut une description complète des interfaces.
Il faut ici une description textuelle de chaque interface, c'est-à-dire chaque
échange entre deux blocs.
Si cest une interface entre deux blocs informatiques, cest une interface
Java.
Sil y a des échanges de données complexes, il faut en décrire le format avec
précision.
Si cest une interface entre deux blocs électroniques, cest une description
des signaux électroniques ou protocoles utilisés.
==== InterfaceBloc1-2
Description textuelle dinterface
==== InterfaceBloc2-4
Description textuelle dinterface

View File

@@ -0,0 +1,78 @@
=== Schéma darchitecture
Insérer ici un ou plusieurs schémas darchitecture du projet. Voir le
cours dintroduction au Génie Logiciel. Nhésitez pas à faire des
schémas hiérarchiques, c'est-à-dire avec un bloc dun schéma général
raffiné dans un second schéma ; ou des schémas en plusieurs parties.
*Exemple utilisant http://www.graphviz.org/Documentation.php[graphviz]*
Voir la liste des outils supportés par http://asciidoctor.org/docs/asciidoctor-diagram/[asciidoctor-diagram].
**(Vous pouvez, bien sûr, utiliser votre outil de dessin préféré).**
[graphviz, arch-diag, svg]
....
digraph MonGraph {
graph [rankdir = LR, splines=ortho];
node[shape=record];
BlocIn[label="La source", height=2];
Hub[label="Le «dispatcheur»", height=4];
BlocOut1[label="Première sortie", height=2];
BlocOut2[label="Seconde Sortie", height=2];
BlocIn -> Hub [label="Image"];
BlocIn -> Hub [label="Son"];
BlocIn -> Hub [label="Émotion"];
Hub -> BlocOut1 [label="Musique"];
Hub -> BlocOut1 [label="Chant"];
BlocOut1 -> Hub [label="commande"];
Hub -> BlocOut2 [label="Image"];
Hub -> BlocOut2 [label="commande"];
}
....
==== Description des blocs
Il faut ici une description textuelle de chaque bloc, sa fonction
détaillée. En général, un bloc correspond à un module, sauf exception.
Il peut être adapté de faire des blocs plus petits quun module.
Il est important ici de distinguer les bibliothèques identifiées et
disponibles de ce que vous allez produire (coder) vous-même. Vous ne
devez pas réinventer la roue, mais vous ne devez pas non plus avoir votre
projet tout fait en encapsulant un programme déjà existant.
===== NomBloc1
Description textuelle du bloc 1.
===== NomBloc2
Description textuelle du bloc 1.
*Exemple utilisant http://blockdiag.com/en/actdiag/index.html[actdiag]*
**(Vous pouvez, bien sûr, utiliser votre outil de dessin préféré).**
[actdiag, diag_activite, svg]
....
actdiag {
ecrire -> convertir -> afficher
lane user {
label = "User"
ecrire [label = "Décire les matrices"];
afficher [label = "Afficher la courbe"];
}
lane converter {
label = "Convertisseur"
convertir [label = "Convertir\n en utilisant\n@@"];
}
}
....
Voir la liste des outils supportés par http://asciidoctor.org/docs/asciidoctor-diagram/[asciidoctor-diagram].

View File

@@ -0,0 +1,23 @@
=== Diagramme de séquence (optionnel)
Insérer ici un ou plusieurs diagrammes de séquence ou dactivité du
projet. Voir le cours dintroduction au Génie Logiciel.
Il peut y avoir plusieurs diagrammes, un par scénario. Sil y
a dans le projet un dialogue client-serveur, il peut être utile de faire un
diagramme de séquence spécifique pour ce dialogue.
*Exemple utilisant plantuml*
**(Vous pouvez, bien sûr, utiliser votre outil de dessin préféré).**
[plantuml, sequence-x]
....
browser -> webserver :GET /index.html
browser <-- webserver
browser -> webserver :POST /blog/comment
webserver -> database:INSERT comment
webserver <-- database
browser <-- webserver
....
Voir la liste des outils supportés par http://asciidoctor.org/docs/asciidoctor-diagram/[asciidoctor-diagram].

View File

@@ -0,0 +1,33 @@
=== Tableau détaillé des tâches
****Note : 2 pages max - les fiches modules seront placées en annexe,
elles doivent être rédigées avec lexpert.****
Les différents aspects du projet sont découpés en tâches numérotées et
hiérarchisées (Tâches/sous-tâches, etc.). Chaque tâche est décrite précisément
et une équipe (typiquement un binôme) est affecté à sa réalisation. Un module
est typiquement constitué de plusieurs tâches et sous-tâches.
Pour le PAN3, vous aurez à démontrer une version, *intégrée* et fonctionnelle de
votre projet.
Entre le PAN3 et le PAN4, vous pourrez améliorer les fonctionnalités intégrées
sans pour autant en ajouter de nouvelles.
Reprenez et complétez le tableau suivant en précisant les différentes tâches et
sous-tâches ainsi que le (ou les) critères de réussite pour l'intégration au
PAN3. La définition des critères de réussite doit se faire en accord avec les
experts.
[cols=",,^",options="header",]
|====
| Tâche | Description | Critères de réussite pour l'intégration au PAN3
| T1 | Classificateur dimage | interfaces logicielles finalisées
| T1.1 | Changement espace de couleur pour permettre … | au moins une transformation implémentée
| T1.2 | Extraction de lhistogramme à partir de lespace XYZ… | …
| T1.3 | Extraction des caractéristiques … | …
| T1.4 | Comparaison des caractéristiques | …
| T2 | Détection de rythme (Module « Audio/Rythme ») | interfaces logicielles finalisées
| T2.1 | Découpage signal sonore en bande fréquentielle | la méthode X doit être implémentée
| T2.2 | Détection du tempo | …
| T2.3 | Changement de tempo | …
|====