Portuguese (Brazil) Docs Translation / Documentação do Sponge em português do Brasil


#1

This is the official topic for the Portuguese (Brazil) Docs Translation.


Olá amigos e amigas

Se você está aqui é porque se interessou em ajudar a traduzir a documentação do Sponge. É uma tarefa nobre já que nossos esforços irão ajudar todos aqueles não entendem inglês. Além do mais, não é sempre que temos a chance de ver algo que gostamos em nossa língua, portanto, vamos abraçar esta oportunidade e dar aos falantes de nossa língua a melhor tradução possível.


Como começar

Este tópico é centro das discussões sobre a tradução em português do Brasil. Aqui é o lugar de tirar dúvidas, discutir sobre o andamento da tradução, sobre novas propostas, padrões, e sobre tudo aquilo referente à tradução.

A tradução é feita no Crowdin, uma plataforma online onde os tradutores sugerem, votam e aprovam as traduções. Você precisará criar uma conta e se juntar ao projeto. Antes de começar, leia atentamente as orientações abaixo.

Orientações

Padrões

Para que a tradução fique bem feita, há alguns padrões que devemos seguir. O primeiro deles é O guia de estilo do SpongeDocs. Apesar de ser o padrão oficial do Sponge, não podemos seguir a regra 1 já que estaria violando a norma culta da língua portuguesa, títulos não devem ser escritos dessa forma. Logo:

Títulos Escritos Assim - estão errados
Títulos escritos assim - estão certos

Portanto, a regra 1 é anulada com base na regra 8.

Há também nossos próprios padrões que vão sendo adotados ao longo do processo, mas que devem sempre ser discutidos, analisados e anotados. Esses padrões se referem ao gênero e à tradução de termos técnicos, bem como termos que não podem ser traduzidos ou que não possuem uma tradução bem definida (como "asset"). Exemplo:

The Sponge project has an API for both sides, client and server.
O projeto Sponge possui uma API para ambos os lados, cliente e servidor.

Note que API significa Application Programming Interface e traduzindo seria Interface de programação de aplicativos, portanto, o gênero é feminino. Note também que API não se tornou IPA, ou seja, é um termo que não deve ser traduzido. Portanto, para manter um padrão, foi criada uma tabela para consulta.

Tabela de gênero e tradução

Como sugerido pelo @feik no tópico antigo da tradução, termos em inglês devem ser deixados em itálico (veja o exemplo acima), o que pode ser feito com a adição de * em volta da palavra.

Prioridades

Para agilizar o andamento da tradução e manter uma base estável, alguns arquivos ganham prioridade sobre outros e sempre devem estar traduzidos. Esses arquivos são aqueles que dificilmente são alterados ao longo do tempo e que são essenciais ao usuário comum. Por exemplo, um usuário que quer saber mais sobre o Sponge irá abrir a seção "about" da documentação esta, portanto, deve estar sempre traduzida. O mesmo ocorre para aqueles que desejam abrir um servidor, que logo procuram a seção "getting started". Ambas são dificilmente modificadas e extremamente importantes aos usuários comuns, diferentemente das seções mais avançadas que se tratam de como criar plugins, contribuir com código, etc. Além disso, dentro de cada seção podemos encontrar a página inicial (index), que deve ser traduzida antes das demais.

Também não podemos esquecer das diferentes versões da documentação. Não faz sentido traduzir as versões antigas antes da mais nova. Logo, as versões antigas só devem ser traduzidas após o termino da mais atual, seguindo uma ordem decrescente de versão.

Por fim, a lista de prioridade:

  1. index.pot
  2. about
  3. server/getting-started
  4. server/management

[Outdated] Portuguese(Brazil) Docs translation / Documentação do Sponge em português brasileiro