Műszaki íróként általában indexeket kell készítened a nyomtatott könyvekhez és az általad fejlesztett online súgókhoz. Az itt említett index típusa a klasszikus, a könyv végén található tárgymutató, amely megmutatja azokat az oldalszámokat, amelyeken a témák és al-témák előfordulnak a könyvben. Egy online index nagyjából ugyanaz, csupán az a különbség, hogy oldalszámok helyett hiperhivatkozásokat adsz meg.
Index egy nyomtatott dokumentumban
Index az online súgórendszerben (bal oldali panel)
Egy index piszkozatának elkészítése
Mint bármely írási projekt esetében, az indexelésnek is van egy durva vázlatkészítési fázisa. És természetesen gondolnod kell a közönséged—kik ők, hogyan fogják használni az indexet, miért fogják használni, és milyen terminológiához lehetnek szokva. Ezután a következőket kell tenned:
- Minden címsort alakítson át több indexbejegyzéssé. A címsorok jó kiindulópontot jelentenek: megjelölik a témákat és az altémákat—pontosan azt, amit egy tárgymutató tesz. Azonban ne másold a címsorokat egyszerűen át a tárgymutatóba, majd hagyd őket annyiban. Ahogy az alábbiakban látni fogod, a címsorokra alapozott bejegyzéseket annyiféleképpen kell kereszthivatkozni, amennyire csak gyakorlatilag lehetséges.
- Keresztlistázza az összes bejegyzést. Rendezd át minden címalapú bejegyzésedet a lehető legtöbb praktikus módon. Például egy olyan cím, mint „Képernyőfelbontás megváltoztatása”, indexelhető „képernyőfelbontás, megváltoztatás” formában, valamint „képernyőfelbontás megváltoztatása” formában is. Belevehetsz továbbá olyan bejegyzést is, hogy „felbontás, képernyő megváltoztatása”. Ezek a kereszthivatkozott bejegyzések arra törekszenek, hogy előre számoljanak minden valószínű módot, ahogyan egy olvasó az indexben erre a témára kereshet: „képernyő”, „felbontás” vagy „megváltoztatás”.
Íme néhány további példa:
Fejléc Indexbejegyzések Videó megjelenítés optimalizálása videó megjelenítés, optimalizálás
Videómegjelenítés optimalizálása
megjelenítés, videó optimalizálásaStreamelt multimédia lejátszása multimédia közvetítése, lejátszás
streamelt multimédia lejátszása
multimédia, streaming lejátszásaHálózati alapok kapcsolatépítés
hálózatokA streaming multimédia bemutatása streaming multimédia
multimédia, streamelés
Vegye figyelembe, hogy nem mindig lehet minden szóra átkategorizálni az indexbejegyzéseket. Például az előzőben szereplő „Bevezetés a streaming multimédiába” egyszerűen nem működne. Vajon egy olvasó valaha is az „bevezetés” szóval kezdené ennek a témának a keresését? - Hozzon létre szinonima bejegyzéseket. Az olvasók nem feltétlenül ugyanazt a terminológiát használják, mint te a dokumentációdban. Lehet, hogy a diszkettmeghajtót "floppy meghajtónak" nevezik. Lehet, hogy a kijelzőt "monitor"-nak hívják. Indexelőként számítanod kell ezekre a gyakori terminológiai eltérésekre. A korábbi bejegyzésekben jó ötlet lenne egy szinonima használata a "videokijelző" kifejezésre, például a "monitor". De ahelyett, hogy megismételnéd az oldalszámokat, használj egy Látni hivatkozás. Így a preferált kifejezésre irányítja az olvasókat. (Természetesen, ha csak egy oldalszám szerepel, egyszerűen ismételje meg azt a szinonimaszóbejegyzésnél.)
Íme néhány további példa:
Index bejegyzés Szinonimabejegyzések hangerő, beállítás hangosság, beállítás átviteli sebesség sebesség, átvitel videó rögzítése videó másolása - Vizsgálja át a szöveget további tárgymutató-bejegyzésekhez. Általában nem elég csak a címsorok alapján indexelni. A szövegben le kell ásni a fogalmak, kifejezések és feladatok után, amelyek nem jelennek meg a címsorokban. Például a "Multimédia-stream létrehozása" cím alatt láthatod a "rögzítés" és a "kódolás" meghatározásait. Ezek fontos kifejezések, de sehol sem szerepelnek a címsorokban— indexeld őket is! Ebben az esetben ezeket a további tárgymutató-bejegyzéseket szeretnéd létrehozni: "streamek rögzítése" és "streamek kódolása".
- Tárgymutató, elő- és utóanyag. Ne feledje, hogy nézzen körül az előszóban, a biztonsági értesítésekben, a függelékekben és más hasonló mellékletekben további tárgyszóbejegyzések után. Általában a műszaki támogatás telefonszámai és címei az előszóban vannak feltüntetve. Jegyezze fel őket a tárgyszójegyzékben—és ne felejtse el létrehozni a hozzájuk tartozó kereszthivatkozott és szinonima bejegyzéseket is.
Index bejegyzés Klónozott és szinonim bejegyzések technikai támogatás támogatás, műszaki
ügyfélszolgálat
problémák
Egy index felülvizsgálata és finomhangolása
Miután kigondoltál minden olyan tárgymutató-bejegyzést, ami csak eszedbe jut, ideje megnézni, hogyan néz ki a mutató, és nekilátni az átdolgozásának. Egy vázlatos mutató átdolgozásához:
- Készíts egy első vázlatú indexet. Miután elkészítetted a lehető legtöbb indexbejegyzést, kereszthivatkozást és szinonimát, ideje összeállítani az index első vázlatát. Ha nem a régimódi indexkártyákkal dolgozol, a szoftveralkalmazásod el tudja végezni ezt helyetted. Például ha egy asztali kiadórendszerben dolgozol, végigmentél a szövegeden és beillesztetted az indexbejegyzéseket. Ugyanez a folyamat érvényes a súgószerkesztő eszközökre is. Amikor összeállítod az első vázlatot, ne csüggedj. Ez csupán egy durva vázlat, amelyen többféle átdolgozást kell majd elvégezned.
- Dobd ki a haszontalan bejegyzéseket. Az előző lépésekben durva vázlatot készítettél az indexről. Ebben a fázisban nem akad fenn a bejegyzések pontos megfogalmazásán vagy azon, hogy mennyire valószínű, hogy bárki használni fogja őket. De most van itt az ideje, hogy elkezdd kiszűrni azokat a bejegyzéseket, amelyeket egyetlen olvasó sem fog soha használni. Például az olyan első szintű bejegyzések, amelyek „introducing”, „using”, „about” szóval kezdődnek, valószínűleg nem lesznek hasznosak. Töröld őket! De ne a kész indexből töröld őket. Menj vissza a dokumentumodba, és töröld ki az eredeti indexbejegyzést.
- Egyesítsd a hasonló megfogalmazású bejegyzéseket. Találni fogsz sok olyan bejegyzést is, amelyek csak apró megfogalmazásbeli eltéréseket tartalmaznak. Például:
Vázlatbejegyzések Módosított bejegyzések technológia, streaming multimédia
technológiák, streaming multimédiatechnológiák, folyamközvetített multimédia videokijelző
videókijelzőkvideó kijelzők képernyő felbontásának módosítása
Képernyőfelbontás módosításaképernyőfelbontás módosítása
Ahogy ezekből a példákból is látható, az egyes és többes számú bejegyzések, valamint az igealakok a leggyakoribb okai annak, hogy a tárgymutató-bejegyzések hasonló megfogalmazásúak. A házi stílusod előírhatja az egyes szám használatát a többes szám helyett. Akárhogy is kezeled ezeket, légy következetes. - Csoportosítsa a hasonló bejegyzéseket. Azt is látni fogja, hogy vannak bejegyzések, amelyeket csoportosítani és alárendelni kell. Például mind ugyanazzal a szóval kezdődhetnek, de különböző módosítóik lehetnek. Íme egy példa:
Hasonló bejegyzések Csoportosított és alárendelt bejegyzések projektor, definiált
projektorok, fordítás
projektorok, szempontok
projektorok, létrehozás
vetítők, hibaelhárítás
projektorok fordítás
megfontolások
létrehozás
meghatározott
hibaelhárítás
- Dolgozd át azokat a bejegyzéseket, amelyek túl sok oldalbejegyzést tartalmaznak. Néhány szervezetnek vannak konkrét stílusirányelvi szabályai arra vonatkozóan, hogy egy indexbejegyzést követően hány oldalszám-hivatkozás engedélyezett. A három a gyakori maximum; a kettő agresszív, ambiciózus. Például: „programozási szintaxis, 12, 45, 74, 122, 219, 222.” Egy ilyen névtelen oldalszámsor senkinek sem segít. Ehelyett azonosítsuk az altémát ezekhez az oldalszámokhoz. Itt egy példa:
Túl sok azonosítatlan oldalhivatkozás Alárendelt és címkézett bejegyzések projektorok, 124, 136, 154-155, 156 157 projektorok
kompilálás, 154-155
megfontolások, 156
vezérlők, 136
definiált, 124, 136, 157
Egy nagyon jó megoldás, amelyet nem gyakran látni a tárgymutatókban, az az oldaltartomány, amelyen egy témát tárgyalnak—még akkor is, ha nincsenek albejegyzések. Ha pontos lenne, ilyen bejegyzésed lehetne: "projektorok, 126–137" - Keresse a bejegyzéscsoportosításokat. Az indexekben egy kellemes, hasznos megoldás, ha megkeresed azokat a lehetőségeket, amelyekkel csoportosítani tudod a bejegyzéseket. Például képzelj el egy felhasználói kézikönyvet, amely ismerteti az alkalmazásban felugró különféle párbeszédablakokat. Ilyenek a Jelszó párbeszédablak, az Új felhasználó párbeszédablak, a Felhasználó törlése párbeszédablak és így tovább. Mi lenne, ha az összes ilyen bejegyzést megismételnéd a „párbeszédablakok” alatt?
Bejegyzések Csoportosított bejegyzések (A bejegyzések szétszórva találhatók a mutatóban) Felhasználó hozzáadása párbeszédablak
...
Felhasználó törlése párbeszédablak
...
Új felhasználó párbeszédablak
...
Jelszó párbeszédablakFelhasználó hozzáadása párbeszédablak
...
Felhasználó törlése párbeszédablak
...
párbeszédablakok
Felhasználó hozzáadása
Felhasználó törlése
Új felhasználó
Jelszó
...
Új felhasználó párbeszédablak
...
Jelszó párbeszédablak- Keresd a felváltás bejegyzéseket. Az indexelési munkád során előfordulhat, hogy néhány albejegyzést főbejegyzésként ki kell másolni.
Bejegyzések Felfelé eltolódott bejegyzések
(a bejegyzések szétszórva találhatók a tárgymutatóban)elemek
eldobás, 33
robbanásveszély, 34
gyártói ajánlás, 34
polaritás, 33-34
vásárlás, 33
cserélve, 33-34
fülek, 33 (illusztráció)
elemek
eldobás, 33
robbanásra figyelmeztetés, 34
gyártói ajánlás, 34
polaritás, 33-34
vásárlás, 33
cserélés, 33-34
táblák, 33 (illusztráció)
eldobás, elemek, 33
...
polarítás, elemek, 33-34
...
figyelmeztetés, elemek, 34
...
Ebben a példában az indexelő úgy gondolta, hogy néhány (valószínűleg nem sok) olvasó először a „polaritás”-t fogja keresni a „elemek, polaritás” helyett. Hasonlóképpen az indexelő úgy gondolta, hogy az emberek először az „eldobás”-t kereshetik. Még ha az ilyen lehetőségek kicsik is, vedd fel őket a tárgymutatóba.- Keresd Lásd még és további Lásd hivatkozások. A javítási fázisod vége felé nézd meg az indexedet, hátha van lehetőség Lásd még hivatkozások. Lásd még A hivatkozások olyan, szorosan kapcsolódó kifejezésekre szolgálnak, amelyeket az olvasók tévedésből választhatnak. Például a régi DOS-rendszerekben ott volt a másolat parancs és a xcopy parancs. A két parancs névben és funkcióban olyan szorosan kapcsolódik egymáshoz, hogy el szeretnéd helyezni Lásd még egymásra való hivatkozások. És ne felejtsd el a Lásd referenciák: ezek a szinonim kifejezésekről azokra a kifejezésekre irányítják az olvasókat, amelyeket előnyben részesítesz használni, és amelyek szerint indexelsz a könyvedben.
- Ellenőrizze a tárgymutató bejegyzéseinek stílusát és mechanikáját. A szervezet, amelynél dolgozik, lehet, hogy rendelkezik saját házi stílusútmutatóval, vagy hivatkozhat valamely szabványos stílusra, például a Chicago stílus kézikönyve. Nézd meg ezeket nagyon alaposan, mert megmondják, hogyan kell nagybetűket használni és hogyan kell központozni a tárgyműmutató-bejegyzéseket. A tárgymutatók általában kisbetűt használnak minden nem sajátnév bejegyzésnél, de egy bizonyos százalékuk valóban kezdő nagybetűt használ az első szintű bejegyzéseknél. A legtöbb stílus megköveteli, hogy vesszőt tegyél közvetlenül a tárgymutató kifejezés után és a lapszámok elé; de néhány nem. Egyes stílusok megkövetelik, hogy ugyanazt a kiemelést használd a tárgymutatóban, mint a főszövegben. Ha valami félkövér a főszövegben, azt a tárgymutatóban is félkövérrel akarják.
Megjegyzés: Ez a fejezet különféle írásjelek és nagybetűsítési stílusok változatait használja—nem azért, hogy összezavarjon téged, hanem hogy felhívja a figyelmedet a stilisztikai változékonyságra.
Egy gyakori indexstílus Egy másik gyakori indexstílus projektorok, százhuszonhárom
kompilálás, 154–155
megfontolások, 156
vezérlők, 136
definiált, 124, 136, 157
projektprofilok, 451–461
projektorok
kompilálás 154-155
megfontolások 156
vezérlők 136
meghatározott 124, 136, 157
Projektprofilok 451–461
Figyelje meg a jobb oldali példát, hogy nincs vessző az indexszó és az oldalszám-hivatkozások között. Azt is tapasztalni fogja, hogy néhány indexelési szabvány és stílus nem helyesli, ha olyan indexbejegyzésen szerepel oldalszám-hivatkozás, amelynek albejegyzései vannak: például "projektorok, 123" a bal oldali példában. Miért nincs a 123-as oldalszám-hivatkozás az albejegyzések között? Mi pontosan az az altéma a 123. oldalon?
Nagyra értékelném a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban: a válaszod.
Az információkat és a programokat biztosítja: mc társai.io, 1995-2026.
Ez a mű egy licenc alatt áll. Creative Commons Nevezd meg 4.0 Nemzetközi licenc. - Keresd a felváltás bejegyzéseket. Az indexelési munkád során előfordulhat, hogy néhány albejegyzést főbejegyzésként ki kell másolni.