Guia d'estil d'escriptura

Objectius

Centre en els usuaris

El manual ha de ser comprensible pels principiants a l'edició de vídeo.

Complet

S'han de descriure totes les característiques, opcions i eines del Kdenlive. El manual ha de proporcionar informació sobre què és una característica, el seu propòsit i com utilitzar-la.

Concís

Manteniu el text curt i concís i rellevant per al tema que descriviu.

Que es pugui mantenir

Escriviu el contingut que no s'hagi de refer en el moment en què es faci algun canvi petit en el Kdenlive.

Directrius

Contingut

  • Utilitzeu l'anglès americà (p. ex.: «modeling» i no «modelling», «color» i no «colour») també per a formatar els nombres (p. ex. 2,718.28 i no 2 718,28).

  • Utilitzeu la verificació ortogràfica.

  • Aneu amb compte amb la gramàtica, la redacció adequada i utilitzeu un anglès senzill.

  • Penseu en el que podria ser interessant per a un editor de vídeo.

  • Descriviu en general i no en profunditat, de manera que no haureu d'adaptar la documentació amb cada versió nova del Kdenlive.

  • No descrigueu els errors, ni l'estat real.

  • Incloeu per què o com pot ser útil una opció. Exemple Avantatge d'una seqüència.

  • Si no esteu segur/a de com funciona una característica, pregunteu a algú altre o esbrineu qui la va desenvolupar i pregunteu-li.

  • Podeu afegir un comentari (que no es mostra a la pàgina HTML, però és útil per a altres editors): .. TODO: Com triar el format de sortida correcte i la taxa de bits? Pregunteu a un usuari avançat.

Estil

  • Manteniu les frases curtes i clares, utilitzeu verbs i menys substantius. El resultat serà un text fàcil de llegir, objectiu i concret. Una regla general (però no només!): 20 paraules o 120 lletres per frase.

  • Específic: no escriviu el dispositiu d'entrada quan voleu dir el ratolí.

  • Ser entretingut: cada frase descriu una cosa nova.

  • Utilitzeu el text en negreta per a ressaltar: Noms de programa

  • Utilitzeu el text en cursiva per a emfatitzar: Paraules o frases com en l'escriptura general, Títols quan fan referència a altres obres, El primer ús d'una paraula desconeguda

  • Text combinat en negreta i cursiva: en el ReStructuredText això només és possible amb codi addicional.

Posar primer una definició
Sequence
Using sequences you can make your project clearer.

millor

Sequence
A sequence is basically a timeline.

Llavors expliqueu el que fa i com es pot utilitzar. Exemple: Seqüència

Eviteu la repetició immediata del terme
The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

millor

The Properties Tab
The settings for the effects on the currently selected clip are shown the properties tab.
Eviteu l'«això és»
Binarize
It is an effect to make he image black and white.

millor

Binarize
Creates a black and white image.

Imatges

Només s'ha d'utilitzar .. figure:: per a situar les imatges.

Utilitzeu el tema fosc Kdenlive en fer captures de pantalla.

Utilitzeu «.webp» per a les imatges.

Utilitzeu fitxers animats «.gif» o «.mp4» si això explica millor la característica/tasca.

Eviteu tenir moltes imatges. Utilitzeu una sola imatge que mostri totes les àrees rellevants col·locades a la part superior de la secció. Numereu les característiques i després expliqueu-les en aquest ordre. Com aquest exemple.

Informació addicional

Reviseu la plantilla per a com emprar les ordres «rst».