Intro Page - University of Ottawa

Version 2 du document sur les pratiques exemplaires
pour le projet ODESI
Repose sur la version 2.x de l'IDD
Table des matières
1. Introduction p. 2
1.1 Introduction p. 2 1.2 Document principal p. 2
1.2a Mise en place des sections 1 à 5 p. 2
1.2b Mise en place de chaque section p. 3
1.2c Mise en place de chaque balise p. 3 1.3 Conseils additionnels pour les balises p. 4
1.3a Convention de formatage p. 4
1.3b Abréviations et acronymes p. 4
1.3c Note au sujet des balises « Notes and Comments »
(Notes et commentaires) p. 5
1.3d Obtenir de l'information pour les balises p.
5 1.4 Note sur les manuels de codes conformes à l'IDD p. 5
1.5 Questions ou commentaires p. 5 1.6 Remerciements p. 6 1.7 Financement du projet p. 6 2. Section 1 : Document Description (Description du document)
p. 6 3. Section 2 : Study Description (Description de l'enquête)
p. 22 4. Section 3 : Data Files Description (Description des fichiers de
données) p. 64 5. Section 4 : Variable Description (Description des variables)
p. 72 6. Section 5 : Other Documentation (Autre documentation)
p. 89 7. Annexes
7.1 Annexe A : Glossaire p. 92
7.2 Annexe B : Renseignements concernant Nesstar p. 94
7.3 Annexe C : Renseignements concernant Statistique Canada p. 96
7.4 Annexe D : Initiative de documentation des données
p. 98
7.5 Annexe E : Renseignements concernant le projet p. 99
7.6 Annexe F : Plus de renseignements concernant la balise p. 99
« Notes and Comments » (Notes et commentaires)
7.7 Annexe G : Exemple en format XML p. 100 1.1 Introduction Le Projet d'infrastructure pour l'extraction et la documentation des
données de l'Ontario (ODESI) est financé conjointement par le programme
OntarioBuys et par The Ontario Council of University Libraries. Il permet
aux étudiants et aux chercheurs universitaires d'accéder aux ensembles de
données dans Nesstar, un système d'extraction de données sur le Web qui est
offert grâce au Scholars Portal. L'objectif de ce document est de partager notre connaissance sur l'IDD avec
d'autres institutions d'enseignement. Il permet également de présenter les
pratiques exemplaires relatives à l'IDD afin d'être uniforme au moment du
balisage des enquêtes. Nous aimerions souligner qu'il s'agit d'un document sur l'IDD; pour cette
raison, toute note propre à Nesstar est incluse dans l'annexe B. Si vous
utilisez Nesstar, nous vous encourageons à lire cette annexe avant de
commencer le balisage de votre enquête. Il est également important de
mentionner que l'IDD et Nesstar sont deux entités complètement différentes;
Nesstar dépend de l'IDD, mais l'IDD ne dépend pas de Nesstar. Nesstar est
simplement un outil permettant d'interpréter l'IDD. D'autres programmes
sont aussi disponibles pour créer des manuels de codes partiels ou complets
conformes à l'IDD, par exemple SDA. Veuillez noter qu'en fonction de la version de l'IDD que vous utilisez
(version 1.x versus version 2.x), certaines balises peuvent avoir des
numéros différents, mais le contenu demeure le même. 1.2 Document principal 1.2a Mise en place des sections 1 à 5 La partie principale de ce document, qui suit l'introduction, est composée
de cinq sections.
. Section 1 : Document Description (Description du document)
- Décrit le document électronique que la personne crée en utilisant
l'IDD, soit le fichier en format XML. La description traitera du
fichier de l'IDD créé et non pas du contenu de la donnée ou de la
description de l'enquête.
. Section 2 : Study Description (Description de l'enquête)
- Décrit l'étude ou l'enquête qui a été menée. Contient des
renseignements sur l'objectif, explique la façon dont l'enquête a été
mené, pourquoi, à quel endroit, pendant combien de temps et son
financement. Cette section NE TRAITE PAS du fichier de données, elle
ne fait que décrire l'enquête.
. Section 3 : Data Files Description (Description des fichiers de
données)
- Décrit les fichiers de données qui ont été créés par l'enquête. La
description comprend des éléments comme le nombre de variables, le
nombre de cas et la structure du fichier de données.
. Section 4 : Variable Description (Description des variables)
- Décrit les variables comprises dans le fichier de données. Cette
section comprend habituellement des renseignements comme l'étiquette
de la variable, les valeurs et les étiquettes de valeur de la
variable, le texte de la question, qui a posé la question et toutes
les instructions pour l'enquêteur.
. Section 5 : Other Documentation (Autre documentation)
- Permet à l'utilisateur d'inclure toute documentation connexe. Cette
section comprend souvent le questionnaire utilisé pour recueillir les
données, un guide d'utilisation ou un manuel de codes. 1.2b Mise en place de chaque section Chaque section commence par une courte définition et une liste des nombres
et des balises correspondantes de la définition de type de document (DTD),
suivi par une description en profondeur de chaque balise et d'exemples
concrets, au besoin. À la fin de chaque section, on trouve un exemple tiré
d'un manuel de codes conforme à l'IDD en format XML. 1.2c Mise en place de chaque balise La première ligne de chaque balise contient :
. le numéro de la section;
. ce à quoi ressemble la balise dans l'IDD;
. le titre de la balise. Exemple :
1.1 Bibliographic Citation On trouve par la suite trois puces :
. Obligatoire ou facultative :
- si la balise est obligatoire, utilisez-la si vous possédez de
l'information;
- si la balise est facultative, utilisez-la au besoin;
. Répétable ou non répétable :
- si la balise est répétable, elle peut être utilisée autant de fois
que nécessaire;
- si elle n'est pas répétable, elle ne peut être utilisée qu'une seule
fois;
. Attributs (ID, xml:lang, source, ...) :
- fournit des renseignements additionnels à propos de la balise;
- fournit souvent de l'information qui ne fait pas partie de
la donnée. La description de la balise suit. La longueur de cette description dépend
de la balise elle-même. Toute note générale ou note de formatage suit la
description. La dernière partie de la balise contient un ou des exemples,
au besoin. Il est important de noter que les balises sont remplies selon les
renseignements disponibles, ce qui signifie que toutes les balises
énumérées ne sont pas nécessairement utilisées. De plus, il se peut que
vous jugiez que certaines balises qui ne sont pas énumérées ici doivent
être incluses dans votre document. Certains exemples contiennent également une balise pour le titre de
l'enquête afin de rendre l'exemple plus clair.
1.3 Conseils additionnels pour les balises 1.3a Conventions de formatage Partout où l'on trouve des notes de formatage, l'icône ci-dessous
apparaîtra afin que vous puissiez voir les notes plus facilement. Il est
important de respecter ces conventions de formatage étant donné que les
enquêtes seront transmises à d'autres personnes et que l'uniformité est de
la plus grande importance. . Date :
aaaa
Exemple : 2007 aaaa-mm-jj
Exemple : 2005-01-25 . Noms personnels :
Nom de famille, Prénom
Exemple : Edwards, Michelle . Agence ou institution et lieu de travail ou ministère :
Institution. Lieu de travail (oui, il s'agit bien d'un point
entre les deux)
Exemple : Université de Guelph. Centre de ressources de données
Exemple : Statistique Canada. Initiative de démocratisation des
données . Noms personnels avec les institutions ou les agences:
Nom de famille, Prénom; Institution. Lieu de travail
Exemple : Edwards, Michelle; Université de Guelph. Centre de
ressources de données
1.3b Abréviations et acronymes Les abréviations et les acronymes ne devraient pas être utilisés pour tout,
y compris pour la province, le pays, le nom de l'université, le lieu de
travail, le nom de la personne, etc. Une seule exception s'applique si la balise concerne précisément une
abréviation ou un acronyme. Il est important de se rappeler que les balises sont indépendantes les unes
des autres; même si une certaine institution a été indiquée par son nom
entier dans une autre section du document, l'utilisateur peut seulement
être intéressé par la balise à la fin du document et il pourrait ne pas
connaître l'abréviation ou l'acronyme. De plus, l'utilisateur peut ne pas
être familier avec les abréviations ou les acronymes que nous utilisons. Il
faut donc se rappeler qui est l'utilisateur final du document. 1.3c Note au sujet des balises « Notes and Comments » (Notes et
commentaires) L'utilisateur pourra constater que certaines sections comprennent une
balise « Notes » à la fin. Cette balise peut cependant être incluse à la
fin de presque toutes les sections,