Guide de documentation pour l'extrême Défi

Image :

Description en une ligne : Cette page vous aide à documenter, c'est à dire à documenter correctement le minimum.

Description :

Pourquoi et comment remplir la page d’Équipe ?

La documentation des pages d’équipes permettent à l’XD de montrer que les véhicules existent et d’assurer le transfert des connaissances au sein de la communauté de façon décentralisée, en réduisant le besoin d’un animateur central.

Mais surtout, nous faisons le possible pour que ce soit utile pour vous :

Une fois remplie, votre page d’“Équipe” peut vous permettre d’attirer d’autres équipes, fabricants, financeurs, compagnons, territoires et partenaires potentielles pour découvrir, venir aider et réagir sur votre projet
Partager ce que vous vos attentes et les partenariats que vous aimeriez nouer avec d’autres équipes.
Laisser une trace de l’historique du développement de votre projet

Quoi documenter ?

Le formulaire peut paraître intimidant, mais si vous n’avez pas encore tous les éléments, ou que vous ne savez pas comment y répondre, pas de panique.

Le plus important pour que d’autres partenaires puissent découvrir vos projets et proposer d’éventuelles contributions serait de décrire de manière claire et concise :

votre projet,
vos compétences sur votre Profil (exemple), ressources et expériences que vous aimeriez partager avec le reste de la communauté,
Vos besoins et les contributions que vous attendez,
des visuels, des diagrammes, des captures d’écran et des liens pertinents pour faciliter la compréhension du projet,
et pour les équipes candidates à la phase d’idéation, remplir les réponses aux dossiers Narratifs, Véhicule, Modèle économique, Ecosytèmes, Énergétique et Projet. Vous pouvez suivre ce lien pour plus de détails.

Pour tenir une documentation complète, l’idéal est de désigner un membre dédié à la documentation responsable de la maintenance et mettre régulièrement à jour la page avec les nouveaux développements et progrès. La documentation est également vivante ! vous pouvez commencer et y revenir régulièrement une fois par mois par exemple.

Documentation Open source

Si vous avez prévu de documenter une partie de votre projet en open source et que cherchez des exemples inspirant de documentation de projet, vous pouvez jeter un oeil du côté de Vhélio du projet de Charrette Bike de Véloma, et sur le guide de documentation open source de l’Université de Grenoble piloté par Jean-François Boujut.

Tags : documentation

Thème : Véhicules intermédiaires, eXtrême Défi

Organisations impliquées dans la ressource : ADEME

Référent (individu) : Gabriel Plassat, Jaime

Défi auquel répond cette connaissance : L'extrême défi ADEME

Communauté d’intérêt : Communauté de l'eXtrême Défi, Communauté des contributeurs et jardiniers du wiki

S’inscrire à une mailing liste : https://forum.fabmob.io/t/le-fond-la-forme-et-le-wiki-mais-pourquoi-un-wiki/563/3

Autres informations :