Documenter son projet

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é

Medium Moyen

Durée

0 hour(s) heure(s)

Catégories

Machines & Outils

Coût

0 EUR (€)

Rédaction, Documentation, Projet, Hackathon, Edulab Documenter_son_projet_IMG_20211209_145456.jpg Rédaction

Matériaux

Outils

Documenter_son_projet_Modele_documentation_complete.docx

Documenter_son_projet_Modele_FR.docx

Documenter_son_projet_Modele_EN.docx

Documenter_son_projet_Poster_redaction.pdf

Documenter_son_projet_Checklist.pdf

Documenter_son_projet_Guide_de_style.pdf

Étape 1 - Modèle de document

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

Inspiré des pages Wiki, ce modèle reprend tous les éléments dont vous avez besoin pour créer votre propre page de projet.

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.

Étapes

1. Choisir un titre et décrire le projet
2. Énumérer la liste des outils et matériels
3. Relever toutes les étapes du projet
4. Rédiger
5. Définir les caractéristiques du projet (durée, difficulté, coût, etc.)

Règles de rédaction

1. Prendre des notes tout au long du montage
2. Numéroter les étapes par ordre chronologique
3. Éviter l'utilisation de jargon
4. Commencer chaque étape par l'impératif
5. Homogénéiser la formulation des phrases
6. Être clair et concis

É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.

Prenez des photos de toutes les étapes de montage.

Ne regroupez pas toutes les idées en une seule étape. Un surplus d'information empêche la mise en valeur des étapes importantes.

É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.

Une étape = une action

Privilégier la voix active

Indiquer le résultat de l'action

fr none 0 Draft