Toutes les thématiques

Gestion de projet Documentation Git & GitHub

Méthodologie de projet

Apprendre à cadrer, documenter et gérer un projet de A à Z : du repo GitHub à la présentation finale, en passant par le travail en équipe.

16 tutoriels ~19h

Commencer

Présentation

Bienvenue dans l’atelier Méthodologie de projet !

Vous allez apprendre à cadrer, documenter et gérer un projet de bout en bout : créer et faire vivre un repo GitHub, organiser le travail en équipe, documenter au fil de l’eau plutôt qu’au dernier moment, et présenter proprement chaque brique de votre projet (électronique, mécanique, logiciel).

Ce que vous allez apprendre

Cadrer un projet : besoin, cahier des charges, cycle de vie
Documenter en continu, pas seulement à la fin
Organiser une équipe et communiquer efficacement
Utiliser Git et GitHub pour versionner, suivre et relire le travail
Construire et maintenir un site de documentation Jekyll
Documenter chaque brique du projet (électronique, mécanique, code, tests, montage)
Clôturer et transmettre un projet correctement

Pourquoi ce projet ?

Un projet réussi ne se limite pas à un prototype qui fonctionne : il doit pouvoir être compris, repris et transmis. Cet atelier donne la méthode et les outils utilisés au MakerSpace pour que chaque projet étudiant reste exploitable après le rendu : pour vous, pour l’équipe suivante, et pour l’école.

Crédit photo : « Male Student Engineer Discussing Ideas with Project Leader while Working with Computer Motherboard. » par Aleksei Gorodenkov, via Noun Project, sous licence CC BY-NC-ND 2.0.

Le cours

Le programme des séances et ce sur quoi vous êtes évalués.

Syllabus du cours Objectifs, organisation et déroulé des séances

Évaluation du cours Ce qui est évalué, en groupe et individuellement

Slides

Les supports de présentation des séances, à projeter en plein écran.

Méthodologie de projet Séance 1 : lancer la démarche

Méthodologie de projet Séance 2 : cadrer et regarder ce qui existe

Méthodologie de projet Séance 3 : découper et s'organiser

Méthodologie de projet Séance 4 : choisir et documenter

Concepts

Les notions clés à comprendre avant de se lancer.

Cycle de vie d'un projet Comprendre les étapes d'un projet et les liens entre elles

Documenter au fil de l'eau Le principe le plus important de cet atelier

Définir son besoin et son cahier des charges Poser les bonnes questions avant de foncer

Rechercher l'existant et étudier la faisabilité Ne pas réinventer ce qui existe déjà, ni découvrir un mur à la semaine 6

Constituer et organiser son équipe Décider qui fait quoi avant que ça devienne un problème

Communiquer en équipe Un outil de projet, pas juste "bien s'entendre"

Gérer le temps et les jalons Le temps d'un projet physique ne se compresse pas en travaillant plus fort

Prototyper et itérer La v1 brute qui fonctionne bat la v1 parfaite qui n'existe pas encore

Tracer ses choix techniques Pourquoi celui-là et pas un autre

Rendre son projet transmissible Un projet n'est pas fini quand il fonctionne, mais quand quelqu'un d'autre peut le reprendre

Tutoriels

Suivez les étapes dans l'ordre pour réaliser le projet de A à Z.

1

Créer son repo depuis le template et le cloner Le point de départ technique de tout le projet

Git, GitHub Desktop et VSCode Le cycle modifier / commit / push au quotidien

Personnaliser le template de son projet Ce qu'il faut modifier, ce qu'il faut supprimer, et dans quel ordre

Syntaxe Markdown Écrire de la documentation sans jamais toucher au HTML

Rédiger un README de projet efficace La première (et parfois seule) chose que quelqu'un lira

Gérer son projet avec GitHub - Issues et Projects Répartir et suivre les tâches sans post-it ni fichier Excel

Modifier son site Jekyll depuis l'interface GitHub Activer votre site, puis l'éditer sans rien installer

Construire son site Jekyll en local Voir le rendu final avant de publier, sans attendre GitHub

Tenir un journal de bord L'outil concret pour documenter au fil de l'eau

Documenter une carte électronique Schéma, PCB, nomenclature (de quoi refaire le montage)

Documenter un système mécanique Des plans qu'on peut vraiment réutiliser, pas juste regarder

Documenter son code et son firmware Que le code se lise sans qu'on ait dû l'écrire soi-même

Documenter l'assemblage et le montage Un guide qu'on peut suivre sans avoir vu le prototype avant

Documenter les tests et résultats La preuve que le projet fonctionne, pas juste l'affirmation

Créer le poster et la vidéo de présentation Résumer des semaines de travail en une image et 90 secondes

Checklist de clôture de projet Le dernier passage, pas la première rédaction

Guides pratiques

Résolvez un problème précis, étape par étape.

Comprendre la propriété intellectuelle de son projet Droit d'auteur, brevets, open source et licences

Utiliser les Pull Requests et résoudre un conflit Git Utilisation avancée de Git, pas indispensable pour tous les projets