Sobre a escrita de um conteúdo que seja amigável à tradução
Use as diretrizes a seguir para garantir que o conteúdo criado possa ser traduzido com sucesso. Para obter mais informações, confira "Guia de estilo".
- Use exemplos genéricos e que possam ser compreendidos pela maioria das pessoas.
- Evite usar exemplos controversos ou culturalmente específicos de um grupo.
- Escreva na voz ativa.
- Escreva frases simples, curtas e fáceis de entender.
- Evite usar muitos pronomes que possam deixar o texto ambíguo.
- Evite usar gírias e piadas.
- Evite usar frases negativas.
- Use os acrônimos padrão do setor sempre que possível e explique os acrônimos personalizados.
- Use o modo indicativo.
- Elimine expressões redundantes e prolixas.
- Evite o uso excessivo de modificadores sequenciais (sequências de substantivos). O tradutor pode confundir o substantivo que está sendo modificado.
- Evite usar plurais invisíveis nos quais não está claro se o primeiro substantivo precisa ser singular ou plural.
- Evite usar a nominalização.
- Evite usar verbos auxiliares modais ambíguos.
- Evite usar palavras específicas de gênero.
- Evite usar frases preposicionais.
- Evite usar substantivos e pronomes indeterminados (sujeito de frase indeterminado).
- Mantenha o mínimo de links embutidos. Se forem necessários, coloque-os antes de uma frase como "Para obter mais informações, confira "Título do link". Como alternativa, adicione links relevantes a uma seção "Leitura adicional" no final do tópico.
Exemplos
Esta seção fornece exemplos de como seguir nossas diretrizes para escrever uma documentação amigável à tradução.
Evite usar informações específicas do país
Por exemplo, evite números 800 e endereços específicos do país. Se necessário, mencione a quais países as informações se aplicam.
Evite o uso excessivo de modificadores sequenciais (sequências de substantivos)
O excesso de modificadores sequenciais pode levar a traduções incorretas porque não é fácil determinar o que modifica o quê. Por exemplo, use "Configurações de origem padrão para o repositório público" em vez de "Configurações de origem padrão do repositório público".
Evite o uso de plurais invisíveis
Por exemplo, ao usar o termo "recuperação de arquivo", não está claro se você está recuperando um arquivo ou todos os arquivos. Forneça mais contexto para eliminar a ambiguidade. No exemplo dado, você pode usar "recuperação de todos os arquivos" ou "recuperação do arquivo source.md".
Evite usar a nominalização
Por exemplo, em vez de "chegar a uma conclusão", use "concluir".
Evite usar verbos auxiliares modais ambíguos.
Evite usar palavras como "poderá". Seja mais claro para evitar ambiguidade.
Evite usar frases preposicionais
Em vez de escrever "Depois de tentar muitas vezes" ou "De acordo com o log do repositório", escreva de modo mais direto. Por exemplo, "Depois de tentar três vezes".
Evite usar substantivos e pronomes indeterminados
Substantivos e pronomes indeterminados podem deixar incerto a quem ou ao que você está se referindo, especialmente quando esse conteúdo precisa ser traduzido. Por exemplo, "Os mantenedores e os colaboradores têm acesso a arquivos e comentários. Na pull request, eles fazem alterações neles". Nessa frase, não fica claro se as alterações estão sendo feitas no arquivo ou nos comentários. Se um pronome parecer se referir a mais de um antecedente, reformule a frase para deixar o antecedente claro ou substitua o pronome por um substantivo a fim de eliminar a ambiguidade.
Mantenha o mínimo de links embutidos.
Sempre que possível, apresente claramente os links seguindo nosso guia de estilo. Por exemplo, em vez da seguinte frase:
Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.
Você pode usar esta:
OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."