Ako technický autor budete zvyčajne musieť vytvárať indexy pre tlačené knihy a pre online pomôcky, ktoré vyvíjate. Typ indexu, o ktorom hovoríme, je klasický index na konci knihy, ktorý zobrazuje čísla strán, na ktorých sa nachádzajú témy a podtémy v knihe. Online index je veľmi podobný, ale namiesto čísel strán poskytujete hypertextové odkazy.

Index v tlačenom dokumente

Obsah v online pomocnom systéme (ľavý panel)

Návrh obsahu indexu

Rovnako ako pri akomkoľvek písacom projekte, existuje fáza hrubého návrhu pre indexovanie. A samozrejme, musíte premýšľať o svojej cieľovej skupine—kto sú, ako budú index využívať, prečo ho budú používať a na aký druh terminológie sú zvyknutí. Potom, tu je, čo robiť ďalej:

  1. Preveďte každý nadpis na viacero indexových záznamov. Nadpisy sú dobrým východiskom: naznačujú témy a podtémy—presne to, čo robí index. Avšak, nepoužívajte len priamo kopírovanie nadpisov do indexu a neodchádzajte. Ako uvidíte nižšie, potrebujete krížovo zoznamovať položky založené na nadpisoch čo najviac prakticky.
  2. Krížovo zarovnajte každý záznam. Preusporiadajte každú z vašich položiek založených na nadpisoch do čo najviac praktických spôsobov. Napríklad, nadpis ako "Zmena rozlíšenia obrazovky" môže byť indexovaný ako "rozlíšenie obrazovky, zmena" rovnako ako "zmena rozlíšenia obrazovky." Môžete tiež zahrnúť "rozlíšenie, zmena obrazovky." Tieto krížovo zoznamované položky sa snažia predpokladať všetky pravdepodobné spôsoby, akými by čitateľ mohol hľadať toto téma v indexe: "obrazovka," "rozlíšenie," alebo "zmena."

    Tu sú niektoré ďalšie príklady:

    Nadpis Indexové záznamy
    Optimalizácia zobrazenia videa video zobrazenie, optimalizácia
    optimalizácia zobrazenia videa
    zobrazenie, optimalizácia videa
    Hranie streamingových multimédií streamovanie multimédií, hranie
    hrá streaming multimédiá
    multimédiá, prehrávanie streamovania
    Základy sieťovania networking
    sieťe
    Úvod do streamingového multimédií streamovanie multimédií
    multimédiá, streamovanie

    Všimnite si, že nemôžete vždy krížovo označiť indexové položky pre každé slovo. Napríklad "introducing streaming multimedia" v predchádzajúcom texte by jednoducho nefungovalo. Hľadal by niekto tento predmet začínajúc "introducing"?
  3. Vytvorte synonymné záznamy. Čitatelia nemusia nevyhnutne používať rovnakú terminológiu ako vy vo vašej dokumentácii. Môžu nazývať diskovú jednotku "disketová jednotka." Môžu odkazovať na displej ako "monitor." Ako indexér, musíte predpokladať tieto bežné variácie v terminológii. V predchádzajúcich záznamoch by bolo dobré mať synonymum pre "video displej," ako napríklad "monitor." Ale namiesto opakovania čísel strán, použite a Vidieť referencia. Týmto spôsobom ukazujete čitateľom preferovaný termín. (Samozrejme, ak je iba jedno číslo stránky, jednoducho ho zopakujte s vchodom synonym.)

    Tu sú niektoré ďalšie príklady:

    Indexový záznam Synonymové záznamy
    hlasitosti, nastavovanie hlasitost, nastavenie
    prenosová rýchlosť rýchlosť, prevodovka
    zachytávanie videa kopírovanie videa

  4. Skontrolujte text na ďalšie záznamy v indexe. Zvyčajne nie je dosť iba indexovať podľa nadpisov. Musíte sa ponoriť do textu za účelmi, termínmi a úlohami, ktoré nie sú reprezentované nadpismi. Napríklad pod nadpisom "Vytváranie multimediálneho prúdu" môžete vidieť definície "zachytávania" a "kódovania." Tieto sú dôležité termíny, ale nikde sa neobjavujú v nadpisoch—indexujte ich tiež! V tomto prípade by ste mali vytvoriť tieto dodatočné indexové záznamy: "zachytávanie prúdov" a "kódovanie prúdov."
  5. Index prednej a zadnej časti. Nezabudnite sa prehrabať v predslove, bezpečnostných oznámeniach, prílohách a iných takých perifériách, aby ste našli ďalšie položky indexu. Zvyčajne sú technické podporné čísla a adresy uvedené v predslove. Indexujte ich—a nezabudnite vytvoriť aj krížovo uvedené položky a synonymové položky pre ne.

    Indexový záznam Klónované a synonymné záznamy
    technická podpora podpora, technická
    help desk
    problémy

Revízia a doladenie indexu

Akonáhle ste premýšľali o všetkých indexových položkách, ktoré vás napadnú, je čas pozrieť sa, ako index vyzerá, a začať na ňom pracovať. Ak chcete revidovať hrubý návrh indexu:

  1. Vytvorte prvotný návrh indexu. Akonáhle vytvoríte čo najviac indexových položiek, krížových záznamov a synonym, je čas „vytvoriť“ prvú verziu indexu. Pokiaľ nepracujete staromódnym spôsobom s indexovými kartami, môžete nechať, aby to za vás urobil váš softvérový aplikácia. Napríklad, ak pracujete v systéme desktopového publikovania, prešli ste svojím textom a vkládali indexové položky. Ten istý proces platí aj pre nástroje na vytváranie pomoci. Keď vytvoríte prvú verziu indexu, nenechajte sa odradiť. Je to len hrubý náčrt, na ktorý budete musieť urobiť niekoľko druhov revízií.
  2. Zahoďte zbytočné položky. V predchádzajúcich krokoch ste vytvárali hrubý návrh indexu. V tejto fáze sa nezapájate do presného formulovania položiek ani sa nezamýšľate nad tým, či ich niekto vôbec použije. Ale teraz je čas začať vyraďovať položky, ktoré by žiadny čitateľ nikdy nepoužil. Napríklad prvotné položky začínajúce na "úvod," "použitie," "o" pravdepodobne nebudú užitočné. Vymažte ich! Ale nezmazávajte ich z vytvoreného indexu. Vráťte sa do svojho dokumentu a zbavte sa pôvodnej položky indexu.
  3. Konsolidujte položky s podobným znením. Nájdete tiež veľa záznamov, ktoré majú iba drobné variácie v phrasingu. Napríklad:

    Návrhové zápisy Revidované záznamy
    technológia, streamovanie multimédií
    technológie, streamovanie multimédií    		 technológie, streamovanie multimédií
    video displej
    videoukážky    		 video displeje
    zmeniť rozlíšenie obrazovky
    zmena rozlíšenia obrazovky    		 zmena rozlíšenia obrazovky

    Ako môžete vidieť v týchto príkladoch, jednotné/množné vstupy a variácie slovies sú najbežnejšie príčiny podobného formulovania v indexových položkách. Váš štýlový manuál môže predpisovať používanie jednotného čísla namiesto množného. Nech už to zvládnete akokoľvek, buďte len konzistentní.
  4. Skupinujte podobné položky. Uvidíte aj položky, ktoré je potrebné zoskupiť a podriadiť. Napríklad môžu všetky začínať rovnakým slovom, ale mať rôzne modifikátory. Tu je príklad:

    Podobné záznamy Zoskupené a podriadené položky
    projektor, definovaný
    projektory, zostavovanie
    projektory, úvahy
    projektory, vytvárajúce
    projektory, odstraňovanie problémov

    		projektory

    kompilácia

    úvahy

    vytváranie

    definovaný

    odstraňovanie problémov

  5. Prepracujte položky s nadmernými stránkovými položkami. Niektoré organizácie majú skutočné pravidlá v štýlových príručkách, pokiaľ ide o to, koľko stránkových odkazov nasledujúcich po položke v indexe je povolených. Tri sú bežným maximom; dva sú agresívne, ambiciózne. Napríklad, "programovacia syntax, 12, 45, 74, 122, 219, 222." Takýto sled anonymných stránkových odkazov nikomu nepomáha. Namiesto toho identifikujte podtému pre tieto stránkové odkazy. Tu je príklad:

    Príliš veľa neidentifikovaných odkazov na stránky Podriadené a označené záznamy
    projektory, 124, 136, 154-155, 156 157 projektory

    kompilácia, 154-155

    úvahy, 156

    ovládania, 136

    definované, 124, 136, 157


    Veľmi dobrý prvok, ktorý sa v indexoch často nevidí, je rozsah strán, na ktorých sa daná téma diskutuje—aj keď neexistujú žiadne podzáznamy. Ak by to bolo presné, mohli by ste mať záznam ako tento: "projektory, 126–137"
  6. Hľadajte skupiny vstupov. Pekný užitočný dotyk v indexoch je hľadať spôsoby, ako môžete skupinovať záznamy. Napríklad si predstavte používateľskú príručku, ktorá vysvetľuje rôzne dialógové okná, ktoré sa objavujú v aplikácii. Existuje dialógové okno "Heslo", dialógové okno "Nový užívateľ", dialógové okno "Vymazať užívateľa" atď. Čo tak zopakovať všetky tieto záznamy pod "dialógové okná"?

  7. Hľadajte vstupy na posun nahor. Vo vašej indexačnej práci môžete mať niektoré podzáznamy, ktoré je potrebné skopírovať ako hlavné záznamy.

    8. Záznamy Zoskupené záznamy
    (vstupy sú rozptýlené po celom indexe)
    Dialógové okno na pridanie používateľa
    ...
    Dialogové okno na odstránenie používateľa
    ...
    Dialógové okno Nový používateľ
    ...
    Dialógové okno pre heslo     		Pridať používateľské okno diálogu
    ...
    Okno pre odstránenie používateľa
    ...
    dialógové okná

    Pridať používateľa

    Zmazať používateľa

    Nový používateľ

    Heslo

    ...
    Dialógové okno nového používateľa
    ...
    Dialógové okno pre heslo

    Vstupy Posunuté záznamy
    (záznamy sú roztrhnuté po celom indexe)
    baterky

    odstránenie, 33

    varovanie o explózii, 34

    odporúčanie výrobcu, 34

    polarita, 33-34

    nákup, 33

    nahrádzanie, 33-34

    karty, 33(illus)

    		batérie

    odstránenie, 33

    výstraha pred výbuchom, 34

    odporúčanie výrobcu, 34

    polarita, 33-34

    nákup, 33

    nahradzovanie, 33-34

    záložky, 33(illu)

    likvidácia, batérie, 33
    ...
    polarita, batérie, 33-34
    ...
    varovanie, batérie, 34
    ...

    V tomto príklade si indexátor myslel, že niektorí (pravdepodobne nie mnohí) čitatelia by najprv vyhľadali "polaritu" namiesto "batérie,polarita." Podobne si indexátor myslel, že ľudia by mohli najprv vyhľadávať "zničenie." Aj keď sú takéto možnosti malé, zahrňte ich do indexu.
  8. Hľadaj Pozri tiež a ďalšie Vidieť referencie. Na konci fázy revízie sa pozrite na svoj index za účelom Pozri tiež referencie. Pozri tiež referencie sú pre úzko súvisiace pojmy, ktoré by si čitatelia mohli omylom zvoliť. Napríklad v starých systémoch DOS bolo skopírovať príkaz a xcopy príkaz. Tieto dva príkazy sú tak úzko prepojené názvom a funkciou, že by ste chceli umiestniť Pozri tiež referencie na seba. A nezabudnite na Vidieť odkazy: Tie ukazujú čitateľom z synonymných výrazov na výrazy, ktoré preferujete používať a indexovať vo svojej knihe.
  9. Skontrolujte štýl a mechaniku indexových položiek. Organizácia, pre ktorú pracujete, môže mať svoj vlastný štýlový manuál alebo vás môže odkázať na nejaký štandardný štýl, ako napríklad Chicago manuál stylu. Pozrite sa na tieto veľmi pozorne, ako vás upozorňujú na veľké písmená a interpunkciu pri zápise do indexu. Indexy bežne používajú malé písmená pre všetky nevlastné podstatné mená, ale určité percento používa veľké písmená pre prvú úroveň položiek. Väčšina štýlov vás má naučiť dať čiarku hneď za termínom v indexe a pred číslami strán; ale niektoré to nemajú. Niektoré štýly vyžadujú, aby ste použili rovnaké zvýraznenie v indexe, ako to robíte v hlavnom texte. Ak je niečo tučné v hlavnom texte, chcú, aby to bolo tučné aj v indexe.

    Poznámka: Táto kapitola používa rôzne štýly interpunkcie a veľkých písmen—nie preto, aby vás zmätla, ale aby vás upozornila na stylistickú variabilitu.

    Jednoduchý štýl indexu Ďalší bežný štýl indexu
    projektory, 123

    kompilácia, 154-155

    úvahy, 156

    ovládania, 136

    definované, 124, 136, 157

    profil projektov, 451-461

    		projektory

    kompilácia 154-155

    úvahy 156

    ovládanie 136

    definované 124, 136, 157

    Profil projektov 451-461


    Všimnite si v pravom príklade, že medzi indexovým termínom a číslami strán nie je čiarka. Tiež zistíte, že niektoré štandardy a štýly indexovania nesúhlasia s tým, aby odkaz na stránku bol v indexovom zázname, ktorý má podzáznamy: napríklad „projektory, 123“ v ľavom príklade. Prečo nie je odkaz na stránku 123 medzi podzáznamami? Aká je vlastne podtéma na stránke 123?

Oceňujem vaše myšlienky, reakcie, kritiku týkajúce sa tejto kapitoly: vaša odpoveď.