Documenter son projet

Auteur avatarCFTTR | Dernière modification 16/03/2022 par CFTTR

Cette page propose différents supports dans l'optique d'accompagner les makers dans la documentation et réalisation de leurs projets. Ce projet est né d'une collaboration entre l'Edulab de l'Université Rennes 2 et le CFTTR (Centre de Formation des Traducteurs-localisateurs, Terminologues et Rédacteurs techniques) dans le cadre du Hackathon POCL (Petit Object Connecté Ludique)
Difficulté
Moyen
Durée
0 heure(s)
Catégories
Machines & Outils
Coût
0 EUR (€)

Étape 1 - Modèle de document

Ces images sont une ébauche de la documentation d'un projet créée à partir du modèle.


Retrouvez le modèle en version française et anglaise dans les Fichiers.


Étape 2 - Poster

Ce poster décrit les différentes étapes de documentation et propose quelques règles de rédaction.





Étape 3 - Check-list

Cette check-list vous accompagne dans la rédaction. Une fois une étape achevée, il ne vous reste plus qu'à cocher la case correspondante.




Étape 4 - Guide de style

Ce manuel décrit plus en détails les règles de rédaction à appliquer dans la documentation de votre projet.



Commentaires

Draft