Guida allo stile di scrittura

Obiettivi

Orientato all’utente

Il manuale deve essere mantenuto comprensibile dai principianti al montaggio video.

Completo

Devi descrivere tutte le funzionalità, le opzioni e gli strumenti di Kdenlive. Il manuale dovrebbe fornire le informazioni sulla natura di ciascuna funzionalità, sul suo scopo, e su come utilizzarla.

Conciso

Mantieni il testo breve, conciso e pertinente all’argomento che descrivi.

Manutenibile

Scrivi i contenuti che non debbano essere rifatti ad ogni piccola modifica in Kdenlive.

Linee guida

Contenuto

  • Usa l’inglese americano (ad esempio: modeling e non modelling, color e non colour) anche per la formattazione dei numeri (ad esempio: 2,718.28 e non 2 718,28).

  • Utilizza il controllo ortografico.

  • Fai attenzione alla grammatica, alla formulazione appropriata e usa un inglese semplice.

  • Pensa a cosa potrebbe essere interessante per un editor video.

  • Descrivilo in linea generale, senza entrare troppo nei dettagli: in questo modo la documentazione non sarà da aggiornare ad ogni nuova versione di Kdenlive.

  • Non descrivere i bug, né lo stato effettivo.

  • Compreso il motivo o il modo in cui un’opzione potrebbe rivelarsi utile. Ad esempio Vantaggi delle sequenze.

  • Se non sei sicuro sul funzionamento di una determinata funzionalità, chiedi a qualcuno, oppure scopri chi l’ha sviluppata e chiedilo a loro.

  • Puoi aggiungere un commento (che non viene visualizzato nella pagina HTML, ma è utile agli altri redattori): .. TODO, Come scegliere il formato di output e il bit rate corretti? Chiedere a un utente esperto.

Stile

  • Scrivi frasi brevi e chiare, usa verbi e meno sostantivi. In questo modo otterrai un testo di facile lettura, obiettivo e conciso. Regola generale (ma non l’unica!): 20 parole o 120 lettere per frase.

  • Sii preciso: non scrivere dispositivo di input de intendi il mouse.

  • Sii divertente: ogni frase descrive qualcosa di nuovo.

  • Usa il testo in grassetto per evidenziare: nomi dei programmi

  • Utilizza il corsivo per evidenziare: le parole o frasi nella scrittura generale, i titoli quando fai riferimento ad altri lavori, il primo utilizzo di una parola poco conosciuta

  • Testo in grassetto e corsivo combinati: nel testo ristrutturato questo è possibile solo con l’aggiunta di codice aggiuntivo.

Mettere prima una definizione
Sequence
Using sequences you can make your project clearer.

migliore

Sequence
A sequence is basically a timeline.

Poi spiega a cosa serve, e come si usa. Esempio: Sequenza

Evitare la ripetizione immediata del termine
The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

migliore

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

migliore

Binarize
Creates a black and white image.

Immagini

Per inserire le immagini devi utilizzare esclusivamente .. figure::.

Non usare l’etichetta :alt:: lo script di gettext lo estrarrà, e ciò crea del lavoro di traduzione non necessario.

Quando fai delle schermate, utilizza il tema scuro di Kdenlive.

Usa .webp per le immagini.

Usa dei file animati .gif o .mp4 se spiegano meglio una funzionalità o un compito.

Convenzione sui nomi delle immagini:: [sotto_capitolo]-<feature_name>-(versione di Kdenlive a 4 cifre).webp

Esempio:

  • configure-speech2text_vosk_drag-2412.webp

  • rendering-render_dialog-2403.webp

  • project_bin-create_animation-2208.webp

Cerca di evitare di inserire troppe immagini. Utilizza un’unica immagine che mostri tutte le aree rilevanti, posizionandola nella parte superiore della sezione. Numera gli elementi, poi descrivili in quell’ordine. Come in questo esempio.

Ulteriori informazioni

Consulta il modello per sapere come utilizzare i comandi rst.