En tant que rédacteur technique, vous devrez généralement créer des index pour les livres imprimés et pour les aides en ligne que vous développez. Le type d'index dont nous parlons ici est l'index classique à la fin du livre qui montre les numéros de page où les sujets et sous-sujets se trouvent dans le livre. Un index en ligne est similaire, sauf que vous fournissez des liens hypertextes plutôt que des numéros de page.
Index dans un document imprimé
Index dans un système d'aide en ligne (panneau gauche)
Ébauche d'un index
Comme pour tout projet d'écriture, il y a une phase de brouillon pour l'indexation. Et bien sûr, vous devez penser à votre public—qui ils sont, comment ils utiliseront l'index, pourquoi ils l'utiliseront, et quels types de terminologie ils pourraient connaître. Après cela, voici ce qu'il faut faire ensuite :
- Convertir chaque titre en plusieurs entrées d'index. Les titres sont un bon point de départ : ils indiquent les sujets et les sous-sujets—précisément ce que fait un index. Cependant, ne vous contentez pas de copier les titres directement dans un index et de partir. Comme vous le verrez ci-dessous, vous devez établir des entrées croisées basées sur les titres de la manière la plus pratique possible.
- Listez chaque entrée en parallèle. Réorganisez chacune de vos entrées basées sur des titres de toutes les manières pratiques possibles. Par exemple, un titre tel que "Changer la résolution de l'écran" peut être indexé comme "résolution de l'écran, changement" ainsi que "changer la résolution de l'écran." Vous pourriez également inclure "résolution, changer l'écran." Ces entrées croisées tentent d'anticiper toutes les manières probables dont un lecteur pourrait rechercher ce sujet dans un index : "écran," "résolution," ou "changer."
Voici quelques exemples supplémentaires :
Titre Entrées de l'index Optimisation de l'affichage vidéo affichage vidéo, optimisation
optimisation de l'affichage vidéo
affichage, optimisation vidéoLecture de multimédia en streaming streaming multimédia, lecture
lecture de multimédia en streaming
multimédia, lecture en streamingNotions de base sur le réseau réseautage
réseauxIntroduction au multimédia en streaming streaming multimédia
multimédia, diffusion en continu
Remarque que vous ne pouvez pas toujours croiser les entrées d'index sur chaque mot. Par exemple, "introduire le multimédia en streaming" dans ce qui précède ne fonctionnerait tout simplement pas. Un lecteur chercherait-il jamais ce sujet en commençant par "introduire" ? - Créer des entrées de synonymes. Les lecteurs n'utilisent pas nécessairement la même terminologie que vous dans votre documentation. Ils peuvent appeler un lecteur de disquette un "lecteur de disquette". Ils peuvent se référer à un écran comme un "moniteur". En tant qu'indexeur, vous devez anticiper ces variations courantes de terminologie. Dans les entrées précédentes, il serait judicieux d'avoir un synonyme pour "affichage vidéo" tel que "moniteur". Mais au lieu de répéter les numéros de page, utilisez un Voir référence. De cette façon, vous indiquez aux lecteurs le terme préféré. (Bien sûr, s'il n'y a qu'un seul numéro de page, il suffit de le répéter avec l'entrée du synonyme.)
Voici quelques exemples supplémentaires :
Entrée de l'index Entrées de synonymes volume, ajustement loudness, réglage taux de transmission vitesse, transmission capture de vidéo copie de vidéo - Vérifiez le texte pour des entrées d'index supplémentaires. Il n'est généralement pas suffisant de s'indexer uniquement par les titres. Il faut plonger dans le texte à la recherche de concepts, de termes et de tâches qui ne sont pas représentés par les titres. Par exemple, sous le titre "Création d'un flux multimédia", vous pourriez voir des définitions de "capture" et "encodage". Ce sont des termes importants, mais ils n'apparaissent nulle part dans les titres — indexez-les aussi ! Dans ce cas, vous voudrez créer ces entrées d'index supplémentaires : "flux de capture" et "flux d'encodage".
- Index des matières frontales et arrière. N'oubliez pas de fouiller dans la préface, les avis de sécurité, les annexes et d'autres périphériques similaires pour des entrées supplémentaires dans l'index. En général, les numéros de support technique et les adresses se trouvent dans la préface. Indexez-les—et n'oubliez pas de créer des entrées croisées et des entrées synonymes pour eux également.
Entrée d'index Entrées clonées et synonymes support technique support, technique
centre d'assistance
problèmes
Révision et perfectionnement d'un index
Une fois que vous avez rassemblé tous les éléments de l’index auxquels vous pouvez penser, il est temps de voir à quoi ressemble l’index et de commencer à le retravailler. Pour réviser un index de première ébauche :
- Établir un index de premier brouillon. Une fois que vous avez créé autant d'entrées d'index, de recoupements et de synonymes que possible, il est temps de "construire" un premier brouillon de l'index. À moins que vous ne travailliez de la manière traditionnelle avec des fiches d'index, vous pouvez faire en sorte que votre application logicielle le fasse pour vous. Par exemple, si vous travaillez dans un système de publication assistée par ordinateur, vous avez parcouru votre texte en insérant des entrées d'index. Le même processus s'applique aux outils de rédaction d'aide. Lorsque vous construisez l'index du premier brouillon, ne soyez pas découragé. Ce n'est qu'un brouillon, auquel vous devrez apporter plusieurs types de révisions.
- Jetez les entrées inutiles. Dans les étapes précédentes, vous avez ébauché l'index. À ce stade, vous ne devez pas vous soucier de la formulation exacte des entrées ou de la probabilité que quiconque les utilise. Mais maintenant, il est temps de commencer à éliminer les entrées que aucun lecteur n'utiliserait jamais. Par exemple, les entrées de premier niveau commençant par "introduire", "utiliser", "à propos" ne sont pas susceptibles d'être utiles. Supprimez-les ! Mais ne les supprimez pas de l'index construit. Retournez dans votre document et débarrassez-vous de l'entrée de l'index original.
- Consolider les entrées avec des formulations similaires. Vous trouverez également de nombreuses entrées qui n'ont que de légères variations dans la formulation. Par exemple :
Brouillons d'entrées Entrées révisées technologie, streaming multimédia
technologies, multimédia en streamingtechnologies, multimédia en streaming affichage vidéo
écrans vidéoaffichages vidéo changer la résolution de l'écran
changer la résolution de l'écranchanger la résolution de l'écran
Comme vous pouvez le voir dans ces exemples, les entrées singulières/plurielle et les variations de verbes sont les causes les plus courantes de formulations similaires dans les entrées de l'index. Votre style de maison peut dicter l'utilisation des singuliers par rapport aux pluriels. Quelle que soit la manière dont vous gérez cela, soyez simplement cohérent. - Grouper les entrées similaires. Vous verrez également des entrées qui doivent être regroupées et subordonnées. Par exemple, elles peuvent toutes commencer par le même mot, mais avoir des modificateurs différents. Voici un exemple :
Entrées similaires Entrées groupées et subordonnées projecteur, défini
projecteurs, compilation
projecteurs, considérations
projecteurs, créant
projecteurs, dépannage
projecteurs compilation
considérations
création
défini
dépannage
- Réviser les entrées avec des entrées de page excessives. Certaines organisations ont des règles de guide de style concernant le nombre de références de pages suivant une entrée d'index qui sont autorisées. Trois est un maximum courant ; deux est agressif, ambitieux. Par exemple, "syntaxe de programmation, 12, 45, 74, 122, 219, 222." Une série de références de pages anonymes comme celle-ci n'aide personne. Au lieu de cela, identifiez le sous-sujet de ces références de pages. Voici un exemple :
Trop de références de page non identifiées Entrées subordonnées et étiquetées projecteurs, 124, 136, 154-155, 156 157 projecteurs
compilation, 154-155
considérations, 156
contrôles, 136
défini, 124, 136, 157
Une très bonne touche que l'on ne voit pas souvent dans les index est la plage de pages sur laquelle un sujet est discuté—même s'il n'y a pas de sous-entrées. Si c'était exact, vous pourriez avoir une entrée comme celle-ci : "projecteurs, 126–137" - Recherchez des groupements d'entrées. Un ajout utile dans les index est de chercher des moyens de regrouper les entrées. Par exemple, imaginez un guide utilisateur qui explique les différentes boîtes de dialogue qui apparaissent dans l'application. Il y a la boîte de dialogue Mot de passe, la boîte de dialogue Nouvel utilisateur, la boîte de dialogue Supprimer l'utilisateur, et ainsi de suite. Que diriez-vous de répéter toutes ces entrées sous "boîtes de dialogue" ?
Entrées Entrées groupées (les entrées sont éparpillées dans tout l'index) Boîte de dialogue Ajouter un utilisateur
...
Boîte de dialogue Supprimer l'utilisateur
...
Boîte de dialogue Nouvel utilisateur
...
Boîte de dialogue de mot de passeBoîte de dialogue Ajouter un utilisateur
...
Boîte de dialogue Supprimer l'utilisateur
...
boîtes de dialogue
Ajouter un utilisateur
Supprimer l'utilisateur
Nouvel Utilisateur
Mot de passe
...
Boîte de dialogue Nouvel Utilisateur
...
Boîte de dialogue du mot de passe- Recherchez des entrées de montée. Dans votre travail d'indexation, vous pourriez avoir des sous-entrées qui doivent être extraites en tant qu'entrées principales.
Entrées Entrées décalées vers le haut
(les entrées sont dispersées dans l'index)batteries
disposition, 33
avertissement d'explosion, 34
recommandation du fabricant, 34
polarité, 33-34
achat, 33
remplaçant, 33-34
onglets, 33(illus)
batteries
élimination, 33
avertissement d'explosion, 34
recommandation du fabricant, 34
polarité, 33-34
achat, 33
remplacement, 33-34
onglets, 33(illus)
élimination, batteries, 33
...
polarité, batteries, 33-34
...
avertissement, batteries, 34
...
Dans cet exemple, l'indexeur pensait que certains (probablement pas beaucoup) lecteurs chercheraient "polarité" en premier plutôt que "batteries, polarité". De même, l'indexeur pensait que les gens pourraient chercher "élimination" en premier. Même si ces possibilités sont minimes, mettez-les quand même dans l'index.- Cherchez Voir aussi et supplémentaire Voir références. Vers la fin de votre phase de révision, jetez un œil à votre index pour la possibilité de Voir aussi références. Voir aussi les références sont pour des termes étroitement liés que les lecteurs pourraient choisir par erreur. Par exemple, dans les anciens systèmes DOS, il y avait le copie commande et le xcopy commande. Les deux commandes sont si étroitement liées par leur nom et leur fonction que vous voudriez mettre Voir aussi références les uns aux autres. Et n'oubliez pas le Voir références : ces points indiquent aux lecteurs des termes synonymes vers les termes que vous préférez utiliser et indexer dans votre livre.
- Vérifiez le style et la mécanique des entrées d'index. L'organisation pour laquelle vous travaillez peut avoir son propre guide de style interne ou vous orienter vers un style standard tel que le Manuel de style de Chicago. Regardez-les très attentivement pour voir comment ils vous disent de capitaliser et de ponctuer les entrées de l'index. Les index utilisent couramment des minuscules pour toutes les entrées qui ne sont pas des noms propres, mais un certain pourcentage utilise des majuscules pour les entrées de premier niveau. La plupart des styles vous demandent de mettre une virgule juste après le terme de l'index et avant les numéros de page ; mais quelques-uns ne le font pas. Certains styles exigent que vous utilisiez le même surlignage dans l'index que dans le texte principal. Si quelque chose est en gras dans le texte principal, ils veulent qu'il soit en gras dans l'index aussi.
Remarque : Ce chapitre utilise une variété de styles de ponctuation et de capitalisation—non pas pour vous confondre, mais pour vous sensibiliser à la variabilité stylistique.
Un style d'index commun Un autre style d'index courant projecteurs, 123
compilation, 154-155
considérations, 156
contrôles, 136
défini, 124, 136, 157
profils de projet, 451-461
projecteurs
compilation 154-155
considérations 156
contrôles 136
défini 124, 136, 157
Profils de projet 451-461
Remarquez dans l'exemple de droite qu'il n'y a pas de virgule entre le terme de l'index et les références de page. De plus, vous constaterez que certaines normes et styles d'indexation désapprouvent la présence d'une référence de page sur une entrée d'index qui a des sous-entrées : par exemple, "projecteurs, 123" dans l'exemple de gauche. Pourquoi la référence de page 123 n'est-elle pas parmi les sous-entrées ? Quel est donc le sous-thème à la page 123 ?
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse.
Informations et programmes fournis par mcmassociates.io, 1995-2026.
Ce travail est sous licence d’un Licence Creative Commons Attribution 4.0 internationale. - Recherchez des entrées de montée. Dans votre travail d'indexation, vous pourriez avoir des sous-entrées qui doivent être extraites en tant qu'entrées principales.