• Tell by mail
  • Export to OpenOffice
  • Export to PDF
  • Add page to book
  • Tools:

Documentation Open Source

document initialement construit collaborativement par le cercle “Open Doc” le 15-7-15 (initialement ici : https://bimestriel.framapad.org/p/cercle_doc_open_source_-_reunion_du_15-7-15 )

N'hésitez pas à contribuer, explorer, faire part de vos découvertes, expériences sur le sujet :)

Missions du cercle

Général :

  • Définir les outils utilisés : voir section Open Source documentation : Outils
  • Organiser et entretenir l'arborescence du partage public
  • Maintenir la liste de ressources :
    • listes de pièces,
    • listes de fournisseurs,
    • listes d'outils,
    • liste des FabLAB équipés pour produire les pièces de nos machines…
    • listes d'autres informations pratiques pour la réalisation des machines

Nos projets de R&D :

  • Responsabilité documentaire dans chaque projet de Recherche et Développement en cours
    • Organisation en cercle-projet, avec 1 animateur ou référent “docu” dans chaque cercle
    • coordination des efforts de production des documents, pour une diffusion publique efficace (visibilité, facilité d'accès…)
      • Documentation de suivi :
        • choix effectués et de leurs justifications
        • erreurs et des réponses apportées
    • entretenir les doc une fois le projet fini (en tant que r&d) et récupérer les infos des améliorations par la communauté
    • traduction de la documentation existante (langue, unités de mesures, normes juridique)
    • sourcing des éléments (en fonction de la situation géographique…?)

Veille et soutien à la communauté Open Source :

  • support à des projets open-source indépendants pour une diffusion plus large des solutions

Organisation

Le cercle travaille à la réalisation de ses objectifs de manière collaborative.

Le cercle Open doc a des liens forts de collaboration avec :

  • le cercle RD : mise en forme par le cercle doc des données du cercle RD
  • le Cercle Com (communication) : pour multimédia et crowdfunding

Un animateur est identifié par consensus pour :

  • Coordonner les activités de documentation open source correspondant aux missions, selon le planning et les priorités définies par le cercle
  • Référent privilégié en lien avec les autres cercles de l'association

Outils

Nous avons besoin d'outils pour la documentation : pour la développer, pour la diffuser… Il nous faut définir les supports de documentation (wiki ou autre plateformes en ligne, rapport en ligne ou imprimé, vidéo…) et le format des fichiers, en fonction des documents (plans, manuel - tutoriel, ). La liste suivante rassemble les outils déjà utilisés ou potentiellement utiles pour s'organiser, produire et diffuser la documentation. Certains outils sont transversaux et servent de manière générale à tout le travail de l'association…

Outils actuellement utilisés

Notre vitrine :

Les outils utilisés principalement pour organiser le travail collaboratif :

  • Trello pour l'organisation interne au quotidien
  • Forum Pour des discussions plus poussées sur l'organisation, la R&D collaborative, des questions ouvertes, etc

Les outils utilisés pour construire et partager notre travail sont à ce jour :

  • Wiki OSE France Pour tout types d'informations utiles dans le cadre des objectifs de l'association, notamment la documentation R&D (depuis le cahier des charges, la définition des besoins, jusqu'à la fabrication et l'utilisation, avec liste des pièces etc). Comme tous les Wiki, il utilise une syntaxe à laquelle il faut se familiariser. La barre d'outils facilite grandement la tâche et l'investissement peut être valorisé dans tous les sites Wiki !
  • Github Plateforme pour partager en ligne les fichiers techniques en leur état de développement actuel et travailler en collaboration: CAO, programmes, etc. Cet outil est recommandé par la Open Source Hardware Association (bonnes pratiques, en anglais) parmi d'autres “online source-code repository”: GitHub, Gitorious, ou Google Code. Limite : il nécessite une prise en main et n'est pas adapté à la visualisation 3D.

Un outil interne de sauvegarde :

  • Cloud utilisé comme sauvegarde de GitHub. Pas de collaboration possible.

Autres outils intéressants à étudier !

A regarder de près, un outil d'organisation complet :

openPLM est une solution PLM open source orientée produit.
Une solution orientée produit et PLM ( Product Lifecycle Management) unifie toutes les activités de la société dans un ECM [Enterprise Content Management] qui structure des données autour du produit. OpenPLM dispose d'une interface full-web et conviviale.
OpenPLM est écrit dans le langage python utilisant le framework Django et utilise des logiciels Open Source comme Apache ou PostgreSQL.
C'est un logiciel libre, surtout développé par LinObject, et peut être utilisé, modifié et distribué conformément à la Licence GNU ( GPLv3)
Pour info, LinObject.com redirige vers le bureau d'enregistrement de noms de domaine www.gandi.net. ⇒ LinObject n'existe plus ? ⇒ le développement d'OpenPLM est arrêté ?

Pour s'organiser, il y a aussi : Loomio, qui permet de prendre des décisions ensemble simplement : La Fondation P2P (Peer to Peer) l'utilise (depuis peu…)

En alternative ou complément de Github, d'autres plateformes de partage de connaissances libres sont à considérer :

On pourra également contribuer à des projets globaux de plus grande ampleur, par exemple en y relayant notre travail (en fonction de nos forces) :

  • Wikiversité, l'université libre (projet frère de wikipedia). Il y a par exemple la section Projets collaboratifs où nous pourrions intégrer OSE, ou encore le domaine de l'énergétique qui est absent…
  • Appropedia encyclopédie libre de technologies appropriées, utiles en particulier aux populations les plus en difficulté.

Logiciels et Formats de la documentation

On pourra diffuser les documents sous divers formats, en particulier les suivants :

  • fichiers de CAO (Conception assistée par ordinateur)
  • images de fichiers CAO
  • fichiers textes de description des composants, systèmes, listes… en format éditable
  • fichiers de description en format pdf
  • vidéos : grande valeur pédagogique, mais pas forcément le support le plus adaptés car figé, lourd en mémoire, difficile à développer de manière collaborative et évolutive.

Les logiciels permettant d'éditer ou lire les fichiers produits seront autant que possible libres, pour permettre à tous de les utiliser.

  • Tell by mail
  • Export to OpenOffice
  • Export to PDF
  • Add page to book
  • Tools:
QR Code
QR Code documentation_open_source (generated for current page)