Procedure de publication
De Freenet Doc.
Sommaire |
Schéma du processus de publication
Légende :
- Entouré : Status de l'article.
- Flèche : Ce qu'il faut pour changer de status.
- En orange : Etat final recherché.
Objectifs de la procédure de publication et exemples
Fixer des étapes claires par lesquelles doit passer tout article afin de répondre aux critères de qualité de la documentation. Les étapes sont décrites plus bas. Les exemples suivant permettent de comprendre le fonctionnement de la procédure de publication :
Exemple 1:
Article de la documentation qui suit le processus de validation en étant validé du premier coup à chaque fois
Processus de publication :
Etat 1 : L'article n'existe pas.
Tache 1 : Définir les objectifs et mettre le template {{A définir}}
Aperçu de la page :
Cet article n'existe pas encore, les objectifs à atteindre sont en train d'être définis sur la page Discussion.
- ||
- \/
- ||
Validation des objectifs par les membres
- ||
- \/
- ||
Etat 2 : Les objectifs sont clairement définis.
Tache 2 : Rédiger l'article et mettre à jour le template, avec {{A rédiger}}
Aperçu de la page :
Attention cet article est en cours de rédaction, par conséquent les informations que vous pouvez y trouver peuvent être erronées et/ou incomplètes.
+ Texte
- ||
- \/
- ||
Etat 3 : La rédaction est finie.
Tache 3 : Changer le template avec {{A valider (membres)}}
Aperçu de la page :
Attention cet article est en cours de validation par l'équipe de documentation, par conséquent les informations que vous pouvez y trouver peuvent être erronées et/ou incomplètes (en savoir plus sur la validation des articles)
+ Article
- ||
- \/
- ||
Validation par les membres
- ||
- \/
- ||
Etat 4 : Article validé par les membres
Tache 4 : Changement du template avec {{A valider (utilisateurs)}}
Aperçu de la page :
Cet article a été validé par l'équipe de documentation, néanmoins, dans un soucis de qualité, vous pouvez donner votre avis en cliquant sur un des boutons ci-dessous (en savoir plus sur la validation des articles).
Qu'avez-vous pensé de cet article ?
| {{#feedback:Parfait}} | Nickel, j'ai trouvé ce que je cherchais. |
| {{#feedback:Trop complexe}} | Je n'ai rien compris, vous savez que vous parlez à des humains ? |
| {{#feedback:Trop lourd visuellement}} | C'est bien gentil les images mais ça vous dirait pas de mettre quelques explications en plus ? |
| {{#feedback:Pas assez illustré}} | Cet article est trop dense, ajoutez des images ! |
| {{#feedback:Pas à jour}} | Les choses ont changé, mettez-vous à jour ! |
Si vous voulez donnez plus d'explications sur la manière d'améliorer cet article,utilisez la page "Discussion" associée à l'article.
Nous vous encourageaons à le faire, un simple "Trop complexe" par exemple ne nous dit pas quelle partie est trop complexe, ou si c'est l'article entier qu'il faut revoir. Nous l'indiquer ne vous prendra que deux minutes de votre temps, mais cela nous sera bien utile, et nous serons en mesure de répondre à votre suggestion plus rapidement.
Il en va bien-sûr de même avec les autres notations ;)
+ Article
- ||
- \/
- ||
Validation par les utilisateurs
- ||
- \/
- ||
Etat 5 : Article validé
Tache 5 : Effacement du template
Aperçu de la page :
Article
Etapes de publication
Nous utilisons des templates décrivant le statut des articles et à quel stade ils en sont dans la procédure de validation :
- Définition des objectifs
Cet article n'existe pas encore, les objectifs à atteindre sont en train d'être définis sur la page Discussion.
- Etat requis : Article inexistant (ou en refonte)
- Etape suivante : Rédaction de l'article
- Passage à l'étape suivante : Objectifs fixés (soit dans la page discussion, soit dans un autre endroit accessible tout le temps, notamment pour s'en rappeler lors des refontes, à définir)
- Modèle : {{A définir}}, Contenu, Pages dans cet état
Question : faut-il valider aussi les objectifs ??? ==> page de discussion
- Rédaction en cours
Attention cet article est en cours de rédaction, par conséquent les informations que vous pouvez y trouver peuvent être erronées et/ou incomplètes.
- Etat requis : avoir fixé des objectifs clairs à l'article, ou article n'ayant pas passé l'étape de validation
- Etape suivante : Validation en cours
- Passage à l'étape suivante : fin de la rédaction, cad atteinte des objectifs fixés avant la rédaction. Un lien de l'article est mis dans la check list (à créer).
- Modèle : {{A rédiger}}, Contenu, Pages dans cet état
- Validation en cours (par les membres)
Attention cet article est en cours de validation par l'équipe de documentation, par conséquent les informations que vous pouvez y trouver peuvent être erronées et/ou incomplètes (en savoir plus sur la validation des articles)
- Etat requis : article interne, ou article de la documentation dont la rédaction vient d'être achevée
- Etape suivante :
- Article interne : Article validé, Refonte en cours (forme)
- Article de la documentation : Validation en cours (par les utilisateurs), Refonte en cours (forme)
- Passage à l'étape suivante : validation par les membres du projet (à définir), totale (forme + fond) ou partielle (seulement le fond)
- Modèle : {{A valider (membres)}}, Contenu, Pages dans cet état
- Validation en cours (par les utilisateurs)
Cet article a été validé par l'équipe de documentation, néanmoins, dans un soucis de qualité, vous pouvez donner votre avis en cliquant sur un des boutons ci-dessous (en savoir plus sur la validation des articles).
Qu'avez-vous pensé de cet article ?
| {{#feedback:Parfait}} | Nickel, j'ai trouvé ce que je cherchais. |
| {{#feedback:Trop complexe}} | Je n'ai rien compris, vous savez que vous parlez à des humains ? |
| {{#feedback:Trop lourd visuellement}} | C'est bien gentil les images mais ça vous dirait pas de mettre quelques explications en plus ? |
| {{#feedback:Pas assez illustré}} | Cet article est trop dense, ajoutez des images ! |
| {{#feedback:Pas à jour}} | Les choses ont changé, mettez-vous à jour ! |
Si vous voulez donnez plus d'explications sur la manière d'améliorer cet article,utilisez la page "Discussion" associée à l'article.
Nous vous encourageaons à le faire, un simple "Trop complexe" par exemple ne nous dit pas quelle partie est trop complexe, ou si c'est l'article entier qu'il faut revoir. Nous l'indiquer ne vous prendra que deux minutes de votre temps, mais cela nous sera bien utile, et nous serons en mesure de répondre à votre suggestion plus rapidement.
Il en va bien-sûr de même avec les autres notations ;)
- Etat requis : article de la documentation validé par les membres
- Etape suivante : Article validé
- Passage à l'étape suivante : Validation par les utilisateurs (à définir)
- Modèle : {{A valider (utilisateurs)}}, Contenu, Pages dans cet état
- Article validé
Les choses ont changé depuis que cet article a été publié ? {{#feedback:Signaler une mise à jour !}} |
- Etat requis : l'article a été validé par les membres et les utilisateurs (sauf pour les articles internes)
- Etape suivante : pas d'étape suivante, sauf dans le cas d'une refonte de l'article.
- Modèle : {{Signaler_maj}} si nécessaire (i.e. un article sur quelque chose qui peut être modifiée)., Contenu, Pages dans cet état
- Refonte en cours (forme)
Cet article est actuellement en réaménagement. Les informations sont valides, mais la forme de l'article ne correspond pas aux critères de la documentation (en savoir plus sur la validation des articles)
- Etat requis : validé partiellement, les informations sont correctes, mais la forme laisse à désirer
- Etape suivante : Validation en cours (par les membres)
- Passage à l'étape suivante : l'article est mieux présenté
- Modèle : {{En refonte (forme)}}, Contenu, Pages dans cet état
- Refonte en cours (autre)
Attention, cet article est en refonte totale ou partielle, ce qui signifie que l'article entier ou certaines sections peuvent comporter des informations erronées, incomplètes et/ou trop anciennes.
- Etat requis : validé mais l'objet de l'article a été mis à jour, ou une nouvelle fonctionnalité est apparue, de nouveaux objectifs sont définis (basiquement, prendre en compte cette mise à jour/fonctionnalité)
- Etape suivante : Validation en cours (par les membres)
- Passage à l'étape suivante : atteinte des nouveaux objectifs
- Nom du modèle : {{En refonte}}, Contenu, Pages dans cet état
Propre à la traduction
- Traduction à revoir
Attention, suite à une refonte de l'article original, cette traduction n'est plus à jour. Si vous êtes intéressez par la traduction, vous trouverez plus d'informations (lien vers le howto | ici)
- Etat requis : quand un article a été refondu (suite a des mises à jour ou ajout de fonctions), on pose ce statut sur les pages traduites
- Etape suivante : Validation de la traduction en cours
- Passage à l'étape suivante : Traduction finie
- Nom du modèle : {{Traduction à revoir}}, Contenu, Pages dans cet état
- Traduction en cours :
Attention, cet article est en cours de traduction, et par conséquent incomplet et/ou erroné
- Etat requis : article français validé
- Etape suivante : Validation de la traduction en cours
- Passage à l'étape suivante : Traduction finie
- Nom du modèle : {{A traduire}}, Contenu, Pages dans cet état
- Validation de la traduction en cours
Attention, cette traduction est en cours de validation, par conséquent, il se peut qu'elle contienne des erreurs et/ou des approximations
- Etat requis : traduction finie
- Etape suivante : Article validé
- Passage à l'étape suivante : à définir
- Nom du modèle : {{A valider (traduction)}}, Contenu, Pages dans cet état
Optionnel : Pour les articles validés, mais dont il manque une ou plusieurs traduction : Afficher le message : "Cet article n'est pas traduit dans toutes les langues. Si vous souhaitez le traduire, il suffit de regarder dans le menu quelle(s) langue(s) manque(nt). Pour plus d'informations sur la traduction : (lien vers le howto traduction)"
Validation des articles
Par les membres
Méthode : un membre se propose de valider l'article.
Conditions requises : pour qu'un article soit validé par les membres, il faut que ceux-ci soient d'accord sur le fait que les objectifs suivants sont remplis :
- L'objectif initialement défini est atteint
- L'article est correctement rédigé
- L'article correspond au niveau de difficulté affiché
- La structure de l'article correspond à celle attendue
Si le membre trouve des erreurs qu'il peut corriger il le fait, sinon il indique dans la discussion associée à l'article pourquoi il ne l'a pas validé.
Par les utilisateurs
Méthode : Voir Système de feedback
Les utilisateurs ne valident pas vraiment l'article, le système de feedback sert à ce qu'il y ait constamment un retour sur l'article afin que les membres puissent le modifier en conséquence. Peut-être est-il judicieux d'ajouter à une liste de changements les modifications apporté par le membre.
Un exemple :
Un utilisateur trouve qu'une notion n'a pas été bien expliquée.
Un membre modifie l'article en conséquence, et ajoute à la liste des modifications : "Explication plus poussée de telle notion", et enlève du feedback tout ce qui avait trait à cette exigence, pour que dans le cas où celle-ci n'est pas remplie et qu'elle réapparait dans le feedback, on demande plus de précision dans ce que les utilisateurs désirent.
