Pisanje navodil po korakih

Naslednje smernice pomagajo ustvariti jasna, sledljiva navodila – od preprostih enokorakovnih do zapletenih večkorakovnih.

Glej tudi: Oblikovanje besedila v navodilih, Opisovanje interakcij z vmesnikom

Zapletena navodila oblikujte kot oštevilčen seznam:

• Oblikujte jih dosledno, da jih bralec najde s preletavanjem.
• Dodajte naslov, ki pove, pri čem navodila pomagajo.
• Vsak korak naj bo ločena oštevilčena postavka; kratke korake na istem mestu v vmesniku lahko združite.
• Vključite tudi zaključno dejanje (npr. gumb V redu ali Uporabi).
• Uporabljajte cele povedi in velelnik 2. osebe množine (»Izberite …«, »Vnesite …«).
• Ohranjajte dosledno zgradbo: kadar je treba povedati, kje bralec začne, uvedite korak s predložno zvezo, sicer začnite z glagolom.
• Prva beseda koraka se piše z veliko začetnico, za korakom sledi pika.
• Postopek omejite na največ sedem korakov, po možnosti manj.

Izjema pri piki: kadar korak zahteva uporabnikov vnos brez končnega ločila, pike ne dodajte in vnos po možnosti postavite v novo vrstico.

Za enokorakovno navodilo uporabite enako obliko kot za večkorakovna, le da številko nadomestite z alinejo.

• Preden opišete dejanje, naj bo jasno, kje naj se zgodi. Če se navodilo pojavi v istem vmesniku, kjer se dejanje zgodi, lokacija pogosto ni potrebna.
• Če je nevarnost zmede, dodajte uvodni korak ali kratko predložno zvezo: »Na zavihku Načrt …«.

Zaporedne korake po isti poti lahko skrajšate z znakom >. Pred znakom in za njim je presledek; znak ni krepek.

Dostopnost: bralniki zaslona lahko znak »>« preskočijo in navodilo preberejo kot nepovezano zaporedje besed. Pri pomembnih navodilih raje napišite polne korake ali se posvetujte s strokovnjakom za dostopnost. Glej Pisanje za vse uporabnike.

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.