Documenter son projet : Différence entre versions

(Page créée avec « {{Tuto Details |Main_Picture=Documenter_son_projet_IMG_20211209_145456.jpg |Main_Picture_annotation={"version":"2.4.6","objects":[{"type":"image","version":"2.4.6","origin... »)
 
 
(13 révisions intermédiaires par le même utilisateur non affichées)
Ligne 2 : Ligne 2 :
 
|Main_Picture=Documenter_son_projet_IMG_20211209_145456.jpg
 
|Main_Picture=Documenter_son_projet_IMG_20211209_145456.jpg
 
|Main_Picture_annotation={"version":"2.4.6","objects":[{"type":"image","version":"2.4.6","originX":"left","originY":"top","left":-228,"top":-5,"width":4608,"height":2074,"fill":"rgb(0,0,0)","stroke":null,"strokeWidth":0,"strokeDashArray":null,"strokeLineCap":"butt","strokeDashOffset":0,"strokeLineJoin":"miter","strokeMiterLimit":4,"scaleX":0.22,"scaleY":0.22,"angle":0,"flipX":false,"flipY":false,"opacity":1,"shadow":null,"visible":true,"clipTo":null,"backgroundColor":"","fillRule":"nonzero","paintFirst":"fill","globalCompositeOperation":"source-over","transformMatrix":null,"skewX":0,"skewY":0,"crossOrigin":"","cropX":0,"cropY":0,"src":"https://wikifab.org/images/e/e4/Documenter_son_projet_IMG_20211209_145456.jpg","filters":[]}],"height":449.3333333333333,"width":600}
 
|Main_Picture_annotation={"version":"2.4.6","objects":[{"type":"image","version":"2.4.6","originX":"left","originY":"top","left":-228,"top":-5,"width":4608,"height":2074,"fill":"rgb(0,0,0)","stroke":null,"strokeWidth":0,"strokeDashArray":null,"strokeLineCap":"butt","strokeDashOffset":0,"strokeLineJoin":"miter","strokeMiterLimit":4,"scaleX":0.22,"scaleY":0.22,"angle":0,"flipX":false,"flipY":false,"opacity":1,"shadow":null,"visible":true,"clipTo":null,"backgroundColor":"","fillRule":"nonzero","paintFirst":"fill","globalCompositeOperation":"source-over","transformMatrix":null,"skewX":0,"skewY":0,"crossOrigin":"","cropX":0,"cropY":0,"src":"https://wikifab.org/images/e/e4/Documenter_son_projet_IMG_20211209_145456.jpg","filters":[]}],"height":449.3333333333333,"width":600}
−
|Description=<translate>Cette page a pour objectif d'aider les makers à documenter leurs projets. Plusieurs supports sont fournis à cet effet :
+
|Description=<translate>Cette page propose différents supports dans l'optique d'accompagner les makers dans la documentation et réalisation de leurs projets.
−
- Un modèle type de document →
+
 
−
- Un exemple de documentation « idéale » →  un e
+
Ce projet est né d'une collaboration entre l'Edulab de l'Université Rennes 2 et les étudiants du CFTTR (Centre de Formation des Traducteurs-localisateurs, Terminologues et Rédacteurs techniques) dans le cadre du Hackathon POCL (Petit Object Connecté Ludique).</translate>
−
- Un poster →  Étapes de la rédaction
 
−
- Une check-list →  suivi de l'avancement
 
−
- Un guide de rédaction →  Bonnes pratiques et règles de rédaction</translate>
 
 
|Area=Machines and Tools
 
|Area=Machines and Tools
 
|Type=Rédaction
 
|Type=Rédaction
Ligne 14 : Ligne 11 :
 
|Duration-type=hour(s)
 
|Duration-type=hour(s)
 
|Cost=0
 
|Cost=0
−
|Currency=GBP (£)
+
|Currency=EUR (€)
 
|Tags=Rédaction, Documentation, Projet, Hackathon, Edulab
 
|Tags=Rédaction, Documentation, Projet, Hackathon, Edulab
 
}}
 
}}
Ligne 20 : Ligne 17 :
 
|Introduction=<translate></translate>
 
|Introduction=<translate></translate>
 
}}
 
}}
−
{{Materials}}
+
{{Materials
 +
|Tuto_Attachments={{Tuto Attachments
 +
|Attachment=Documenter_son_projet_Modele_documentation_complete.docx
 +
}}{{Tuto Attachments
 +
|Attachment=Documenter_son_projet_Modele_FR.docx
 +
}}{{Tuto Attachments
 +
|Attachment=Documenter_son_projet_Modele_EN.docx
 +
}}{{Tuto Attachments
 +
|Attachment=Documenter_son_projet_Poster_redaction.pdf
 +
}}{{Tuto Attachments
 +
|Attachment=Documenter_son_projet_Checklist.pdf
 +
}}{{Tuto Attachments
 +
|Attachment=Documenter_son_projet_Guide_de_style.pdf
 +
}}
 +
}}
 +
{{Tuto Step
 +
|Step_Title=<translate>Modèle de document</translate>
 +
|Step_Content=<translate>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. 
 +
 
 +
{{Info|Retrouvez le modèle en version française et anglaise dans les Fichiers.}}</translate>
 +
|Step_Picture_00=Documenter_son_projet_mod_le_1.PNG
 +
|Step_Picture_01=Documenter_son_projet_mod_le_2.PNG
 +
|Step_Picture_02=Documenter_son_projet_mod_le_3.PNG
 +
}}
 +
{{Tuto Step
 +
|Step_Title=<translate>Poster</translate>
 +
|Step_Content=<translate>Ce poster décrit les différentes étapes de documentation et propose quelques règles de rédaction. 
 +
 
 +
===='''Étapes'''====
 +
 
 +
#Choisir un titre et décrire le projet
 +
#Énumérer la liste des outils et matériels
 +
#Relever toutes les étapes du projet
 +
#Rédiger
 +
#Définir les caractéristiques du projet (durée, difficulté, coût, etc.)
 +
 
 +
<br />
 +
 
 +
===='''Règles de rédaction'''====
 +
 
 +
#Prendre des notes tout au long du montage
 +
#Numéroter les étapes par ordre chronologique
 +
#Éviter l'utilisation de jargon
 +
#Commencer chaque étape par l'impératif
 +
#Homogénéiser la formulation des phrases
 +
#Être clair et concis</translate>
 +
|Step_Picture_00=Documenter_son_projet_Poster_redaction_illustration.png
 +
}}
 
{{Tuto Step
 
{{Tuto Step
−
|Step_Title=<translate></translate>
+
|Step_Title=<translate>Check-list</translate>
−
|Step_Content=<translate></translate>
+
|Step_Content=<translate>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.
 +
 
 +
<br />{{Idea|Prenez des photos de toutes les étapes de montage.}}{{Dont|Ne regroupez pas toutes les idées en une seule étape. Un surplus d'information empêche la mise en valeur des étapes importantes.}}</translate>
 +
|Step_Picture_00=Documenter_son_projet_Checklist_illustration.png
 +
}}
 +
{{Tuto Step
 +
|Step_Title=<translate>Guide de style</translate>
 +
|Step_Content=<translate>Ce manuel décrit plus en détails les règles de rédaction à appliquer dans la documentation de votre projet.
 +
 
 +
{{Pin|1=Une étape = une action}}{{Pin|Privilégier la voix active}}{{Pin|Indiquer le résultat de l'action}}</translate>
 +
|Step_Picture_00=Documenter_son_projet_Guide_de_style_1.png
 +
|Step_Picture_01=Documenter_son_projet_Guide_de_style_2.png
 
}}
 
}}
 
{{Notes
 
{{Notes
Ligne 29 : Ligne 86 :
 
}}
 
}}
 
{{PageLang
 
{{PageLang
 +
|Language=fr
 
|SourceLanguage=none
 
|SourceLanguage=none
 
|IsTranslation=0
 
|IsTranslation=0
−
|Language=fr
 
 
}}
 
}}
 
{{Tuto Status
 
{{Tuto Status
−
|Complete=Draft
+
|Complete=Published
 
}}
 
}}

Version actuelle datée du 16 mars 2022 à 18:42

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 les étudiants du CFTTR (Centre de Formation des Traducteurs-localisateurs, Terminologues et Rédacteurs techniques) dans le cadre du Hackathon POCL (Petit Object Connecté Ludique).

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

Difficulté
Moyen
Durée
0 heure(s)
Catégories
Machines & Outils
Coût
0 EUR (€)
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 les étudiants du 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.

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.
Documenter son projet mod le 1.PNG
Documenter son projet mod le 2.PNG
Documenter son projet mod le 3.PNG


É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
Documenter son projet Poster redaction illustration.png




É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.
Documenter son projet Checklist illustration.png




É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
Documenter son projet Guide de style 1.png
Documenter son projet Guide de style 2.png



Commentaires

Published

Récupérée de « https://wikifab.org/w/index.php?title=Documenter_son_projet&oldid=145794 »
© 2017 - 2024 Dokit, SAS.