Comment valider mes ajouts ?

Rédaction en cours

Nous allons essayer de répondre à ces questions :

  • quel est le statut des informations publiées dans ce guide ?

  • est-ce qu'il existe déjà à ce jour un énoncé partagé et satisfaisant du protocole d'édition des guides de la communauté ?

  • y'a-t-il des informations qui me permettraient de faire la différence entre un brouillon de documentation, et une documentation stabilisée ?

  • qui valide la documentation avant publication ?

Quel est le statut des informations publiées dans ce guide ?

Il s'agit d'un recueil de consensus, en perpétuelle évolution au gré des apprentissages et des mouvements de personnes au sein de la communauté.

Ces informations peuvent dont évoluer. Elles peuvent également être mentionnées comme "en cours de documentation" ou tout autre mention explicite sur le statut du contenu.

Est-ce qu'il existe déjà à ce jour un énoncé partagé et satisfaisant du protocole d'édition des guides de la communauté ?

Vous avez deux manières de démarrer une documentation non définitive destinée à ce guide :

  1. Ouvrir un pad ou un doc partagé (exemple : frama ou google doc) sur lequel vous pourrez réaliser toutes les modification que vous souhaitez. Vous pourrez inviter des personnes à y contribuer. Ce document "brouillon" ne sera pas accessible à toute la communauté. Une fois "stabilisée", vous pourrez la transférer dans ce guide.

  2. Commencer votre document dans ce guide en indiquant au sommet de la page "rédaction en cours". Chacun pourra y contribuer. Ce document "brouillon" sera accessible à toute la communauté.

Nous vous recommandons :

  • Pour une documentation dense et longue (plusieurs pages d'un doc) et nécessitant des contributions de plusieurs personnes, vous pouvez débuter par un pad ou un doc partagé. Une fois la documentation terminée, vous pourrez la transférer dans ce guide.

  • Pour une courte documentation descriptive et ne nécessitant pas l'avis d'un grand nombre de personne, vous pouvez directement démarrer dans ce guide.

Y-a-t-il des informations qui me permettraient de faire la différence entre un brouillon de documentation, et une documentation stabilisée ?

Si en haut de la page, il n'est pas indiqué "en cours de rédaction" ou "brouillon", vous pouvez considérer que cette documentation est stabilisée.

Néanmoins, la documentation dite stabilisée est amenée à évoluer et à s'améliorer. Vous êtes légitimes pour la modifier, proposer vos modifications à au moins trois membres de la communauté concernées par le sujet (experts, destinataires, curieux...).

Qui valide la documentation avant publication ?

Nous faisons confiance aux membres de la communauté. Il n'y a pas de comité de relecture.

Si vous suivez ces quelques principes, tout devrait bien se passer :

  • demander un feedback à au moins 3 personnes de la communauté ;

  • demander à une autre personne de "merger" votre proposition si vous n'êtes pas sur de vous (#incubateur-documentation)

  • considérer que rien n'est définitif dans ces guides. Ils peuvent s'améliorer au fil de l'eau.