diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef8a30c..2fb7781 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -325,3 +325,49 @@ ![signalement dans mattermost](images/mattermost-tdm-signalement.png) ### Objectif TDM + +#### Fiche du service + +La fiche d'un service web doit avoir (le titre d'une section sera en style +`Titre 3`): + +- **titre**: le plus court et explicite possible +- **sous-titre**: la première phrase de la fiche fera office de description dans + la prévisualisation présente sur la page d'accueil d'objectif TDM, il faut + donc aller droit au but, pas besoin de construire une phrase. Si la phrase est + trop longue, il est possible qu'on n'en voie que le début +- **description**: plus longue et détaillée que le sous-titre, décrit ce que + fait le service web. +- **image**: idéalement, un usage de l'enrichissement dans LODEX +- **algorithme**: une section consacrée à la manière dont fonctionne le service + (est-ce un apprentissage, une heuristique, ...) +- **qualité**: une section donnant une idée de la qualité du service + (expérimental, avec des retours utilisateurs, avec une f-mesure, rappel, + bruit, précision, ...). Ne s'applique pas de la même manière suivant les + algorithmes. +- **corpus d'apprentissaga / test**: sur quelles données s'appuient les tests + et/ou l'apprentissage +- **références**: bibliographie + code source (liens) + +Exemple de sous-titre trop long: + +![Sous-titre n'allant pas droit au but](images/objectif-tdm-sous-titre-long.png) + +La catégorie à affecter à la fiche est `Web-services`, pas `Blog/Webservices`. + +![catégorie de la fiche](images/objectif-tdm-categorie-fiche.png) + +Blocs à remplir: + +- **URL Lodex**: on y met l'URL du service +- **Entrée**: généralement un JSON, on utilise l'extension `Code Block` pour + coloriser le code et garder les indentations. +- **Résultat**: comme l'Entrée. +- **Utiliser**: lien vers l'OpenAPI +- **Se documenter**: lien vers l'article générique + + +![blocs à remplir](images/objectif-tdm-blocs.png) + +#### Article d'annonce + diff --git a/images/objectif-tdm-blocs.png b/images/objectif-tdm-blocs.png new file mode 100644 index 0000000..4053c02 --- /dev/null +++ b/images/objectif-tdm-blocs.png Binary files differ diff --git a/images/objectif-tdm-categorie-fiche.png b/images/objectif-tdm-categorie-fiche.png new file mode 100644 index 0000000..22a7ca3 --- /dev/null +++ b/images/objectif-tdm-categorie-fiche.png Binary files differ diff --git a/images/objectif-tdm-sous-titre-long.png b/images/objectif-tdm-sous-titre-long.png new file mode 100644 index 0000000..70dc51b --- /dev/null +++ b/images/objectif-tdm-sous-titre-long.png Binary files differ