Guía de estilo de escritura¶

Objetivos¶

Centrada en el usuario: El manual deberá mantenerse entendible para los novatos en la edición de video.
Completa: Todas las características, opciones y herramientas de Kdenlive deberían estar descriptas. El manual deberá proporcional información sobre la naturaleza de la característica, su propósito y su forma de uso.
Concisa: Se deberán mantener textos breves, concisos y relevantes para el tópico descripto.
Mantenible: Escribir contenido que no necesite ser reescrito cuando se produzca un pequeño cambio en Kdenlive.

Lineamientos¶

Contenido¶

Usar un español neutro (es decir, evitar localismos y utilizar el término más ampliamente usado para cada cosa), formatear los números sin puntos para los miles y con coma decimal (p.ej: 2718,28 y no 2.718,28 o 2,718.28).
Usar corrector ortográfico.
Preocuparse de la gramática, un fraseo apropiado y usar un lenguaje sencillo.
Pensar en qué cosas podrían resultar interesantes a un editor de video.
Realizar las descripciones en términos generales y no detalladamente, para que no sea necesario adaptar la documentación con cada nueva versión de Kdenlive.
No describir errores, no es necesario.
Incluir las razones y de qué manera una opción puede resultar útil. Ejemplo: Ventajas de las secuencias.
Si no se está seguro acerca del funcionamiento de una característica, consultar a alguien más o buscar a quien la hubiera desarrollado para consultarlo al respecto.
Será posible agregar un comentario (que no será mostrado en la página HTML a los usuarios, pero que podrá resultar útil a otros editores): .. POR HACER, ¿Cómo escoger el formato correcto de salida y la tasa de bits? Consultar a un usuario avanzado.

Estilo¶

Mantener las oraciones cortas y claras, usar verbos en infinitivo cuando sea posible, para evitar un tratamiento específico de tú/vos/usted. Todo esto producirá textos más sencillos de leer en una mayor variedad de localidades alrededor del mundo. También deberán mantenerse un estilo objetivo y certero. La regla de oro (aunque no la única): 25 palabras o menos o 150 letras por oración.
Ser específico: No escribir, por ejemplo, dispositivo de entrada cuando lo que se quiere es referirse a un ratón.
Ser entretenido: Que cada oración describa algo nuevo.
Usar texto en negrita para destacar: Nombres de programas
Usar texto en cursiva para enfatizar: Palabras o frases, tal como se estila en la escritura normal, Títulos, al hacer referencia a otros trabajos, El primer uso de una palabra poco familiar
Texto combinado en negrita y cursiva: En testo de restructured esto sólo será posible mediante código adicional.

Primero colocar una definición

Sequence
Using sequences you can make your project clearer.

mejor

Sequence
A sequence is basically a timeline.

Luego, explicar lo que hace y cómo será posible usarlo. Ejemplo: Secuencia

Evitar una repetición inmediata del término

The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

mejor

The Properties Tab
The settings for the effects on the currently selected clip are shown the properties tab.

Evitar la construcción “Es un/una”

Binarize
It is an effect to make he image black and white.

mejor

Binarize
Creates a black and white image.

Imágenes¶

Sólo se debería usar .. figure:: para colocar imágenes.

Usar el tema oscuro de Kdenlive al crear capturas de pantalla.

Usar el formaro .webp para imágenes.

Usar archivos .gif animado o .mp4 cuando eso permita explicar mejor una característica o tarea de una mejor manera.

Intentar evitar usar muchas imágenes. En lo posible, usar una única imagen que muestre todas las áreas relevantes, al inicio de la sección. Numerar las características y luego explicarlas en ése orden. Como en este ejemplo.

Información adicional¶

Revisar la plantilla para aprender la forma de usar los comandos rst.