Préciser la genèse des documents diffusés
Pierre de Lamberterie et Jean-Luc Archimbaud, chargés de mission qualité au LPSC http://lpsc.in2p3.fr/index.php/qualite/
V0.1 6 avril 2012
Une version de cet article a été publiée au LPSC [1] en mars 2012 dans le cadre de l'information qualité mensuelle [2]. Ceci est une version épurée des spécificités du LPSC pour être diffusée plus largement. Elle est sous licence Creative Commons : BY-NC-ND [3].
Un grand merci à Jocelyne Riffault (LPSC) pour sa relecture et ses corrections.
Objet
Le but de cette note est d'indiquer les informations qu'il est nécessaire d'ajouter dans chaque document diffusé pour permettre de connaître l'objet, l'origine et l'évolution (c'est à dire la genèse) du document. Par document on entend : article, dossier, rapport, compte-rendu, cours, guide, présentation (slides), page Web (avec du contenu)...
Pourquoi ajouter ces informations dans vos documents diffusés ?
Lors de la lecture d'un document, pour vraiment le comprendre, en tirer les éléments essentiels, l'apprécier, le juger, le lecteur a besoin de connaître son origine (quel est l'auteur ? où travaille t-il ? quelle est sa fonction ?), le contexte dans lequel il a été rédigé et le public auquel il s'adresse (ce qui peut expliquer l'angle d'approche et les approximations), la date (s'il est vieux, il faut le savoir : il peut comporter des erreurs qui n'en étaient pas lors de sa rédaction, corrigées depuis). De plus, le lecteur peut vouloir vous contacter pour collaborer, vous demander des précisions, vous indiquer une erreur... Si le document est en cours de rédaction par plusieurs personnes, chaque contributeur a besoin d'en connaître la version pour ne pas travailler sur « la mauvaise ».
Il est donc important d'avoir ces informations au début de tous les documents que l'on diffuse, d'autant que tout se retrouve un jour ou l'autre sur le Web, n'importe où, donc sorti de son contexte, avec des lecteurs auxquels il n'était pas destiné, peut-être des années plus tard... Et dans ces situations très variées dans le temps et l'espace comment comprendre un document si on ne connait ni l'auteur, ni la date, ni le contexte...
Recommandation principale : sur la première page indiquer :
• Le titre : il faut qu'il résume le contenu en peu de mots, c'est souvent difficile. Quand il y a plusieurs versions du document, il faut veiller à ce qu’il reste identique. On peut aussi l'indiquer dans le pied de page du document, il sera ainsi imprimé sur chaque page
• Le nom de l'auteur (ou des auteurs) avec leur laboratoire/université/..., éventuellement leur fonction (si elle apporte une information pour mieux comprendre le contenu)
• Un moyen pour contacter le/les auteurs : le mail par exemple
• La date (qui peut aussi permettre d'identifier la version)
• Le contexte : nom de la conférence/... (avec un lien sur le site de la conférence/...
éventuellement)
Pour exemple, regardez le début de ce document.
Préciser la genèse des documents diffusés 1
On vous recommande d'ajouter ces informations à tous vos documents, même dans les documents qui ne sont pas initialement destinés à être diffusés. Un collègue peut parfois vous demandez de lui passer les informations que vous avez notées, il va peut être ajouter ou corriger des éléments (donc créer une nouvelle version), vous la renvoyer en mettant d'autres personnes en copie. Et la diffusion commence.
Vous pouvez aussi ajouter des informations (ceci est optionnel)
• Un numéro de version, ce qui est plus précis qu'une date (et qui permet d'avoir plusieurs versions par jour)
• La licence de diffusion [3]
• Les noms de tous les contributeurs et relecteurs s'il y en a
• L'historique des mises à jour (quoi, par qui, quand). Le 'quoi' mentionne en quelques lignes la nature de la modification, ce qui permet à certains lecteurs d’éviter une relecture complète, et de s’intéresser directement au paragraphe modifié
• Si c'est une nouvelle version, fait elle suite à une mise à jour principale (avec relecture de l'ensemble du document) ou mineure (pour corriger une coquille...) ?
• L'endroit où se trouve le document en ligne : ce qui peut permettre au lecteur de retrouver une version plus récente
• L'objet : dans ce court paragraphe, on précise le contexte du document qui va suivre.
Ce n’est pas seulement un résumé, mais un positionnement par rapport à un sujet ou une organisation donnée
• Le public (lectorat) visé
Vous pouvez bien évidemment rajouter d'autres informations si vous pensez qu'elles peuvent mieux éclairer le lecteur. Cela dépend du contenu du document.
Le présent texte n'aborde que les informations sur la genèse. D'autres informations peuvent être présentes si nécessaire : références bibliographiques, liste des abbréviations... Ce n'est pas l'objet de ce billet qualité.
Formalisme – modèle de document
Certains organismes ou laboratoires ou projets imposent des modèles de documents, parfois avec plusieurs pages d'entête pour contenir toutes les informations citées ci-dessus. Si le principe est bon, le risque, dans la vraie vie, est que devant le nombre d'informations à mettre à jour pour chaque version, les auteurs oublient de le faire, surtout si les versions se succèdent rapidement.
Donc si vous imposez ce genre de modèle, veillez à ne pas « trop en mettre », car il se peut que l'information la plus importante (le numéro de version par exemple lors de la rédaction d'un document collaboratif) soit fausse en raison de l'excès de formalisme.
Références
[1] http://lpsc.in2p3.fr/
[2] http://lpsc.in2p3.fr/index.php/qualite/info-qualite [3] http://creativecommons.org/licenses/by-nc-nd/2.0/fr/
Préciser la genèse des documents diffusés 2
