Gids voor schrijfstijl¶
Doelstellingen¶
- Gericht op de gebruiker
De handleiding moet begrijpbaar blijven voor beginners in videobewerken.
- Voltooid
Alle mogelijkheden, opties en hulpmiddelen van Kdenlive zouden beschreven moeten zijn. De handleiding zou informatie moeten leveren over wat een mogelijkheid is, het doel en hoe het te gebruiken.
- Beknopt
Houd de tekst kort en precies en relevant voor het onderwerp dat u beschrijft.
- Onderhoudbaar
Schrijf inhoud die niet opnieuw gedaan hoedt te worden op het moment dat enige kleine wijzigingen in Kdenlive worden gedaan.
Richtlijnen¶
Inhoud¶
Gebruik Amerikaans Engels (bijv: modeling en niet modelling, color en niet colour) ook voor formattering van getallen (bijv: 2,718.28 en niet 2 718,28).
Spellingcontrole gebruiken.
Let op de grammatica, juiste verwoording en gebruik eenvoudig Engels.
Bedenk wat interessant kan zijn voor een videobewerker.
Beschrijf in het algemeen en niet in volledige diepte, zodat u de documentatie niet hoeft aan te passen met elke nieuwe versie van Kdenlive.
Beschrijf geen bugs, geen actuele status.
Inclusief waarom of hoe een optie nuttig kan zijn. Voorbeeld Voordeel van sequentie.
Als u niet zeker weet hoe een functie werkt, vraag het iemand anders of zoek uit wie het heeft ontwikkelaard en vraag het hen.
U kunt commentaar toevoegen (die niet getoond wordt in de HTML pagina, maar nuttig is voor andere editors):
.. TODO, Hoe het juiste uitvoerformaat en bitsnelheid kiezen? Vraag het aan de geavanceerde gebruiker.
Stijl¶
Houd zinnen kort en helder, gebruik werkwoorden en minder zelfstandige naamwoorden. dit resulteert in tekst die gemakkelijk is te lezen, objectief is en ter zake. Vuistregel (maar niet alleen!): 20 woorden of 120 letters per zin.
Wees specifiek: schrijf niet invoerapparaat wanneer u de muis bedoelt.
Wees onderhoudend: elke zin beschrijft iets nieuws
Gebruik vette tekst om iets te accentueren: Programmanamen
Gebruik cursieve tekst om iets te benadrukken: woorden of frasen zoals in algemeen schrijven, Titels bij refereren aan ander werk, Het eerst gebruik van een niet bekend woord
Gecombineerde vette en cursieve tekst: in gestructureerde tekst is dit alleen mogelijke met additionele code.
- Een definitie eerst opschrijven
Sequence Using sequences you can make your project clearer.
beter
Sequence A sequence is basically a timeline.
Daarna uitleggen wat het doet en hoe u het kan gebruiken. Voorbeeld: Sequentie
- Vermijden van het onmiddellijk herhalen van de term
The Properties Tab The Properties Tab displays the settings for the effects on the currently selected clip.
beter
The Properties Tab The settings for the effects on the currently selected clip are shown the properties tab.
- Vermijden van het “het is”
Binarize It is an effect to make he image black and white.
beter
Binarize Creates a black and white image.
Afbeeldingen¶
Alleen .. figuur:: zou gebruikt moeten worden om afbeeldingen te plaatsen.
Gebruik het donkere thema van Kdenlive bij maken van schermafdrukken.
Gebruik .webp voor afbeeldingen.
Gebruik geanimeerd .gif of .mp4 bestanden als dat de functie/taak beter uitlegt.
Probeer het hebben van veel afbeeldingen te vermijden. Gebruik een enkele afbeelding die alles toont over de relevante gebieden geplaatst bovenaan de sectie. Nummer de functies en leg de functies daarna uit in die volgorde. Zoals dit voorbeeld.
Meer informatie¶
Bekijk het sjabloon voor hoe de rst-commando’s te gebruiken.