Outils pour la pratique collaborative

Introduction

Pratiques collaboratives

  • S'organiser collectivement
  • Produire du contenu collectivement
  • Structurer les canaux de communication
  • Assurer la mémoire collective

De l'importance d'internet

  • Décentralisation
  • Travail à distance
  • Coopération non simultanée

Des rôles distincts

Peut importe ce qui est produit, et le public visé, on a...

  • Des concepteurs
  • Des développeurs
  • Des commerciaux
  • Des personnes en charge du déploiement
  • Des utilisateurs (technophiles ou non, avec plusieurs rôles)
  • Des animateurs de la commauté (community managers)

Édition collaborative

Éditer à plusieurs

  • Un document
  • Un ensemble de documents

Textes, images, données structurées, etc.

Avec contraintes

Plus ou moins supportées suivant les outils et besoins

  • Facilité d'utilisation
  • Garder un historique des modifications
  • Notion d'auteur
  • Ajout d'illustrations, de documents multimedia
  • Gestion des conflits
  • Notifications des modifications
  • Granularité des suivis

Au début était le ftp

Logiciels dédiés (non web)

Aujourd'hui, Live share de VS Code

Partages de fichiers

Partage de courts textes

Hébergements sur le cloud

Éditeurs collaboratifs

Wiki : définition

Un wiki est une application web qui permet la création, la modification et l'illustration collaboratives de pages à l'intérieur d'un site web. Il utilise un langage de balisage et son contenu est modifiable au moyen d’un navigateur web (wikipedia).

Importance de l'hyperlien

Wiki : historique

  • ~1990 : origines de l'html (liens hypertextes)
  • 1995 : Wikiwikiweb premier wiki inventé par Ward Cunningham (XP)
  • 2001 : début de l'encyclopédie en ligne wikipedia
  • 2013 : wikipédia se dote d'un éditeur WYSIWYG

Wiki : usages

Qui peut lire, éditer ?

Au delà de texte...

Édition collaborative d'images vectorielles, de diagrammes uml, d'informations géographiques, base de données universelle...

Au delà de texte... l'exemple d'OpenStreetMap

mapcontrib, JOSM, umap, ...

Suivi des problèmes

Demande d'assistance, rapports de bugs, demandes de fonctionnalités, etc.

Outils concepteurs / utilisateurs

Parfois, la documentation ne suffit pas...

Demande d'assistance

Outil de suivi d'assistance (UCA, LIMOS)

  • Principe des tickets
  • Utilisations de tags, statuts, ...
  • Gestion de la prise en charge

Motivations ? traçabilité, suivi de chaque besoin, outils pour l'analyse globale, détecter les problèmes récurrents

Rapports de bugs (bugreports)

Un cas particulier de la demande d'assistance.

Rapports de bugs. Quelques éléments de bonne pratique.

  • Donner un titre synthétique et informatif, utiliser les tags et catégories à disposition
  • Décrire l'environnement (versions des logiciels, configuration des machines, etc.)
  • Décrire pas à pas comment reproduire le dysfonctionnement
  • Donner les informations illustrant le dysfonctionnement
  • Répondre précisément aux demandes de précision
  • Mettre à jour suivant l'évoluation de la situation

Exemple : suivis de bugs de kde

Demandes de fonctionnalité

  • Principe similaire aux rapports de bugs
  • Utilisation courante des bounties, de systèmes de vote
  • Utilité des outils comme le prototypage virtuel
  • Intégré dans une planification des futures fonctionnalités

Animer une communauté

Quelle communauté (rappel)

  • Des concepteurs
  • Des développeurs
  • Des commerciaux
  • Des personnes en charge du déploiement
  • Des utilisateurs (technophiles ou non, avec plusieurs rôles)

Communication

Solutions basées web

Différents degrés d'accès suivant le profil

  • Site internet (documentation développeur, documentation utilisateur, etc.)
  • Réseaux sociaux
  • Groupes de discussion
  • Forums
  • Bugreports

Problématique de la péremption des informations

Solutions basées courriel

Importance des archives en ligne

Autres supports

  • Solutions intégrées : Forges type dedmine, gitlab, github
  • IRC, chats, et leurs versions modernes : Slack, Discord, Teams, Mattermost
  • Rencontres d'utilisateurs

Application à la documentation

Qu'est-ce que documenter un projet ?

réfléchissons autour d'une carte mentale

La prochaine séance...

Expérimentations autour de la documentation, avec Adrian Couvent.