Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 3.06 KB

010-documentation-de-reference-interne.md

File metadata and controls

47 lines (33 loc) · 3.06 KB
Raw

Documentation de référence interne

Qu'est-ce qu'une documentation de référence interne ?

  • une documentation à usage interne d'une entreprise
  • une source de vérité unique (un peu comme un code de loi pour un pays)
  • peut contenir :
    • les règles de fonctionnement, de communications…
    • les valeurs de la société
    • des procédures (onboarding...)
    • les fiches de postes des personnes (example)
      • responsabilités
      • compétences nécessaires
      • processus de recrutement
    • ...

Pour avoir example, vous pouvez consulter la page « Que contient le handbook de GitLab ? ».

Qui a besoin d'une documentation de référence interne ?

Ce type de documentation est très utile, même indispensable lorsqu'une structure humaine dépasse une certaine taille (> 5 personnes ?).

Je pense que ce genre de document est aussi utile aux associations.

Pourquoi une documentation de référence interne est nécessaire ?

Il existe une grande probabilité de chance qu'une société dépourvu de documentation de référence interne soit confrontée aux difficultés suivantes :

  • perte de repères des Individual Contributor (mais aussi des managers)
  • le fonctionnement, les règles à suivre au sein de la société varient en fonction du moment et de la personne à qui l'information est demandé
  • la conséquence de ce manque d'information fiable : une faible autonomie et une faible prise d'initiative des personnes

Avantages

  • Lire est bien plus rapide que écouter
  • La lecture est asynchrone, il n'est pas nécessaire d'interrompre une personne ou d'attendre qu'elle soit disponible
  • Le processus d'onboarding est simplifié
  • Il est plus simple de travailler en équipe quand on sait comment les autres membres de la société travaillent
  • Il est plus simple de proposer et de discuter d'un changement quand on connaît avec précision le processus actuel
  • Communiquer les changement est plus simple si vous pouvez simplement indiquer ce qui a changé en visualisant un "diff" (exemple)
  • Tout le monde peut contribuer en proposant un changement via un "merge request" (exemple) (favorise l'empowerment)

Exemple

En 2019, nous avons la chance d'avoir un exemple majeur de documentation interne de référence est librement accessible : GitLab Handbook (dépôt git du projet)

Ce type d'outil peut sembler anodin ou secondaire, mais après presque 20 ans d'expérience, dans 7 entreprises différentes, je suis persuadé que est un élément clé au bon fonctionnement d'un collectif.