Tekstiloome nõuded

Maa- ja Ruumiameti digiteenuste keskkonna sõnastused toetavad kasutajat e-teenuste kasutamisel. Menüüde, nuppude, linkide, selgituste jm lihtne ja arusaadav keelekasutus on keskkonna loogiline osa. Kasutaja ei pea üldjuhul abi saamiseks juhendeid lugema või konsultatsiooni kasutama.

Nõuded tekstide koostamisele on oluline igasuguse sisu arvestamisel, mis avaldatakse otseses seoses meie digiteenustega. Sealhulgas teenuse keskkonnas, kasutajajuhendite veebilehel, giidides, trükimaterjalides, videodes kasutatav sõnakasutus, koolitusmaterjalid jne.

VEERA: https://veera.eesti.ee/08be8a71e/p/10482b-keelekasutus-ja-tekstide-kirjutamise-uldpohimotted 

TEDI: https://tedi.tehik.ee/1ee8444b7/p/987f47-kirjutamispohimotted 

MaRu digiteenused on iseteeninduskeskkonnad, kus ei käsitleta ülitundlikke teemasid (tervis, eraelu teemad vms) ning mida kasutavad suures osas professionaalsed kasutajad ja menetlejad. Seetõttu kasutame keskkondades sina-vormi. (https://veera.eesti.ee/08be8a71e/p/10482b-keelekasutus-ja-tekstide-kirjutamise-uldpohimotted) 

1. Keskkonna suhtlusstiil on riigile omaselt asjalik ja korrektne, kuid samas sõbralik, toetav ja julgustav.

2. Keskkonna keelekasutus järgib õigekirjareegleid

3. Väldime kantseliidivaba (ütleme "lahendasime", mitte "lahendatud sai")

4. Väldime erialast žargooni vaba (näiteks ütleme „maja number“, mitte „aadressinumber“; ei kasuta sõnu "tarne", "kasutjaaliides")

5. Kasutajaga suhtlemisel kasutame Sina vormi, nt “Aadress on aegunud, palun lisa uus aadress!”

6. Sõnastused on koostatud kliendi vaatest lähtuvalt, nt “Minu andmed / taotlused / ehitised”, mitte “Teie andmed”.

7. Kasutame läbivalt ühtseid ja korrektseid termineid, nt “EHR” või "ehitisregister", mitte “ehitiste register” vmt.

8. Väldime umbisikulist tegumoodi ning kolmandas isikus pöördumist, nt „Tallinna Linnaplaneerimise Amet on taotluse menetlusse võtnud“ või „Kohalik omavalitus võttis taotluse menetlusse“, mitte „Taotlus on menetlusse võetud.“

9. Väldime nominaalstiili (näiteks "palun logi sisse, et tagasisidet anda", mitte "tagasiside andmiseks peate olema sisse logitud")

10. Võimalusel väldime võõrsõnu ja lühendeid. Lühendeid kasutame vaid juhul, kui need antud kontekstis üheselt ja selgelt mõistetavad (näiteks EHR).

11. Pealkirjad lõpevad ilma kirjavahemärgita, tekstivälja pealkirja järel koolonit ei märgi, teenuse pealkirja järel ei kasuta punkti.

Teated on selgelt sõnastatud ja piisavalt täpselt kirjeldavad olukorda. Näiteks:

„Neljapäeval, 17.03.2016 kell 18.00–18.30 toimub seoses tehniliste hooldustöödega katkestus e-ehituse keskkonna teenuste kasutamises. Vabandame.“

„Neljapäeval, 3. märtsil 2016 kell 7.00–9.00 toimub seoses versiooniuuendusega Andmete esitamise teatise koostamise ja esitamise teenuste töös katkestus. Vabandame võimalike ebamugavuste pärast.“

Süsteemiüleseid teavitusi ei tohi korraga aktiivseid olla rohkem, kui kaks. Süsteemiülestesse teavitustesse EI LISATA uudiseid ja juhendeid. Sinna lisatakse AINULT hoiatusi ja veakuulutusi. Kui on erakorraline positiivne uudis, siis see on lubatud. Süsteemiülese teavituse ülekasutamine harjutab lehe vaataja nii ära, et kui on päriselt vaj ainfot jagada, siis sed keegi enam ei märka.

Süsteemiülese teate tekst peab olema lühike. Soovitavalt piirduda kahe/kolme reaga.

Väike soovitustega juhend globaalsete teavituste kohta: https://www.designsystem.qld.gov.au/components/alerts-global . Seal ka näiteid, et kunas seda komponenti kasutada ja kunas mitte.

Digiteenuste näol on tegemist iseteeninduskeskkonnaga, kus üldjuhul otsustab kasutaja ise, millise tegevuse ta valib ja teeb. Selliste tegevuste sõnastused on nuppudel ja linkidel mina-vormis.

Näiteks: Salvestan, Esitan, Saadan, Kustutan, Muudan, Laadin alla, Trükin, Valin vormi.

Vajadusel võib kasutada ka järgmisi sõnastusi:

• Tegevused, mis viivad teisele teenusele või avavad uue toimingu. Näiteks: Uus kasutaja, Uus hooneosa, Uus märkus

• Tegevused, mis on pigem süsteemsed, ja mille sõnastamiseks on välja kujunenud ühene kasutuspraktika. Näiteks: Otsing, Vali, Märgi, Jäta mu valik meelde, Edasi, Tagasi (taotluse juurde)

Kasutajale tuleb teha kättesaadavaks abiinfo ja juhendmaterjalid

Kasutajajuhend sisaldab teenuse kohta käivaid abistavaid materjale, mis aitavad kasutajal täita vorme, mõista erinevaid toimimisloogikaid ning teha paremaid ja informeeritumaid otsuseid. Kasutajajuhendi koostamisel väldime seaduste ümberkirjutamist. Tekstid on hästi liigendatud, pikemas tekstis kasutame sisu kokku võtvaid vahepealkirju. Materjalid võivad olla esitatud ka videojuhenditena, skeemide või illustratsioonidena.

Veateade:

1. peab olema viisakalt, positiivselt sõnastatud (näiteks „Palun sisesta oma e-posti aadress“, mitte „E-posti aadress sisestamata!“);

2. ütlema probleemi põhjuse ja viitama, mille kohta see veateade käib (näiteks „Sisestatud kasutajanimi ja parool ei sobi kokku“, mitte „Sisselogimine ebaõnnestus“);

3. peab selgitama kasutajale, kuidas ta saab probleemi lahendada (näiteks „Köetav pind ei saa olla suurem kui suletud netopind“, mitte „Pindade suurused ei ühti!“ ja näiteks „Selle nimega fail juba eksisteerib“, mitte „Faili nimi on vigane“);

4. vajadusel soovitab kasutajale, kust ta saab täiendavat informatsiooni;

5. peab olema tavakasutajale / tehnilisi teadmisi mitteomavale inimesele arusaadavalt sõnastatud;

6. ei sisalda ballasti (näiteks „Köetav pind ei saa olla suurem kui suletud netopind“, mitte „Ups! Paistab, et köetava pinna suurus on rohkem kui suletud netopind. Palun paranda ära.“)

7. kui on kohane, annab kasutajale võimaluse kohe probleem lahendada (näiteks „Selle nimega fail juba eksisteerib. Kas soovid a) automaatselt uue faili ümber nimetada; b) muuta selle nime käsitsi“, mitte „Faili nimi on vigane“).

VEERA:

• https://veera.eesti.ee/08be8a71e/p/396bcf-pisitekstide-kirjutamine

• https://veera.eesti.ee/08be8a71e/p/60186a-vihjemullid-tooltips 

Pisiteksti vormistamine, pikkuse otsustamine jms näpunäiteid laiast maailmast:

• https://www.nngroup.com/articles/tooltip-guidelines/

• https://userpilot.com/blog/tooltip-best-practices/

• https://m2.material.io/components/tooltips