Navodila po korakih

Najboljše navodilo je tisto, ki ni potrebno. Če je vmesnik dovolj jasen in bralca sam vodi skozi opravilo, navodila ne pišite – to naj bo prva izbira. Kadar je opravilo zapleteno, poiščite najjasnejši način: sliko, kratko enostavčno navodilo ali oštevilčen postopek.

• Pisanje navodil po korakih – zgradba preprostih in zapletenih postopkov.
• Opisovanje interakcij z vmesnikom – vhodno nevtralni glagoli (»izberite« namesto »kliknite«).
• Opisovanje alternativnih načinov vnosa – miška, tipkovnica, dotik, pero, krmilnik.
• Oblikovanje besedila v navodilih – konvencije za elemente vmesnika.
• Ponazarjanje omrežnega prometa – grafični prikaz tokov.

V navodilih uporabljajte velelnik 2. osebe množine (vikanje): »Kliknite«, »Izberite«, »Vnesite«. Za dokončana dejanja izberite dovršni glagol (»shranite«, »namestite«). Glej Nagovor bralca in Glagoli.

Za podporo vsem uporabnikom dokumentirajte vse podprte načine interakcije (miška, tipkovnica, govor, dotik). Najlažje je najprej opisati vsak način posebej, nato pa postopke pisati z vhodno nevtralnimi glagoli. Glej Dostopnost.

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.