Guia de estilo de escrita

Objetivos

Focado no usuário

O manual deve ser escrito de forma que seja compreensível até mesmo para iniciantes em edição de vídeo.

Completo

Todas as funcionalidades, opções e ferramentas do Kdenlive devem ser descritas. O manual deve fornecer informações sobre o que é uma funcionalidade, sua finalidade e como usá-la.

Conciso

Mantenha o texto curto, conciso e relevante ao tópico que você descreve.

Sustentável

Escreva conteúdo que não precise ser refeito no momento em que alguma pequena alteração for feita no Kdenlive.

Diretrizes

Conteúdo

  • Use o inglês americano (por exemplo: modeling e não modelling, color e não colour) também para formatar números (por exemplo: 2,718,28 e não 2 718,28).

  • Use a verificação ortográfica.

  • Preste atenção à gramática, à escolha de palavras e use um inglês simples.

  • Pense no que poderia ser interessante para um editor de vídeo.

  • Descreva de forma geral e não em detalhes, para que você não precise adaptar a documentação a cada nova versão do Kdenlive.

  • Não descreva bugs, nem o estado atual do problema.

  • Incluir o porquê ou como uma opção pode ser útil. Exemplo: Vantagem da sequência.

  • Se você não tiver certeza de como uma funcionalidade funciona, pergunte a outra pessoa ou descubra quem a desenvolveu e pergunte a essa pessoa.

  • Você pode adicionar um comentário (que não é exibido na página HTML, mas é útil para outros editores): .. TODO, Como escolher o formato de saída e a taxa de bits corretos? Pergunte ao usuário avançado.

Estilo

  • Mantenha as frases curtas e claras, use verbos e menos substantivos. O resultado é um texto fácil de ler, objetivo e conciso. Regra geral (mas não a única!): 20 palavras ou 120 letras por frase.

  • Seja específico: Não escreva dispositivo de entrada quando quiser dizer mouse.

  • Seja interessante: Cada frase descreve algo novo.

  • Use negrito para destacar: Nomes dos programas

  • Use itálico para enfatizar: Palavras ou frases como na escrita em geral, Títulos ao fazer referência a outras obras, A primeira vez que uma palavra desconhecida é usada.

  • Texto em negrito e itálico combinados: Em textos reestruturados, isso só é possível com código adicional.

Primeiro, uma definição
Sequence
Using sequences you can make your project clearer.

melhor

Sequence
A sequence is basically a timeline.

Em seguida, explique o que faz e como você pode usá-lo. Exemplo: Sequência

Evite a repetição imediata do termo
The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

melhor

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

melhor

Binarize
Creates a black and white image.

Imagens

Somente .. figure:: deve ser usado para inserir imagens.

Não utilize a tag :alt:. O script gettext a extrai, o que gera trabalho de tradução desnecessário.

Use o tema escuro do Kdenlive ao fazer capturas de tela.

Use .webp para imagens.

Use arquivos animados .gif ou .mp4 se isso explicar melhor a funcionalidade/tarefa.

Convenção de nomenclatura de imagens: [sub_capítulo]-<nome_do_recurso>-(versão Kdenlive de 4 dígitos).webp

Exemplo:

  • configure-speech2text_vosk_drag-2412.webp

  • rendering-render_dialog-2403.webp

  • project_bin-create_animation-2208.webp

Tente evitar o uso de muitas imagens. Use uma única imagem que mostre todas as áreas relevantes, posicionada no topo da seção. Numere os recursos e explique-os nessa ordem. Como neste exemplo.

Informações adicionais

Verifique o modelo para saber como usar os comandos rst.