Guia de escrita para artigos
Dados do artigo
Contents |
Introdução
Esta página tem como objetivo servir como um guia de escrita para artigos em Português. Um guia é importante para ajudar a uniformizar o conteúdo do Wiki, de modo que seja possível usá-la e atualizá-la de maneira mais eficiente.
As recomendações desta página não são verdades universais. Caso não concorde com alguma recomendação, ou tenha alguma sugestão interessante, por favor utilize a aba "comment" para colocar algum comentário.
Recomendações gerais
- Artigos que representem traduções de conteúdos em outros idiomas e que, por ventura, não possam ter seu título traduzido para português devem conter o sufixo (Português) ao final do seu título. Por exemplo, um artigo com nome Ovi, sem tradução, pode ser escrito como Ovi (Português)
- Todos os nomes de categorias criados devem ser providos em inglês. O mesmo vale para as sub-categorias utilizadas.
- Todos os artigos precisam conter a categoria Lang-Portuguese no final, para que sejam parte da Wiki em Português e não da em Inglês.
- Uma lista das categorias existentes pode ser obtida aqui. Vale a pena conferir se o que deseja já não existe ou se existe uma sugestão similar.
- Artigos traduzidos devem conter uma referência para o artigo original através de um link permanente que pode ser obtido na barra lateral, seção Ferramentas.
- Termos em Inglês: tem coisas que não tem como traduzir (DRM, Maemo, Carbide), devendo ser usados os nomes em Inglês mesmo, mas com a tag "Português" anexada. Por exemplo, se você quer falar sobre Carbide.c++, crie a página com o nome "Carbide.c++ (Português)", de outra maneira você vai acabar editando a página em Inglês e aí irá misturar as línguas. Outro exemplo é Maemo (Português). É igual à Wikipedia de verdade: quando se referem a um livro, o uso é "Atlas Shrugged" por exemplo, mas quando é sobre o filme, é "Atlas Shrugger (film)" e assim por diante.
- A menos que seu artigo seja em Inglês, não o classifique nas categorias gerais: Java, How to, etc. pois ele não aparecerá na listagem de Português, e confundirá os leitores da Wiki em Inglês. Procure uma categoria em Português no qual ele se encaixa, e classifique-o nela, além é claro de Lang-Portuguese.
- Antes de criar um tópico, é uma boa idéia verificar se já existe um similar ou igual. Caso exista, então é mais adequado atualizar o antigo, se for o caso.
Formatação
Esta seção apresenta algumas dicas para formatação dos artigos.
Termos estrangeiros
Em relação a termos estrangeiros, se existir uma versão em Português, usar essa versão. Caso não exista (ex: termos "clássicos") usar a versão original, em itálico. Usar o itálico sempre que tiver que usar uma palavra estrangeira. Na Wiki isso pode ser feito usando-se ' ' (sem espaço) antes e depois do termo: Exemplo: ''thread'' (resulta em thread). Exemplos de termos "clássicos":
software, hardware, thread, string, array, byte, pixel
Nomes próprios estrangeiros
Para nomes próprios, pode-se usar sem a formatação indicada. Exemplo:
O Nokia Developer possui muitos usuários.
A OpenGL API pode ser usada para se desenhar gráficos em 3D.
O Carbide.c++ é uma ferramenta para desenvolvimento em Symbian OS.
Se for o caso de querer introduzir uma tradução incomum, pode-se indicar usando o original:
"A classe TFixedArray é uma classe parametrizada (template) que pode ser utilizada para ... ".
Código
Para referências a termos de código (variáveis, nomes de função, nomes de classes, etc) que estejam no meio do texto, usar a tag <tt></tt> para destacar esse texto. Exemplos:
A classe <tt>TFixedArray</tt> é uma classe parametrizada (''template'')
que pode ser utilizada para se criar ''arrays'' de tamanhos fixos.Resultado: A classe TFixedArray é uma classe parametrizada (template) que pode ser utilizada para se criar arrays de tamanhos fixos.
No exemplo de código, a variável <tt>xpto</tt> da classe <tt>ABC</tt> é
usada para se guardar ...
Resultado: No exemplo de código, a variável xpto da classe ABC é usada para se guardar ...
Linguagem
Evitar termos inadequados e anglicismos principalmente. Um anglicismo é "aportuguesar" um termo em Inglês. Exemplo:
A biblioteca XYZ não suporta a função ABC.
O "suportar" como tradução do Inglês "to support" não existe em Português. Nesse exemplo, o melhor seria:
A biblioteca XYZ não possui/não oferece a função ABC.
Outras recomendações
- Não copiar texto de outros lugares (sites, livros, etc) sem ter autorização para tal. É claro que pode-se falar de um determinado assunto utilizando-se a própria interpretação.
- Para o caso de utilizar trabalhos de terceiros, citar as fontes.
- Toda contribuição feita na Wiki pode ser editada por qualquer usuário, a qualquer momento.
(no comments yet)