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,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].