Stiilijuhiseid HTML-dokumentide toimetajatele
Andres Jaeger (Hannu Mallati juhiste ainetel)

Üldstruktuurist

HTML-dokumenti toimetades tuleks tekst jaotada mitmeks osaks mingite loogiliste struktuuride (peatükk, lõik) alusel. Mida väiksemateks üksusteks tekst jaotatakse seda kergem on teha allviiteid ja ääremärkusi, seda raskem aga kergestiloetavat ja selgestruktuurilist dokumenti.

Struktuuri kavandades tuleb arvestada ka seda, kellele see dokument on määratud. Algajate jaoks tuleks kasutada lihtsat ja selget hierarhilist puustruktuuri, milles eri peatükid ja lõigud on paigutatud nii, et dokumenti võib lugeda nagu tavalist raamatut. Kui aga käsitletavas aines endas on eristatav selge struktuur, siis on mõttekas dokument jaotada sellele vastavalt.

Asjatundjatele määratud tekst võib seevastu sisaldada rohkem viiteid teistele peatükkidele, pikematele definitsioonidele, aga ka viiteid dokumendist väljapoole. Vastava ainega mingilgi määral tuttavad inimesed on juba loonud teatava pildi eri osade asetusest ja nende omavahelistest seostest ning seda võib ära kasutada ka dokumendi struktureerimisel.

Dokumendi struktuuri aitab selgitada esilehekülg ehk tiitelleht, millel on suur selgesti eristatav pealkiri ja sisukord ning millele võiks paigutada ka täpsustavad teated dokumendi kohta (kas ametlik või mitteametlik, millal koostatud jne.).

Isikuandmed

Igale dokumendile tuleks lisada andmed selle koostaja kohta. Sageli muudetavate andmete korral tuleks märkida ka koostamise/uuendamise kuupäev ja tarbe korral veel dokumendi staatus (näiteks "mitteametlik"). Sellised andmed võib paigutada ka esileheküljele, kuid enemasti lisatakse need dokumendi lõppu.

Kindlasti kiirendavad lugemist ja vähendavad lugeja ajakulu viitamised eelnevale ja järgnevale hierarhilisele tasemele, aga ka sisukorrale (kui see on). Pikema dokumendi korral võiksid need olla nii alguses kui ka lõpus.

Kontekstivabadus

Kõigile kättesaadavate dokumentide korral tuleb arvestada sellega, et nendele võib kestahes ja kusttahes teha viiteid. Seetõttu tuleks sellised dokumendid koostada nii, et tekst ei oleks liiga tugevasti seotud mingi esitusjärjekorraga ning moodustaks terviku, mida moodulprogrammeerimise põhimõtteid järgides võiks kasutada muudeski seostes. Kasutades lauseid nagu "Eelmises peatükis käsitletud probleemi järel vaatleme nüüd ..." saab sellisel juhul korraldada sujuva ülemineku uuele teemale.

Pikemat seletamist vajavad põhiterminid tuleks vormistada kas eraldi dokumendina või nimega varustatud osana selles. Niimoodi toimides saab nendele vajaduse korral viidata mitmetest erinevatest tekstidest.

Pealkirja tekst peab olema täpne: näiteks pealkiri <TITLE>Probleemi valgustamine</TITLE> ei ütle midagu inimesele, kes ei ole jälginud kogu käsitlust.

Sõltumatus riist- ja tarkvarast

Dokumenti ei tohi mitte mingil juhul kavandada ainult selle järgi, millisena see paistab koostaja arvuti ekraanil. Üleliigsed reavahetused pealkirjade või lõikude järel võivad paista näitek erinevate süsteemide korral täiesti erinevalt. Sama kehtib ka mitmesuguste kujunduselementide ja -võtete kohta. HTML-dokumendi välisilme kavandamisel tuleb võimaluse korral arvestada selle seadmestiku ja programmidekomplektiga, mille abil teda vaadeldakse. Kui see aga pole võimalik (dokument on määratud laiale kasutajateringile), siis tuleks seda testida mitmel arvutil ja mitme erineva klientprogrammi abil (Netscape, Mosaic, Lynx).

Arvestada tuleb veel sellegagi, et dokument peab hästi välja nägema ka paberile trükituna.

Loetavus

Üldkasutatava dokumendi koostamisel ja/või toimetamisel tuleb tagada selle asjalik ja sorav esitus.

Loetavuse huvides tuleks vältida mittemidagiütlevaid väljendeid nagu näiteks "selle asja kohta saab andmeid siit". See nn here-sündroom esineb kahetsusväärselt sageli ameerika dokumentides.

Tehnilisi üksikasju ei tasu toonitada. Tuleb arvestada, et enamik dokumente peab loetav olema ka mitteprofessionaali poolt.


© Andres Jaeger (Hannu Mallati stiilijuhiste ainetel)
ajaeger@madli.ut.ee
Tartu Ülikooli arvutuskeskus