Oblikovanje besedila v navodilih
Dosledno oblikovanje pomaga bralcu najti in razumeti informacije. Splošno načelo: opišite dejanje, ne elementa vmesnika; kadar je sklic po imenu nujen, ime elementa zapišite krepko s stavčno rabo velikih začetnic (velika le prva beseda). Vrsto elementa (»gumb«, »meni«, »pogovorno okno«) navedite le, če prispeva k jasnosti.
Glej tudi: Opisovanje interakcij z vmesnikom, Velika in mala začetnica, Oblikovanje pogostih elementov
Konvencije za elemente
| Element | Oblika | Primer |
|---|---|---|
| Gumbi, možnosti, potrditvena polja | krepko, stavčna začetnica, brez končnega ločila | Izberite Shrani kot. |
| Meniji in zavihki | krepko; raje opišite dejanje | Na zavihku Načrt izberite Barve. |
| Pogovorna okna | krepko ime, kadar je nujno; sicer opišite dejanje | Izberite Naloži in nato datoteko. |
| Ukazi (ukazna vrstica) | krepko, vse z malo | copy |
| Stikala/možnosti ukazov | krepko, natanko kot se vtipkajo | /a, /Aw |
| Imena tipk in kombinacije | po dejanski oznaki, krepko; brez presledkov okoli plusa | Ctrl+Alt+Del |
| Imena datotek in map (vzorčna) | kot dejansko ime; krepko, kadar bralec izbira ali vnaša | Izberite Dokumenti. |
| Pripone datotek | vse z malo, s piko | .pdf, .docx |
| Sporočila o napakah | stavčna začetnica; v besedilu v narekovajih | »Optičnega bralnika ni mogoče najti.« |
| Nizi / uporabnikov vnos | v narekovajih ali krepko; velikost črk ohranite, kadar je pomembna | Vnesite hello world. |
| Ograde (nadomestki) | ležeče | Vnesite geslo. |
| Novi izrazi (ob prvi rabi) | ležeče, takoj pojasnjeno | Storitev ima strežniški in odjemalski del. |
| Imena izdelkov in blagovnih znamk | kot uradni zapis | Windows, Visual Studio Code |
| Oznake (HTML/XML) | krepko | <img> |
| Matematične spremenljivke | ležeče | a + b = c |
| Naslovi URL | vse z malo; prelom pred poševnico, ne z vezajem | example.com/prenosi |
Kratki koraki z »večje od«
Zaporedne korake po jasni poti lahko strnete z znakom >, obdanim s presledki (ni krepek): »Izberite Orodja > Jezik«. Za omejitve glede dostopnosti glej Pisanje navodil po korakih.
V vmesniku in nedokumentacijski vsebini
V samem vmesniku ter v blogih in trženjskem gradivu krepki in ležeči tisk uporabljajte zmerno. Izberite en pristop in ga dosledno uporabljajte:
| Pristop | Primer |
|---|---|
| dejanje brez sklica na oznako | Izberite skupino, ki ji želite dodeliti storitve. |
| besedna zveza, ki izpostavi ime | Storitve dodelite skupini za samo poslovne podatke. |
| krepki tisk | Storitve dodelite skupini Samo poslovni podatki. |
Slovenske posebnosti
- Ni naslovne rabe velikih začetnic v oznakah – velika le prva beseda (glej Velika in mala začetnica).
- Imena elementov v besedilu sklanjajte prek občnega jedra, kadar bi bila sklanjatev nejasna: »v pogovornem oknu Nastavitve«, »z gumbom Shrani«.
The White Knight Labs – Slovenski slogovni priročnik · avtor: Wolfgang van der Stille
Vsebina je izvirno napisana za slovenščino po Slovenskem pravopisu, SSKJ in Fran. Za zgradbo (razdelitev na razdelke) je vzet zgled dela Microsoft Writing Style Guide (© Microsoft Corporation, CC BY 4.0). Ta priročnik ni Microsoftov dokument in ni povezan z Microsoftom.