Vodnik za slog pisanja

Cilji

Osredotočeno na uporabnika

Priročnik mora biti razumljiv tudi začetnikom pri montaži videoposnetkov.

Dokončaj

Opisati je treba vse funkcije, možnosti in orodja Kdenlive. Priročnik mora vsebovati informacije o tem, kaj je funkcija, kakšen je njen namen in kako jo uporabljati.

Zgoščeno

Besedilo naj bo kratko in jedrnato ter naj ustreza opisani temi.

Enostavno za vzdrževanje

Napišite vsebino, ki je ne bo treba predelati v trenutku, ko bo v Kdenlive prišlo do manjše spremembe.

Smernice

Vsebina

  • Uporabljajte ameriško angleščino (npr.: modeling in ne modelling, color in ne colour) tudi za oblikovanje številk (npr.: 2 718,28 in ne 2 718,28).

  • Uporabite preverjanje črkovanja.

  • Poskrbite za slovnico, ustrezno ubeseditev in uporabljajte preprosto angleščino.

  • Pomislite, kaj bi lahko bilo zanimivo za montažerja videoposnetkov.

  • Opišite na splošno in ne poglobljeno, da vam ne bo treba prilagajati dokumentacije z vsako novo izdajo Kdenlive.

  • Ne opisujte napak in hroščev, ni dejanskega stanja.

  • Navedite, zakaj ali kako bi lahko bila možnost koristna. Primer: Prednosti zaporedij.

  • Če niste prepričani, kako funkcija deluje, vprašajte koga drugega ali poiščite razvijalca funkcije in ga vprašajte.

  • Dodate lahko komentar (ki ni prikazan na strani HTML, vendar je koristen za druge urednike): .. TODO: Kako izbrati pravilen izhodni format in bitno hitrost? Vprašajte naprednega uporabnika.`

Slog

  • Stavki naj bodo kratki in jasni, uporabljajte glagole in manj samostalnikov. Besedilo je lahko berljivo, objektivno in jedrnato. Pravilo (vendar ne edino!): 20 besed ali 120 črk na stavek.

  • Bodite natančni: Ne pišite vhodna naprava, če imate v mislih miška.

  • Bodite zabavni: Vsak stavek opisuje nekaj novega.

  • Uporabite krepko besedilo za poudarjanje: Nazivi programov

  • Za poudarjanje uporabljajte poševno besedilo: besede in fraze kot v običajnem besedilu, **naslove pri sklicevanju na druga dela*, prvo uporabo neznane besede

  • Kombinirano krepko in poševno besedilo: Pri prestrukturiranem besedilu je to mogoče le z dodatno kodo.

Postavljanje definicije na začetek
Sequence
Using sequences you can make your project clearer.

bolje

Sequence
A sequence is basically a timeline.

Nato razložite, kaj počne in kako ga lahko uporabite. Primer: Zaporedje

Izogibanje takojšnjemu ponavljanju izraza
The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

bolje

The Properties Tab
The settings for the effects on the currently selected clip are shown the properties tab.
izogibajte se rabi pasiva (»it is«)
Binarize
It is an effect to make he image black and white.

bolje

Binarize
Creates a black and white image.

Slike

Za postavitev slik lahko uporabite samo ukaz .. figure::.

Pri ustvarjanju posnetkov zaslona uporabite temno temo Kdenlive.

Za slike uporabite zapis .webp.

Uporabite animirane datoteke .gif ali .mp4, če to bolje pojasnjuje funkcijo/nalogo.

Poskusite se izogniti velikemu številu slik. Uporabite eno samo sliko, ki prikazuje vsa pomembna področja in je nameščena na vrhu razdelka. Funkcije oštevilčite in jih nato razložite v tem vrstnem redu. Kot v tem primeru.

Dodatni podatki

V predlogi preverite, kako uporabljati ukaze rst.