Différences entre les versions de « Comment faire de la Doc »
| (3 versions intermédiaires par le même utilisateur non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
{{Projet}} | {{Projet}} | ||
[[Image: HowToDocMascot.jpg| | [[Image: HowToDocMascot.jpg|400px|right|thumb|]] | ||
[[Category:Documentation]] | |||
[[Category:Initiations]] | |||
[[Category:Tuto]] | |||
= Fiche signalétique du projet = | = Fiche signalétique du projet = | ||
| Ligne 14 : | Ligne 18 : | ||
Projet : Comment documenter - How to doc | Projet : Comment documenter - How to doc | ||
Git hub project. | [https://volab.github.io/howto_doc Git hub project.] | ||
[[Image:Octocat.png|50px]] | [[Image:Octocat.png|50px|link=https://volab.github.io/howto_doc/]] | ||
= Problématique = | = Problématique = | ||
Version actuelle datée du 3 novembre 2018 à 17:41
← Accueil ← Nos Projets
Fiche signalétique du projet
Date : 10/10/2018
Auteur : Pierre
Relecteur : Joël
Thème: La documentation en général
Projet : Comment documenter - How to doc
Problématique
Le projet HowTo_Doc est un document (EN FRANÇAIS) expliquant comment il faut s’organiser pour Créer / Gérer un projet depuis le début.
Il explique également comment il faut penser à la documentation avant même de commencer le projet.
Ce document, bien qu’étant très complet, ne représente pas la méthode universelle qu’il faut absolument suivre pour faire de la documentation.
Je vous présente simplement ma méthode agrémentée de quelques informations pratiques qui je l’espère vous permettront de définir votre propre méthode de travail.
De la méthode et de l’organisation peut vous aider dans votre travail mais ce n’est pas absolument nécessaire tant que vous faites l’effort de documenter vos projets.
webographie
Ce projet en entièrement hébergé sur le github du VoLAB
Sources
Les sources sont ici sur le compte github du VoLAB
Licence
(voir l'article sous github )
Rédaction en langue française
Partant du constat de terrain qu'une énorme masse d'information concernant les sujets qui nous intéressent comme entre autres l'impression 3D n'étaient disponibles que dans la langue de Shakespeare
et que de nombreuses personnes dans notre entourage ne maîtrisaient pas la dite langue et soucieux de diffuser encore plus l'information,
nous avons pris le parti, au VoLAB, de rédiger nos documents de préférence en langue française.
VoLAB
Un mot sur le VoLAB. VoLAB est un fablab implanté à environ 28km au nord-ouest de Paris dans l'agglomération de Cergy Pontoise.
Il est animé par l'association VoRoBoTics.
Site internet www.vorobotics.com
← Accueil ← Nos Projets