Marque-page Organiser un espace de documentation technique

Il est souvent difficile de s’y retrouver dans un espace documentaire. Sur quelle page (ou document) se trouve l’information dont j’ai besoin ? Comment y accéder ?
En général, on peut contourner le problème avec une recherche performante et une bonne indexation.

Mais cela n’aide pas vraiment pour la contribution et la mise à jour de la documentation. Comment savoir si ce qu’on veut ajouter est déjà présent ?
De plus, selon ce dont qu’on recherche, on n’a pas forcément envie d’avoir la même granularité dans les résultats.
Par exemple, si on recherche comment se connecter au VPN d’un client, on n’a pas sans doute pas besoin d’un paragraphe qui nous explique ce qu’est un VPN et à quoi il sert. Mais peut-être que ce paragraphe est quand même utile pour un autre utilisateur novice ?

Comme l’organisation de la documentation est un problème récurrent, des gens se sont penchés sur la question. Certains ont proposé l’approche Diataxis (https://diataxis.fr).

Elle préconise de structurer sa documentation en 4 parties :

  • Tutoriels
  • Recettes (How-to guides)
  • Référence
  • Explication

Le lecteur se dirigera vers l’une ou l’autre des sections, selon s’il souhaite :

  • Apprendre/débuter
  • Effectuer une tâche précise
  • Avoir des informations
  • Comprendre des sujets de fond