O inglês é, inegavelmente, a linguagem da tecnologia. Por isso, recomenda-se sempre utilizar essa língua em sites, artigos e documentações, a fim de que seu projeto tenha o maior alcance possível.
Eu, como desenvolvedora em formação, procuro maximizar o alcance dos meus projetos sempre que possível. Isso me trouxe um dilema: o README.md do meu GitHub deve ser em português, minha língua natal e mais acessível à pessoas do meu país, ou desde já deixar em inglês, para permitir o acesso para o mundo todo?
Para resolver esse dilema, decidi pelas duas coisas: por quê não manter uma versão em português e outra em inglês, facilmente intercambiáveis de acordo com a necessidade de quem está acessando meu repositório?
Procurei então por uma solução simples, sem envolver linguagens de programação, e cheguei a esse resultado: a criação de dois README.md, seguindo esses três passos:
- Criação dos dois README.md’s:
Como já possuía a versão em português, apenas criei uma segunda versão, traduzindo para o inglês todo o texto.
- Definição da versão principal (default):
Essa definição foi feita por simples mudança na nomeclatura: a versão de exibição prioritária (que, no meu caso, foi o português) foi deixada como “README.md”, e a segunda versão foi nomeada como “README-en.md”, indicando sua linguagem. Dessa forma, posso adicionar quantas linguagens ou versões diferentes quiser, modificando apenas sua identificação.
- Criei um link, em cada versão, que direciona a página para a outra versão:
Logo no início do texto, abaixo do título, inseri um link clicável que direciona o usuário para a página traduzida. Na página principal, em português, esse texto foi inserido em inglês, e vice-versa, para garantir que o usuário consiga entender e chegar à versão no idioma de sua preferência. Para melhor experiência do usuário, criei um link que levava diretamente ao título da versão em inglês, para tirar o foto das informações desnecessárias da página.
Dessa forma simples, otimizei o alcance do meu perfil de GitHub, sem dificultar o acesso de quem não possui bom entendimento do inglês. Isso pode ser usado não apenas para o perfil do GitHub, mas em todos os repositórios de projetos que possuam uma documentação em Markdown.
Top comments (0)