30/05/2012

Atelier "Documentation & minimalisme" : comment ça marche ?


  
Minimalisme dites-vous... et vous pensez immédiatement art minimaliste, atelier dépouillé, cadre dénudé, quelques bois flottés aux formes improbables, quelques clous et marteaux épars..

Principes de base 
En documentation technique, le minimalisme se base sur quatre solides piliers, les quatre principes de base :

1. Apprendre en faisant
2. Ancrer l'outil dans l'environnement (S'atteler aux vraies tâches)
3. Apprendre de ses erreurs (Troubleshooting)
4. Trouver rapidement l'information (Findability)

L'atelier s'organise autour de ces 4 principes, tels qu'ils sont appliqués en documentation technique.

Chaque étape est complétée

  • par des exemples (oui, "de la vraie vie"...)
  • par l'analyse des documentations de chaque participant 
(oui, comme les Compagnons du Devoir, chacun apporte un exemple de son travail que l'on étudie par petits groupes).
Vous retournez au bureau avec votre documentation retravaillée et minimalisée !



Pratique de montage ... et travaux pratiques
Pour poursuivre sur cette méthode d'application pratique, on poursuit par le montage -toujours en petits groupes- de la dépanneuse à treuil.

    

  •  Quelle équipe sera la plus rapide ?
  • Combien d'explications et d'instructions sont nécessaires pour effectuer le montage complet ?
  • Quel document procédural mènera rapidement à l'accomplissement de la tâche ?

   ....  Vous l'avez dit : c'est tout un art ;-))





.

2 commentaires:

  1. Reconnaissons que les ateliers et formations à la documentation dite minimaliste aident à acquérir l’ouverture d'esprit nécessaire à l'exercice de la rédaction technique, et garder l'espoir qu'un utilisateur donné ouvrira sa doc de bon cœur.

    Il ne faut toutefois pas oublier qu'il existe encore de très bons rédacteurs techniques qui n'ont pas la prétention de se ranger dans l’élite des universitaires de la Documentation.

    Mais , puisque la Documentation "d'avenir" se doit d'être "minimaliste", quel indice ou repère signifiant cette garantie sera porté à la connaissance de l'utilisateur?

    RépondreSupprimer
  2. Voir DITA (Darwin Information Type Architecture), développement "agile", Responsive Design et progressive disclosure, documentation sur support mobile, etc.

    RépondreSupprimer