Språklig stilguide

Mål

Användarfokuserad

Handboken ska hållas begriplig för nykomlingar till videoredigering.

Fullständig

Alla funktioner, alternativ och verktyg i Kdenlive ska beskrivas. Handboken ska ge information om vad en funktion är, dess syfte och hur den ska användas.

Koncis

Håll texten kort och koncis och relevant för det ämne som beskrivs.

Underhållbar

Skriv innehåll som inte behöver göras om i samma ögonblick som någon liten ändring görs i Kdenlive.

Riktlinjer

Innehåll

  • Använd amerikansk engelska (t.ex. modeling och inte modelling, color och inte colour) även för att formatera siffror (t.ex.: 2,718.28 och inte 2 718,28).

  • Använd stavningskontroll

  • Var noga med grammatik, lämpliga formuleringar och använd enkel engelska.

  • Tänk på vad som kan vara intressant för en videoredigerare.

  • Beskriv generellt och inte på djupet, så att dokumentationen inte behöver anpassas för varje ny version av Kdenlive.

  • Beskriv inte fel, inget verkligt tillstånd.

  • Inkludera varför eller hur ett alternativ kan vara användbart. Exempel Fördelar med sekvenser.

  • Om du är osäker på hur en funktion beter sig, fråga någon annan eller ta reda på vem som har utvecklat den och fråga dem.

  • Det går att lägga till en kommentar (som inte visas på HTML-sidan, men är användbar för andra redaktörer): .. TODO, How to choose the correct output format and bit rate? Ask advanced user.

Stil

  • Håll meningar korta och tydliga, använd verb och färre substantiv. Det resulterar i text som är lättläst, objektiv och rakt på sak. Tumregel (men inte bara!): 20 ord eller 120 bokstäver per mening.

  • Var specifik: Skriv inte input device när mouse avses.

  • Var underhållande: Varje mening ska beskriva något nytt.

  • Använd fetstil för markering: Program names

  • Använd kursiv text för att betona: Ord eller meningar som i allmän skrift, Titlar när andra verk refereras, Första användningen av ett obekant ord

  • Kombinerad fetstil och kursiv text: I restructured text är det endast möjligt med ytterligare kod.

Placera en definition först
Sequence
Using sequences you can make your project clearer.

bättre

Sequence
A sequence is basically a timeline.

Förklara sedan vad den gör och hur den kan användas. Exempel: Sekvens

Undvik omedelbar upprepning av termen
The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

bättre

The Properties Tab
The settings for the effects on the currently selected clip are shown the properties tab.
Undvik “it is”
Binarize
It is an effect to make he image black and white.

bättre

Binarize
Creates a black and white image.

Bilder

Endats .. figure:: ska användas för att placera bilder.

Använd inte taggen :alt:. Skriptet gettext extraherar den vilket skapar onödigt översättningsarbete.

Använd mörkt tema i Kdenlive för skärmbilder.

Använd .webp för bilder.

Använd animerade .gif eller .mp4 filer om det förklarar funktionen/uppgiften bättre.

Konvention för bildnamn: [delkapitel]-<funktionsnamn>-(4-siffrors Kdenlive-version).webp

Exempel:

  • configure-speech2text_vosk_drag-2412.webp

  • rendering-render_dialog-2403.webp

  • project_bin-create_animation-2208.webp

Try to avoid having a lot of images. Use a single image that shows all of the relevant areas placed at the top of the section. Numbering the features and then explain the features in that order. Like this example.

Ytterligare information

Ta en titt på mallen om hur rst-kommandon används.