Als technisch schrijver moet je meestal indexen maken voor de gedrukte boeken en voor de online hulp die je ontwikkelt. Het type index dat we hier bedoelen is de klassieke achterin het boek index die paginanummers toont waarop onderwerpen en subonderwerpen in het boek voorkomen. Een online index is vrijwel hetzelfde, behalve dat je hypertextlinks in plaats van paginanummers levert.
Index in een afgedrukt document
Index in een online-hulpsysteem (linker paneel)
Ruw opstellen van een index
Zoals bij elk schrijfproject is er een ruwe opzetfase voor indexering. En natuurlijk moet je nadenken over je publiek—wie ze zijn, hoe ze de index zullen gebruiken, waarom ze het zullen gebruiken en met welke soorten terminologie ze misschien vertrouwd zijn. Daarna, hier is wat je vervolgens moet doen:
- Converteer elke kop in meerdere indexvermeldingen. Koppen zijn een goede plek om te beginnen: ze geven onderwerpen en subonderwerpen aan, precies wat een index doet. Maar koppen gewoon direct in een index kopiëren en weggaan is niet genoeg. Zoals je hieronder zult zien, moet je op zoveel mogelijk praktische manieren kruisverwijzingen maken voor kop-gebaseerde vermeldingen.
- Kruis-lijst elke invoer. Herschik elk van uw op koppen gebaseerde vermeldingen in zoveel praktische manieren als u kunt. Bijvoorbeeld, een kop zoals "Schermresolutie wijzigen" kan worden geïndexeerd als "schermresolutie, wijzigen" evenals "schermresolutie wijzigen." U zou ook "resolutie, schermwijziging" kunnen opnemen. Deze kruisvermeldingen proberen alle verwachte manieren te anticiperen waarop een lezer naar dit onderwerp in een index zou kunnen zoeken: "scherm," "resolutie," of "wijzigen."
Hier zijn enkele extra voorbeelden:
Koptekst Indexvermeldingen Optimaliseren van Videoweergave videoweergave, optimaliseren
video-weergave optimaliseren
weergave, optimaliseren van videoStreaming Multimedia Afspelen streaming multimedia, afspelen
streaming multimedia afspelen
multimedia, streaming afspelenNetwerkbasisprincipes netwerken
netwerkenIntroductie van Streaming Multimedia streaming multimedia
multimedia, streaming
Merk op dat je indexvermeldingen niet altijd op elk woord kunt cross-lijsten. Bijvoorbeeld, "introducing streaming multimedia" zou in dit geval gewoon niet werken. Zou een lezer ooit naar dit onderwerp zoeken beginnend met "introducing"? - Maak synoniemen-invoeren. Lezers gebruiken niet noodzakelijkerwijs dezelfde terminologie als jij in je documentatie. Ze kunnen een diskette-eenheid een "floppy drive" noemen. Ze kunnen een display een "monitor" noemen. Als indexeur moet je deze veelvoorkomende variaties in terminologie anticiperen. In de voorgaande vermeldingen zou het een goed idee zijn om een synoniem voor "video display" te hebben, zoals "monitor." Maar in plaats van de paginanummers te herhalen, gebruik een Zie verwijzing. Op die manier wijs je lezers op de voorkeursterm. (Natuurlijk, als er maar één paginanummer is, herhaal het dan gewoon met de synoniemvermelding.)
Hier zijn enkele extra voorbeelden:
Indexvermelding Synoniemen invoer volume, aanpassen luidheid, aanpassen overdrachtsnelheid snelheid, transmissie video opnemen video kopiëren - Beoordeel de tekst voor aanvullende indexvermeldingen. Het is meestal niet genoeg om alleen op koppen te indexeren. Je moet dieper in de tekst graven naar concepten, termen en taken die niet door de koppen worden weergegeven. Bijvoorbeeld, onder de kop "Een multimedia-stroom maken" kun je definities van "vastleggen" en "coderen" zien. Dit zijn belangrijke termen, maar ze komen nergens in de koppen voor—indexeer ze ook! In dit geval zou je deze aanvullende indexvermeldingen willen maken: "vastleggen van streams" en "coderen van streams."
- Index voor- en achtermatter. Vergeet niet om in het voorwoord, de veiligheidswaarschuwingen, bijlagen en andere dergelijke perifere documenten te graven voor aanvullende indexvermeldingen. Gewoonlijk worden technische ondersteuningsnummers en adressen in het voorwoord weergegeven. Indexeer ze—en vergeet niet om ook kruisverwijzingen en synonieme vermeldingen voor hen aan te maken.
Indexvermelding Gekloonde en synoniem invoer technische ondersteuning ondersteuning, technisch
helpdesk
problemen
Herzien en Fijnstemmen van een Index
Zodra je alle indexvermeldingen hebt gebrainstormd die je kunt bedenken, is het tijd om te kijken hoe de index eruitziet en ermee aan de slag te gaan. Om een ruw-draft index te herzien:
- Bouw een eerste versie van de index. Zodra je zoveel mogelijk indexvermeldingen, kruisvermeldingen en synoniemen hebt gemaakt, is het tijd om een eerste concept van de index te "bouwen". Tenzij je op de ouderwetse manier met indexkaarten werkt, kun je je softwaretoepassing dit voor je laten doen. Als je bijvoorbeeld in een desktop publishing-systeem werkt, heb je door je tekst gegaan om indexvermeldingen toe te voegen. Hetzelfde proces geldt voor help-authoring tools. Wanneer je de eerste versie van de index bouwt, laat je niet ontmoedigen. Het is slechts een ruwe versie, waarop je verschillende soorten revisies moet toepassen.
- Verwijder nutteloze invoer. In de voorafgaande stappen heb je de index ruw opgesteld. In die fase maak je je niet druk over de exacte formulering van de items of de kans dat iemand ze ooit zou gebruiken. Maar nu is het tijd om de items eruit te filteren die nooit door een lezer gebruikt zullen worden. Bijvoorbeeld, eerste-niveau items die beginnen met "introduceren," "gebruik," "over" zijn waarschijnlijk niet nuttig. Verwijder ze! Maar verwijder ze niet uit de gebouwde index. Ga terug naar je document en haal de oorspronkelijke indexvermelding weg.
- Consolideer vermeldingen met vergelijkbare bewoording. Je zult ook veel vermeldingen vinden die slechts kleine variaties in formulering hebben. Bijvoorbeeld:
Ruwe conceptinvoer Aangepaste vermeldingen technologie, streaming multimedia
technologieën, streaming multimediatechnologieën, streaming multimedia videoweergave
videodisplaysvideoweergaven verander schermresolutie
schermresolutie wijzigenschermresolutie wijzigen
Zoals u in deze voorbeelden kunt zien, zijn enkelvoud/meervoud vermeldingen en werkwoordvariaties de meest voorkomende oorzaken van vergelijkbare formuleringen in indexvermeldingen. Uw huisstijl kan bepalen dat u enkelvoudige vormen gebruikt in plaats van meervoudige. Hoe u dit ook aanpakt, wees gewoon consistent. - Groep soortgelijke invoeren. Je zult ook vermeldingen zien die gegroepeerd en ondergeschikt moeten worden. Bijvoorbeeld, ze kunnen allemaal beginnen met hetzelfde woord, maar verschillende aanpassingen hebben. Hier is een voorbeeld:
Vergelijkbare invoer Groep en ondergeschikte vermeldingen projector, gedefinieerd
projectoren, samenstellen
projectoren, overwegingen
projectors, creëren
projectoren, probleemoplossing
projectoren compileren
overwegingen
creëren
gedefinieerd
problemen oplossen
- Herschrijf vermeldingen met een teveel aan paginavermeldingen. Sommige organisaties hebben daadwerkelijke stijlgidsregels over hoeveel paginareferenties na een indexvermelding toegestaan zijn. Drie is een gebruikelijke maximum; twee is agressief, ambitieus. Bijvoorbeeld, "programmeringssyntaxis, 12, 45, 74, 122, 219, 222." Een reeks anonieme paginareferenties zoals deze helpt niemand. Identificeer in plaats daarvan het subonderwerp voor deze paginareferenties. Hier is een voorbeeld:
Te veel onbekende paginareferenties Ondergeschikte en gelabelde invoer projectors, 124, 136, 154-155, 156 157 projectoren
compileren, 154-155
overwegingen, 156
bedieningen, 136
gedefinieerd, 124, 136, 157
Een zeer goede aanvulling die je niet vaak ziet in indexen is het paginabereik waarop een onderwerp besproken wordt—ook al zijn er geen subentries. Als het nauwkeurig was, zou je een invoer kunnen hebben zoals: "projectoren, 126–137" - Zoek naar invoergroepen. Een nuttige toevoeging in indexen is om manieren te zoeken waarop je vermeldingen kunt groeperen. Stel je bijvoorbeeld een gebruikershandleiding voor die de verschillende dialoogvensters uitlegt die in de applicatie verschijnen. Er is het wachtwoorddialoogvenster, het nieuwe gebruikersdialoogvenster, het verwijder gebruikersdialoogvenster, enzovoort. Wat dacht je ervan om al die vermeldingen opnieuw te herhalen onder "dialoogvensters"?
Invoeren Groepse invoer (entries zijn verspreid over de index) Voeg gebruiker dialoogvenster toe
...
Verwijder gebruiker dialoogvenster
...
Nieuw gebruikersdialoogvenster
...
Wachtwoord vensterVoeg gebruiker dialoogvenster toe
...
Gebruiker verwijderen dialoogvenster
...
dialoogvensters
Gebruiker Toevoegen
Verwijder gebruiker
Nieuwe gebruiker
Wachtwoord
...
Nieuw gebruikersdialoogvenster
...
Wachtwoorddialoogvenster- Zoek naar shift-up invoeringen. In uw indexeerwerk heeft u mogelijk enkele subvermeldingen die als hoofdvermeldingen gekopieerd moeten worden.
Invoeren Verschoofde invoeren
(invoeren zijn verspreid over de index)batterijen
afvoeren, 33
explosiewaarschuwing, 34
fabrikant aanbeveling, 34
polariteit, 33-34
aankoop, 33
vervangen, 33-34
tabs, 33(illus)
batterijen
afvoeren, 33
explosiewaarschuwing, 34
fabrikant aanbeveling, 34
polariteit, 33-34
aankopen, 33
vervangen, 33-34
tabbladen, 33(illus)
afvoeren, batterijen, 33
...
polariteit, batterijen, 33-34
...
waarschuwing, batterijen, 34
...
In dit voorbeeld dacht de indexeur dat enkele (waarschijnlijk niet veel) lezers "polariteit" eerst zouden opzoeken in plaats van "batterijen, polariteit." Evenzo dacht de indexeur dat mensen "afvoeren" eerst zouden opzoeken. Hoewel deze mogelijkheden klein zijn, zet ze toch in de index.- Zoek naar Zie ook en extra Zie referenties. Tegen het einde van je herzieningsfase, kijk naar je index voor de mogelijkheid van Zie ook referenties. Zie ook verwijzingen zijn voor nauw verwante termen die lezers per ongeluk kunnen kiezen. Bijvoorbeeld, in de oude DOS-systemen was er de kopie opdracht en de xcopy opdracht. De twee opdrachten zijn zo nauw met elkaar verbonden in naam en functie dat je zou willen zetten Zie ook verwijzingen naar elkaar. En vergeet de niet. Zie referenties: die wijzen lezers van synonieme termen naar de termen die u verkiest te gebruiken en waarvoor u in uw boek indexeert.
- Controleer de stijl en mechanica van indexvermeldingen. De organisatie waarvoor je werkt, heeft mogelijk een eigen huisstijlhandleiding of verwijst je naar een standaardstijl zoals de Chicago Manual of Style. Kijk hier heel goed naar hoe ze je vertellen om indexvermeldingen te kapitaliseren en te punctueren. Indexen gebruiken doorgaans kleine letters voor alle niet-eigennaam vermeldingen, maar een bepaald percentage gebruikt hoofdletters voor de eerste-niveau vermeldingen. De meeste stijlen vereisen dat je een komma plaatst direct na de indexterm en voor de paginanummers; maar een paar doen dit niet. Sommige stijlen vereisen dat je dezelfde opmaak in de index gebruikt als in de hoofdtekst. Als iets vetgedrukt is in de hoofdtekst, willen ze dat het ook vetgedrukt is in de index.
Opmerking: Dit hoofdstuk gebruikt een verscheidenheid aan interpunctie en hoofdlettergebruik—niet om je in de war te brengen, maar om je bewust te maken van stilistische variabiliteit.
Eén gemeenschappelijke indexstijl Een andere veelvoorkomende indexstijl projectoren, 123
compileren, 154-155
overwegingen, 156
bedieningen, 136
gedefinieerd, 124, 136, 157
projectprofielen, 451-461
projectoren
compileren 154-155
overwegingen 156
bedieningen 136
gedefinieerd 124, 136, 157
Projectprofielen 451-461
Let op in het rechtervoorbeeld dat er geen komma is tussen de indexterm en de paginareferenties. Ook zul je merken dat sommige indexstandaarden en stijlen het niet goedkeuren om een paginareferentie op een indexvermelding te hebben die subvermeldingen heeft: bijvoorbeeld "projectoren, 123" in het linker voorbeeld. Waarom staat de paginareferentie 123 niet onder de subvermeldingen? Wat is het subonderwerp op pagina 123?
Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk op prijs stellen: je reactie.
Informatie en programma's aangeboden door mcmassociates.io, 1995-2026.
Dit werk is gelicentieerd onder een Creative Commons Naamsvermelding 4.0 Internationale Licentie. - Zoek naar shift-up invoeringen. In uw indexeerwerk heeft u mogelijk enkele subvermeldingen die als hoofdvermeldingen gekopieerd moeten worden.