wiki:regras_e_guia_de_estilo
Tabela de Conteúdos
Conceber um bom artigo é uma actividade que pode trazer grande satisfação ao(s) autor(es). Todavia, para que um artigo possa atingir um nível elevado é necessário algum trabalho.
O objectivo desta página é criar algumas guidelines para criar artigos de qualidade para a Wiki.
Regras e guia de estilo
Pesquisar
- Procurar artigos idênticos na Wiki P@P, caso existam porque não completá-los?
- Antes de criar uma página, procurar informação na Wikipédia, w3schools, ou outro site de grande popularidade potencial de conter o mesmo tipo de conteúdo. Se o conteúdo a criar coincidir, em geral, com uma entrada dos sites referidos, então não vale a pena mantê-lo aqui.
Escrita
- O artigo deve começar com uma introdução sobre o artigo de forma a que o leitor consiga facilmente entender sobre o que o artigo trata e identificar se é o que procura ou não.
- Há que ter em atenção que não se pode simplesmente copiar o conteúdo de outras fontes. É necessário ter em atenção os direitos de autor.
- Salvo situações como artigos a publicar na revista programar, o texto deve ser sintetizado e ilustrado sempre que possível com exemplos práticos de código. Fragmentos de texto de grande dimensão não são indicados para a grande maioria das situações.
- Caso ainda não esteja familiriarizado com o sistema de formatação da DokuWiki, deve consultar o Guia de Estilo e Formatação existente.
- Código demasiado extenso pode tambem tornar-se pouco informativo. Deve ter-se o cuidado de o documentar e explicar bem.
- Não incluir conjugações de verbos na primeira pessoa do singular, nem referencias a opiniões ou experiências pessoais.
- Sempre que possível, as páginas devem ser escritas de forma a ser usadas como referência. Isto significa que se deve possibilitar ao leitor compreender cada parte de uma página sem ter que a sequencialmente e/ou na íntegra.
- O código fonte deve ser afixado em formato de texto e com a tag apropriada, com colorização de sintaxe.
- Entradas com definições de conceitos para leigos só devem ser submetidas se se tratar de um assunto que ainda careça de documentação bem difundida na web em geral.
- Links entre páginas deste wiki não devem ser usados com tanta frequência como na Wikipédia.
- Se o conteúdo a afixar for um code snippet, este deve ser criado na pasta de snippets da linguagem correspondente.
Edição
- Sempre que achar que pode completar / corrigir um artigo existente na Wiki P@P sinta-se livre de o fazer de forma a contribuir para melhorar o artigo e o seu conteúdo.
- Tenha sempre em mente as 'regras' que são aplicadas à criação de novos artigos.
wiki/regras_e_guia_de_estilo.txt · Última modificação em: 2018/05/14 21:37 (edição externa)
Ferramentas de Página
Excepto menção em contrário, o conteúdo neste wiki está sob a seguinte licença: CC Attribution-Noncommercial-Share Alike 4.0 International
